Class DataCatalogClientImpl (1.2.0) 

public sealed class DataCatalogClientImpl : DataCatalogClient

DataCatalog client wrapper implementation, for convenient use.

Inheritance

Object > DataCatalogClient > DataCatalogClientImpl

Namespace

Google.Cloud.DataCatalog.V1

Assembly

Google.Cloud.DataCatalog.V1.dll

Remarks

Data Catalog API service allows clients to discover, understand, and manage their data.

Constructors

DataCatalogClientImpl(DataCatalog.DataCatalogClient, DataCatalogSettings)

public DataCatalogClientImpl(DataCatalog.DataCatalogClient grpcClient, DataCatalogSettings settings)

Constructs a client wrapper for the DataCatalog service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient DataCatalog.DataCatalogClient

The underlying gRPC client.
settings DataCatalogSettings

The base DataCatalogSettings used within this client.

Properties

GrpcClient

public override DataCatalog.DataCatalogClient GrpcClient { get; }

The underlying gRPC DataCatalog client

Property Value
Type Description
DataCatalog.DataCatalogClient
Overrides

Methods

CreateEntry(CreateEntryRequest, CallSettings)

public override Entry CreateEntry(CreateEntryRequest request, CallSettings callSettings = null)

Creates an entry. Only entries of types 'FILESET', 'CLUSTER', 'DATA_STREAM' or with a user-specified type can be created.

Users should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

A maximum of 100,000 entries may be created per entry group.

Parameters
Name Description
request CreateEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Entry

The RPC response.
Overrides

CreateEntryAsync(CreateEntryRequest, CallSettings)

public override Task<Entry> CreateEntryAsync(CreateEntryRequest request, CallSettings callSettings = null)

Creates an entry. Only entries of types 'FILESET', 'CLUSTER', 'DATA_STREAM' or with a user-specified type can be created.

Users should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

A maximum of 100,000 entries may be created per entry group.

Parameters
Name Description
request CreateEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Entry>

A Task containing the RPC response.
Overrides

CreateEntryGroup(CreateEntryGroupRequest, CallSettings)

public override EntryGroup CreateEntryGroup(CreateEntryGroupRequest request, CallSettings callSettings = null)

Creates an EntryGroup.

An entry group contains logically related entries together with Cloud Identity and Access Management policies that specify the users who can create, edit, and view entries within the entry group.

Data Catalog automatically creates an entry group for BigQuery entries (&quot;@bigquery&quot;) and Pub/Sub topics (&quot;@pubsub&quot;). Users create their own entry group to contain Cloud Storage fileset entries or custom type entries, and the IAM policies associated with those entries. Entry groups, like entries, can be searched.

A maximum of 10,000 entry groups may be created per organization across all locations.

Users should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request CreateEntryGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
EntryGroup

The RPC response.
Overrides

CreateEntryGroupAsync(CreateEntryGroupRequest, CallSettings)

public override Task<EntryGroup> CreateEntryGroupAsync(CreateEntryGroupRequest request, CallSettings callSettings = null)

Creates an EntryGroup.

An entry group contains logically related entries together with Cloud Identity and Access Management policies that specify the users who can create, edit, and view entries within the entry group.

Data Catalog automatically creates an entry group for BigQuery entries (&quot;@bigquery&quot;) and Pub/Sub topics (&quot;@pubsub&quot;). Users create their own entry group to contain Cloud Storage fileset entries or custom type entries, and the IAM policies associated with those entries. Entry groups, like entries, can be searched.

A maximum of 10,000 entry groups may be created per organization across all locations.

Users should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request CreateEntryGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<EntryGroup>

A Task containing the RPC response.
Overrides

CreateTag(CreateTagRequest, CallSettings)

public override Tag CreateTag(CreateTagRequest request, CallSettings callSettings = null)

Creates a tag on an [Entry][google.cloud.datacatalog.v1.Entry]. Note: The project identified by the parent parameter for the tag and the tag template used to create the tag must be from the same organization.

Parameters
Name Description
request CreateTagRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Tag

The RPC response.
Overrides

CreateTagAsync(CreateTagRequest, CallSettings)

public override Task<Tag> CreateTagAsync(CreateTagRequest request, CallSettings callSettings = null)

Creates a tag on an [Entry][google.cloud.datacatalog.v1.Entry]. Note: The project identified by the parent parameter for the tag and the tag template used to create the tag must be from the same organization.

Parameters
Name Description
request CreateTagRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Tag>

A Task containing the RPC response.
Overrides

CreateTagTemplate(CreateTagTemplateRequest, CallSettings)

public override TagTemplate CreateTagTemplate(CreateTagTemplateRequest request, CallSettings callSettings = null)

Creates a tag template. The user should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request CreateTagTemplateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TagTemplate

The RPC response.
Overrides

CreateTagTemplateAsync(CreateTagTemplateRequest, CallSettings)

public override Task<TagTemplate> CreateTagTemplateAsync(CreateTagTemplateRequest request, CallSettings callSettings = null)

Creates a tag template. The user should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request CreateTagTemplateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<TagTemplate>

A Task containing the RPC response.
Overrides

CreateTagTemplateField(CreateTagTemplateFieldRequest, CallSettings)

public override TagTemplateField CreateTagTemplateField(CreateTagTemplateFieldRequest request, CallSettings callSettings = null)

Creates a field in a tag template. The user should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request CreateTagTemplateFieldRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TagTemplateField

The RPC response.
Overrides

CreateTagTemplateFieldAsync(CreateTagTemplateFieldRequest, CallSettings)

public override Task<TagTemplateField> CreateTagTemplateFieldAsync(CreateTagTemplateFieldRequest request, CallSettings callSettings = null)

Creates a field in a tag template. The user should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request CreateTagTemplateFieldRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<TagTemplateField>

A Task containing the RPC response.
Overrides

DeleteEntry(DeleteEntryRequest, CallSettings)

public override void DeleteEntry(DeleteEntryRequest request, CallSettings callSettings = null)

Deletes an existing entry. Only entries created through [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method can be deleted. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request DeleteEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteEntryAsync(DeleteEntryRequest, CallSettings)

public override Task DeleteEntryAsync(DeleteEntryRequest request, CallSettings callSettings = null)

Deletes an existing entry. Only entries created through [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method can be deleted. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request DeleteEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteEntryGroup(DeleteEntryGroupRequest, CallSettings)

public override void DeleteEntryGroup(DeleteEntryGroupRequest request, CallSettings callSettings = null)

Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request DeleteEntryGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteEntryGroupAsync(DeleteEntryGroupRequest, CallSettings)

public override Task DeleteEntryGroupAsync(DeleteEntryGroupRequest request, CallSettings callSettings = null)

Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request DeleteEntryGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteTag(DeleteTagRequest, CallSettings)

public override void DeleteTag(DeleteTagRequest request, CallSettings callSettings = null)

Deletes a tag.

Parameters
Name Description
request DeleteTagRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteTagAsync(DeleteTagRequest, CallSettings)

public override Task DeleteTagAsync(DeleteTagRequest request, CallSettings callSettings = null)

Deletes a tag.

Parameters
Name Description
request DeleteTagRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteTagTemplate(DeleteTagTemplateRequest, CallSettings)

public override void DeleteTagTemplate(DeleteTagTemplateRequest request, CallSettings callSettings = null)

Deletes a tag template and all tags using the template. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request DeleteTagTemplateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteTagTemplateAsync(DeleteTagTemplateRequest, CallSettings)

public override Task DeleteTagTemplateAsync(DeleteTagTemplateRequest request, CallSettings callSettings = null)

Deletes a tag template and all tags using the template. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request DeleteTagTemplateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteTagTemplateField(DeleteTagTemplateFieldRequest, CallSettings)

public override void DeleteTagTemplateField(DeleteTagTemplateFieldRequest request, CallSettings callSettings = null)

Deletes a field in a tag template and all uses of that field. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request DeleteTagTemplateFieldRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteTagTemplateFieldAsync(DeleteTagTemplateFieldRequest, CallSettings)

public override Task DeleteTagTemplateFieldAsync(DeleteTagTemplateFieldRequest request, CallSettings callSettings = null)

Deletes a field in a tag template and all uses of that field. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request DeleteTagTemplateFieldRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

GetEntry(GetEntryRequest, CallSettings)

public override Entry GetEntry(GetEntryRequest request, CallSettings callSettings = null)

Gets an entry.

Parameters
Name Description
request GetEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Entry

The RPC response.
Overrides

GetEntryAsync(GetEntryRequest, CallSettings)

public override Task<Entry> GetEntryAsync(GetEntryRequest request, CallSettings callSettings = null)

Gets an entry.

Parameters
Name Description
request GetEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Entry>

A Task containing the RPC response.
Overrides

GetEntryGroup(GetEntryGroupRequest, CallSettings)

public override EntryGroup GetEntryGroup(GetEntryGroupRequest request, CallSettings callSettings = null)

Gets an EntryGroup.

Parameters
Name Description
request GetEntryGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
EntryGroup

The RPC response.
Overrides

GetEntryGroupAsync(GetEntryGroupRequest, CallSettings)

public override Task<EntryGroup> GetEntryGroupAsync(GetEntryGroupRequest request, CallSettings callSettings = null)

Gets an EntryGroup.

Parameters
Name Description
request GetEntryGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<EntryGroup>

A Task containing the RPC response.
Overrides

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the access control policy for a resource. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.

Supported resources are:

  • Tag templates.
  • Entries.
  • Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog.

Callers must have following Google IAM permission

  • datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.
  • datacatalog.entries.getIamPolicy to get policies on entries.
  • datacatalog.entryGroups.getIamPolicy to get policies on entry groups.
Parameters
Name Description
request Google.Cloud.Iam.V1.GetIamPolicyRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Google.Cloud.Iam.V1.Policy

The RPC response.
Overrides

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the access control policy for a resource. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.

Supported resources are:

  • Tag templates.
  • Entries.
  • Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog.

Callers must have following Google IAM permission

  • datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.
  • datacatalog.entries.getIamPolicy to get policies on entries.
  • datacatalog.entryGroups.getIamPolicy to get policies on entry groups.
Parameters
Name Description
request Google.Cloud.Iam.V1.GetIamPolicyRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Google.Cloud.Iam.V1.Policy>

A Task containing the RPC response.
Overrides

GetTagTemplate(GetTagTemplateRequest, CallSettings)

public override TagTemplate GetTagTemplate(GetTagTemplateRequest request, CallSettings callSettings = null)

Gets a tag template.

Parameters
Name Description
request GetTagTemplateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TagTemplate

The RPC response.
Overrides

GetTagTemplateAsync(GetTagTemplateRequest, CallSettings)

public override Task<TagTemplate> GetTagTemplateAsync(GetTagTemplateRequest request, CallSettings callSettings = null)

Gets a tag template.

Parameters
Name Description
request GetTagTemplateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<TagTemplate>

A Task containing the RPC response.
Overrides

ListEntries(ListEntriesRequest, CallSettings)

public override PagedEnumerable<ListEntriesResponse, Entry> ListEntries(ListEntriesRequest request, CallSettings callSettings = null)

Lists entries.

Parameters
Name Description
request ListEntriesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListEntriesResponse, Entry>

A pageable sequence of Entry resources.
Overrides

ListEntriesAsync(ListEntriesRequest, CallSettings)

public override PagedAsyncEnumerable<ListEntriesResponse, Entry> ListEntriesAsync(ListEntriesRequest request, CallSettings callSettings = null)

Lists entries.

Parameters
Name Description
request ListEntriesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListEntriesResponse, Entry>

A pageable asynchronous sequence of Entry resources.
Overrides

ListEntryGroups(ListEntryGroupsRequest, CallSettings)

public override PagedEnumerable<ListEntryGroupsResponse, EntryGroup> ListEntryGroups(ListEntryGroupsRequest request, CallSettings callSettings = null)

Lists entry groups.

Parameters
Name Description
request ListEntryGroupsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListEntryGroupsResponse, EntryGroup>

A pageable sequence of EntryGroup resources.
Overrides

ListEntryGroupsAsync(ListEntryGroupsRequest, CallSettings)

public override PagedAsyncEnumerable<ListEntryGroupsResponse, EntryGroup> ListEntryGroupsAsync(ListEntryGroupsRequest request, CallSettings callSettings = null)

Lists entry groups.

Parameters
Name Description
request ListEntryGroupsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListEntryGroupsResponse, EntryGroup>

A pageable asynchronous sequence of EntryGroup resources.
Overrides

ListTags(ListTagsRequest, CallSettings)

public override PagedEnumerable<ListTagsResponse, Tag> ListTags(ListTagsRequest request, CallSettings callSettings = null)

Lists the tags on an [Entry][google.cloud.datacatalog.v1.Entry].

Parameters
Name Description
request ListTagsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<ListTagsResponse, Tag>

A pageable sequence of Tag resources.
Overrides

ListTagsAsync(ListTagsRequest, CallSettings)

public override PagedAsyncEnumerable<ListTagsResponse, Tag> ListTagsAsync(ListTagsRequest request, CallSettings callSettings = null)

Lists the tags on an [Entry][google.cloud.datacatalog.v1.Entry].

Parameters
Name Description
request ListTagsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<ListTagsResponse, Tag>

A pageable asynchronous sequence of Tag resources.
Overrides

LookupEntry(LookupEntryRequest, CallSettings)

public override Entry LookupEntry(LookupEntryRequest request, CallSettings callSettings = null)

Get an entry by target resource name. This method allows clients to use the resource name from the source Google Cloud Platform service to get the Data Catalog Entry.

Parameters
Name Description
request LookupEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Entry

The RPC response.
Overrides

LookupEntryAsync(LookupEntryRequest, CallSettings)

public override Task<Entry> LookupEntryAsync(LookupEntryRequest request, CallSettings callSettings = null)

Get an entry by target resource name. This method allows clients to use the resource name from the source Google Cloud Platform service to get the Data Catalog Entry.

Parameters
Name Description
request LookupEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Entry>

A Task containing the RPC response.
Overrides

RenameTagTemplateField(RenameTagTemplateFieldRequest, CallSettings)

public override TagTemplateField RenameTagTemplateField(RenameTagTemplateFieldRequest request, CallSettings callSettings = null)

Renames a field in a tag template. The user should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request RenameTagTemplateFieldRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TagTemplateField

The RPC response.
Overrides

RenameTagTemplateFieldAsync(RenameTagTemplateFieldRequest, CallSettings)

public override Task<TagTemplateField> RenameTagTemplateFieldAsync(RenameTagTemplateFieldRequest request, CallSettings callSettings = null)

Renames a field in a tag template. The user should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request RenameTagTemplateFieldRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<TagTemplateField>

A Task containing the RPC response.
Overrides

RenameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest, CallSettings)

public override TagTemplateField RenameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest request, CallSettings callSettings = null)

Renames an enum value in a tag template. The enum values have to be unique within one enum field.

Parameters
Name Description
request RenameTagTemplateFieldEnumValueRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TagTemplateField

The RPC response.
Overrides

RenameTagTemplateFieldEnumValueAsync(RenameTagTemplateFieldEnumValueRequest, CallSettings)

public override Task<TagTemplateField> RenameTagTemplateFieldEnumValueAsync(RenameTagTemplateFieldEnumValueRequest request, CallSettings callSettings = null)

Renames an enum value in a tag template. The enum values have to be unique within one enum field.

Parameters
Name Description
request RenameTagTemplateFieldEnumValueRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<TagTemplateField>

A Task containing the RPC response.
Overrides

SearchCatalog(SearchCatalogRequest, CallSettings)

public override PagedEnumerable<SearchCatalogResponse, SearchCatalogResult> SearchCatalog(SearchCatalogRequest request, CallSettings callSettings = null)

Searches Data Catalog for multiple resources like entries, tags that match a query.

This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not return the complete resource, only the resource identifier and high level fields. Clients can subsequently call Get methods.

Note that Data Catalog search queries do not guarantee full recall. Query results that match your query may not be returned, even in subsequent result pages. Also note that results returned (and not returned) can vary across repeated search queries.

See Data Catalog Search Syntax for more information.

Parameters
Name Description
request SearchCatalogRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerable<SearchCatalogResponse, SearchCatalogResult>

A pageable sequence of SearchCatalogResult resources.
Overrides

SearchCatalogAsync(SearchCatalogRequest, CallSettings)

public override PagedAsyncEnumerable<SearchCatalogResponse, SearchCatalogResult> SearchCatalogAsync(SearchCatalogRequest request, CallSettings callSettings = null)

Searches Data Catalog for multiple resources like entries, tags that match a query.

This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not return the complete resource, only the resource identifier and high level fields. Clients can subsequently call Get methods.

Note that Data Catalog search queries do not guarantee full recall. Query results that match your query may not be returned, even in subsequent result pages. Also note that results returned (and not returned) can vary across repeated search queries.

See Data Catalog Search Syntax for more information.

Parameters
Name Description
request SearchCatalogRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerable<SearchCatalogResponse, SearchCatalogResult>

A pageable asynchronous sequence of SearchCatalogResult resources.
Overrides

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the access control policy for a resource. Replaces any existing policy. Supported resources are:

  • Tag templates.
  • Entries.
  • Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog.

Callers must have following Google IAM permission

  • datacatalog.tagTemplates.setIamPolicy to set policies on tag templates.
  • datacatalog.entries.setIamPolicy to set policies on entries.
  • datacatalog.entryGroups.setIamPolicy to set policies on entry groups.
Parameters
Name Description
request Google.Cloud.Iam.V1.SetIamPolicyRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Google.Cloud.Iam.V1.Policy

The RPC response.
Overrides

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the access control policy for a resource. Replaces any existing policy. Supported resources are:

  • Tag templates.
  • Entries.
  • Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog.

Callers must have following Google IAM permission

  • datacatalog.tagTemplates.setIamPolicy to set policies on tag templates.
  • datacatalog.entries.setIamPolicy to set policies on entries.
  • datacatalog.entryGroups.setIamPolicy to set policies on entry groups.
Parameters
Name Description
request Google.Cloud.Iam.V1.SetIamPolicyRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Google.Cloud.Iam.V1.Policy>

A Task containing the RPC response.
Overrides

TestIamPermissions(TestIamPermissionsRequest, CallSettings)

public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)

Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a NOT_FOUND error).

Supported resources are:

  • Tag templates.
  • Entries.
  • Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog.

A caller is not required to have Google IAM permission to make this request.

Parameters
Name Description
request Google.Cloud.Iam.V1.TestIamPermissionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Google.Cloud.Iam.V1.TestIamPermissionsResponse

The RPC response.
Overrides

TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)

Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (We don't return a NOT_FOUND error).

Supported resources are:

  • Tag templates.
  • Entries.
  • Entry groups. Note, this method cannot be used to manage policies for BigQuery, Pub/Sub and any external Google Cloud Platform resources synced to Data Catalog.

A caller is not required to have Google IAM permission to make this request.

Parameters
Name Description
request Google.Cloud.Iam.V1.TestIamPermissionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Google.Cloud.Iam.V1.TestIamPermissionsResponse>

A Task containing the RPC response.
Overrides

UpdateEntry(UpdateEntryRequest, CallSettings)

public override Entry UpdateEntry(UpdateEntryRequest request, CallSettings callSettings = null)

Updates an existing entry. Users should enable the Data Catalog API in the project identified by the entry.name parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request UpdateEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Entry

The RPC response.
Overrides

UpdateEntryAsync(UpdateEntryRequest, CallSettings)

public override Task<Entry> UpdateEntryAsync(UpdateEntryRequest request, CallSettings callSettings = null)

Updates an existing entry. Users should enable the Data Catalog API in the project identified by the entry.name parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request UpdateEntryRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Entry>

A Task containing the RPC response.
Overrides

UpdateEntryGroup(UpdateEntryGroupRequest, CallSettings)

public override EntryGroup UpdateEntryGroup(UpdateEntryGroupRequest request, CallSettings callSettings = null)

Updates an EntryGroup. The user should enable the Data Catalog API in the project identified by the entry_group.name parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request UpdateEntryGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
EntryGroup

The RPC response.
Overrides

UpdateEntryGroupAsync(UpdateEntryGroupRequest, CallSettings)

public override Task<EntryGroup> UpdateEntryGroupAsync(UpdateEntryGroupRequest request, CallSettings callSettings = null)

Updates an EntryGroup. The user should enable the Data Catalog API in the project identified by the entry_group.name parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request UpdateEntryGroupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<EntryGroup>

A Task containing the RPC response.
Overrides

UpdateTag(UpdateTagRequest, CallSettings)

public override Tag UpdateTag(UpdateTagRequest request, CallSettings callSettings = null)

Updates an existing tag.

Parameters
Name Description
request UpdateTagRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Tag

The RPC response.
Overrides

UpdateTagAsync(UpdateTagRequest, CallSettings)

public override Task<Tag> UpdateTagAsync(UpdateTagRequest request, CallSettings callSettings = null)

Updates an existing tag.

Parameters
Name Description
request UpdateTagRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<Tag>

A Task containing the RPC response.
Overrides

UpdateTagTemplate(UpdateTagTemplateRequest, CallSettings)

public override TagTemplate UpdateTagTemplate(UpdateTagTemplateRequest request, CallSettings callSettings = null)

Updates a tag template. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods. Users should enable the Data Catalog API in the project identified by the tag_template.name parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request UpdateTagTemplateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TagTemplate

The RPC response.
Overrides

UpdateTagTemplateAsync(UpdateTagTemplateRequest, CallSettings)

public override Task<TagTemplate> UpdateTagTemplateAsync(UpdateTagTemplateRequest request, CallSettings callSettings = null)

Updates a tag template. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods. Users should enable the Data Catalog API in the project identified by the tag_template.name parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request UpdateTagTemplateRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<TagTemplate>

A Task containing the RPC response.
Overrides

UpdateTagTemplateField(UpdateTagTemplateFieldRequest, CallSettings)

public override TagTemplateField UpdateTagTemplateField(UpdateTagTemplateFieldRequest request, CallSettings callSettings = null)

Updates a field in a tag template. This method cannot be used to update the field type. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request UpdateTagTemplateFieldRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TagTemplateField

The RPC response.
Overrides

UpdateTagTemplateFieldAsync(UpdateTagTemplateFieldRequest, CallSettings)

public override Task<TagTemplateField> UpdateTagTemplateFieldAsync(UpdateTagTemplateFieldRequest request, CallSettings callSettings = null)

Updates a field in a tag template. This method cannot be used to update the field type. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
Name Description
request UpdateTagTemplateFieldRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task<TagTemplateField>

A Task containing the RPC response.
Overrides