Data Catalog v1 API - Class DataCatalog.DataCatalogClient (2.3.0)

public class DataCatalog.DataCatalogClient : ClientBase<DataCatalog.DataCatalogClient>

Reference documentation and code samples for the Data Catalog v1 API class DataCatalog.DataCatalogClient.

Client for DataCatalog

Inheritance

object > ClientBase > ClientBase DataCatalog DataCatalogClient > DataCatalog.DataCatalogClient

Inherited Members

ClientBase<DataCatalog.DataCatalogClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google CloudGoogle.Cloud.DataCatalogV1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

DataCatalogClient()

protected DataCatalogClient()

Protected parameterless constructor to allow creation of test doubles.

DataCatalogClient(CallInvoker)

public DataCatalogClient(CallInvoker callInvoker)

Creates a new client for DataCatalog that uses a custom CallInvoker.

Parameter
Name	Description
`callInvoker`	`CallInvoker` The callInvoker to use to make remote calls.

DataCatalogClient(ChannelBase)

public DataCatalogClient(ChannelBase channel)

Creates a new client for DataCatalog

Parameter
Name	Description
`channel`	`ChannelBase` The channel to use to make remote calls.

DataCatalogClient(ClientBaseConfiguration)

protected DataCatalogClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration` The client configuration.

Methods

CreateEntry(CreateEntryRequest, CallOptions)

public virtual Entry CreateEntry(CreateEntryRequest request, CallOptions options)

Creates an entry.

You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

An entry group can have a maximum of 100,000 entries.

Parameters
Name	Description
`request`	`CreateEntryRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Entry`	The response received from the server.

CreateEntry(CreateEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual Entry CreateEntry(CreateEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an entry.

You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

An entry group can have a maximum of 100,000 entries.

Parameters
Name	Description
`request`	`CreateEntryRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Entry`	The response received from the server.

CreateEntryAsync(CreateEntryRequest, CallOptions)

public virtual AsyncUnaryCall<Entry> CreateEntryAsync(CreateEntryRequest request, CallOptions options)

Creates an entry.

You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

An entry group can have a maximum of 100,000 entries.

Parameters
Name	Description
`request`	`CreateEntryRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallEntry`	The call object.

CreateEntryAsync(CreateEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Entry> CreateEntryAsync(CreateEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an entry.

You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

An entry group can have a maximum of 100,000 entries.

Parameters
Name	Description
`request`	`CreateEntryRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallEntry`	The call object.

CreateEntryGroup(CreateEntryGroupRequest, CallOptions)

public virtual EntryGroup CreateEntryGroup(CreateEntryGroupRequest request, CallOptions options)

Creates an entry group.

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

Data Catalog automatically creates entry groups with names that start with the @ symbol for the following resources:

BigQuery entries (@bigquery)
Pub/Sub topics (@pubsub)
Dataproc Metastore services (@dataproc_metastore_{SERVICE_NAME_HASH})

You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the @ symbol, it is reserved for automatically created groups.

Entry groups, like entries, can be searched.

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

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`CreateEntryGroupRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`EntryGroup`	The response received from the server.

CreateEntryGroup(CreateEntryGroupRequest, Metadata, DateTime?, CancellationToken)

public virtual EntryGroup CreateEntryGroup(CreateEntryGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an entry group.

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

Data Catalog automatically creates entry groups with names that start with the @ symbol for the following resources:

BigQuery entries (@bigquery)
Pub/Sub topics (@pubsub)
Dataproc Metastore services (@dataproc_metastore_{SERVICE_NAME_HASH})

Entry groups, like entries, can be searched.

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

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`CreateEntryGroupRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`EntryGroup`	The response received from the server.

CreateEntryGroupAsync(CreateEntryGroupRequest, CallOptions)

public virtual AsyncUnaryCall<EntryGroup> CreateEntryGroupAsync(CreateEntryGroupRequest request, CallOptions options)

Creates an entry group.

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

Data Catalog automatically creates entry groups with names that start with the @ symbol for the following resources:

BigQuery entries (@bigquery)
Pub/Sub topics (@pubsub)
Dataproc Metastore services (@dataproc_metastore_{SERVICE_NAME_HASH})

Entry groups, like entries, can be searched.

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

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`CreateEntryGroupRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallEntryGroup`	The call object.

CreateEntryGroupAsync(CreateEntryGroupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EntryGroup> CreateEntryGroupAsync(CreateEntryGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an entry group.

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

Data Catalog automatically creates entry groups with names that start with the @ symbol for the following resources:

BigQuery entries (@bigquery)
Pub/Sub topics (@pubsub)
Dataproc Metastore services (@dataproc_metastore_{SERVICE_NAME_HASH})

Entry groups, like entries, can be searched.

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

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`CreateEntryGroupRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallEntryGroup`	The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type	Description
`IAMPolicyIAMPolicyClient`	A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
`OperationsOperationsClient`	A new Operations client for the same target as this client.

CreateTag(CreateTagRequest, CallOptions)

public virtual Tag CreateTag(CreateTagRequest request, CallOptions options)

Creates a tag and assigns it to:

An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is projects.locations.entryGroups.entries.tags.create.
Or [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]if the method name is projects.locations.entryGroups.tags.create.

Note: The project identified by the parent parameter for the tag and the tag template used to create the tag must be in the same organization.

Parameters
Name	Description
`request`	`CreateTagRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Tag`	The response received from the server.

CreateTag(CreateTagRequest, Metadata, DateTime?, CancellationToken)

public virtual Tag CreateTag(CreateTagRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a tag and assigns it to:

An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is projects.locations.entryGroups.entries.tags.create.
Or [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]if the method name is projects.locations.entryGroups.tags.create.

Note: The project identified by the parent parameter for the tag and the tag template used to create the tag must be in the same organization.

Parameters
Name	Description
`request`	`CreateTagRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Tag`	The response received from the server.

CreateTagAsync(CreateTagRequest, CallOptions)

public virtual AsyncUnaryCall<Tag> CreateTagAsync(CreateTagRequest request, CallOptions options)

Creates a tag and assigns it to:

An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is projects.locations.entryGroups.entries.tags.create.
Or [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]if the method name is projects.locations.entryGroups.tags.create.

Note: The project identified by the parent parameter for the tag and the tag template used to create the tag must be in the same organization.

Parameters
Name	Description
`request`	`CreateTagRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallTag`	The call object.

CreateTagAsync(CreateTagRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Tag> CreateTagAsync(CreateTagRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a tag and assigns it to:

An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is projects.locations.entryGroups.entries.tags.create.
Or [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]if the method name is projects.locations.entryGroups.tags.create.

Note: The project identified by the parent parameter for the tag and the tag template used to create the tag must be in the same organization.

Parameters
Name	Description
`request`	`CreateTagRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallTag`	The call object.

CreateTagTemplate(CreateTagTemplateRequest, CallOptions)

public virtual TagTemplate CreateTagTemplate(CreateTagTemplateRequest request, CallOptions options)

Creates a tag template.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`CreateTagTemplateRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`TagTemplate`	The response received from the server.

CreateTagTemplate(CreateTagTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual TagTemplate CreateTagTemplate(CreateTagTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a tag template.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`CreateTagTemplateRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`TagTemplate`	The response received from the server.

CreateTagTemplateAsync(CreateTagTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<TagTemplate> CreateTagTemplateAsync(CreateTagTemplateRequest request, CallOptions options)

Creates a tag template.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`CreateTagTemplateRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallTagTemplate`	The call object.

CreateTagTemplateAsync(CreateTagTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TagTemplate> CreateTagTemplateAsync(CreateTagTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a tag template.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`CreateTagTemplateRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallTagTemplate`	The call object.

CreateTagTemplateField(CreateTagTemplateFieldRequest, CallOptions)

public virtual TagTemplateField CreateTagTemplateField(CreateTagTemplateFieldRequest request, CallOptions options)

Creates a field in a tag template.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`CreateTagTemplateFieldRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`TagTemplateField`	The response received from the server.

CreateTagTemplateField(CreateTagTemplateFieldRequest, Metadata, DateTime?, CancellationToken)

public virtual TagTemplateField CreateTagTemplateField(CreateTagTemplateFieldRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a field in a tag template.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`CreateTagTemplateFieldRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`TagTemplateField`	The response received from the server.

CreateTagTemplateFieldAsync(CreateTagTemplateFieldRequest, CallOptions)

public virtual AsyncUnaryCall<TagTemplateField> CreateTagTemplateFieldAsync(CreateTagTemplateFieldRequest request, CallOptions options)

Creates a field in a tag template.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`CreateTagTemplateFieldRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallTagTemplateField`	The call object.

CreateTagTemplateFieldAsync(CreateTagTemplateFieldRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TagTemplateField> CreateTagTemplateFieldAsync(CreateTagTemplateFieldRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a field in a tag template.

You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`CreateTagTemplateFieldRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallTagTemplateField`	The call object.

DeleteEntry(DeleteEntryRequest, CallOptions)

public virtual Empty DeleteEntry(DeleteEntryRequest request, CallOptions options)

Deletes an existing entry.

You can delete only the entries created by the [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`DeleteEntryRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteEntry(DeleteEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteEntry(DeleteEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an existing entry.

You can delete only the entries created by the [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`DeleteEntryRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteEntryAsync(DeleteEntryRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteEntryAsync(DeleteEntryRequest request, CallOptions options)

Deletes an existing entry.

You can delete only the entries created by the [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`DeleteEntryRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallEmpty`	The call object.

DeleteEntryAsync(DeleteEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteEntryAsync(DeleteEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an existing entry.

You can delete only the entries created by the [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`DeleteEntryRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallEmpty`	The call object.

DeleteEntryGroup(DeleteEntryGroupRequest, CallOptions)

public virtual Empty DeleteEntryGroup(DeleteEntryGroupRequest request, CallOptions options)

Deletes an entry group.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`DeleteEntryGroupRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteEntryGroup(DeleteEntryGroupRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteEntryGroup(DeleteEntryGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an entry group.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`DeleteEntryGroupRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteEntryGroupAsync(DeleteEntryGroupRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteEntryGroupAsync(DeleteEntryGroupRequest request, CallOptions options)

Deletes an entry group.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`DeleteEntryGroupRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallEmpty`	The call object.

DeleteEntryGroupAsync(DeleteEntryGroupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteEntryGroupAsync(DeleteEntryGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an entry group.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`DeleteEntryGroupRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallEmpty`	The call object.

DeleteTag(DeleteTagRequest, CallOptions)

public virtual Empty DeleteTag(DeleteTagRequest request, CallOptions options)

Deletes a tag.

Parameters
Name	Description
`request`	`DeleteTagRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteTag(DeleteTagRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteTag(DeleteTagRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a tag.

Parameters
Name	Description
`request`	`DeleteTagRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteTagAsync(DeleteTagRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteTagAsync(DeleteTagRequest request, CallOptions options)

Deletes a tag.

Parameters
Name	Description
`request`	`DeleteTagRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallEmpty`	The call object.

DeleteTagAsync(DeleteTagRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteTagAsync(DeleteTagRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a tag.

Parameters
Name	Description
`request`	`DeleteTagRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallEmpty`	The call object.

DeleteTagTemplate(DeleteTagTemplateRequest, CallOptions)

public virtual Empty DeleteTagTemplate(DeleteTagTemplateRequest request, CallOptions options)

Deletes a tag template and all tags that use it.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`DeleteTagTemplateRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteTagTemplate(DeleteTagTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteTagTemplate(DeleteTagTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a tag template and all tags that use it.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`DeleteTagTemplateRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteTagTemplateAsync(DeleteTagTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteTagTemplateAsync(DeleteTagTemplateRequest request, CallOptions options)

Deletes a tag template and all tags that use it.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`DeleteTagTemplateRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallEmpty`	The call object.

DeleteTagTemplateAsync(DeleteTagTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteTagTemplateAsync(DeleteTagTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a tag template and all tags that use it.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`DeleteTagTemplateRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallEmpty`	The call object.

DeleteTagTemplateField(DeleteTagTemplateFieldRequest, CallOptions)

public virtual Empty DeleteTagTemplateField(DeleteTagTemplateFieldRequest request, CallOptions options)

Deletes a field in a tag template and all uses of this field from the tags based on this template.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`DeleteTagTemplateFieldRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteTagTemplateField(DeleteTagTemplateFieldRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteTagTemplateField(DeleteTagTemplateFieldRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a field in a tag template and all uses of this field from the tags based on this template.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`DeleteTagTemplateFieldRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteTagTemplateFieldAsync(DeleteTagTemplateFieldRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteTagTemplateFieldAsync(DeleteTagTemplateFieldRequest request, CallOptions options)

Deletes a field in a tag template and all uses of this field from the tags based on this template.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`DeleteTagTemplateFieldRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallEmpty`	The call object.

DeleteTagTemplateFieldAsync(DeleteTagTemplateFieldRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteTagTemplateFieldAsync(DeleteTagTemplateFieldRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a field in a tag template and all uses of this field from the tags based on this template.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`DeleteTagTemplateFieldRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallEmpty`	The call object.

GetEntry(GetEntryRequest, CallOptions)

public virtual Entry GetEntry(GetEntryRequest request, CallOptions options)

Gets an entry.

Parameters
Name	Description
`request`	`GetEntryRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Entry`	The response received from the server.

GetEntry(GetEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual Entry GetEntry(GetEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an entry.

Parameters
Name	Description
`request`	`GetEntryRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Entry`	The response received from the server.

GetEntryAsync(GetEntryRequest, CallOptions)

public virtual AsyncUnaryCall<Entry> GetEntryAsync(GetEntryRequest request, CallOptions options)

Gets an entry.

Parameters
Name	Description
`request`	`GetEntryRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallEntry`	The call object.

GetEntryAsync(GetEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Entry> GetEntryAsync(GetEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an entry.

Parameters
Name	Description
`request`	`GetEntryRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallEntry`	The call object.

GetEntryGroup(GetEntryGroupRequest, CallOptions)

public virtual EntryGroup GetEntryGroup(GetEntryGroupRequest request, CallOptions options)

Gets an entry group.

Parameters
Name	Description
`request`	`GetEntryGroupRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`EntryGroup`	The response received from the server.

GetEntryGroup(GetEntryGroupRequest, Metadata, DateTime?, CancellationToken)

public virtual EntryGroup GetEntryGroup(GetEntryGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an entry group.

Parameters
Name	Description
`request`	`GetEntryGroupRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`EntryGroup`	The response received from the server.

GetEntryGroupAsync(GetEntryGroupRequest, CallOptions)

public virtual AsyncUnaryCall<EntryGroup> GetEntryGroupAsync(GetEntryGroupRequest request, CallOptions options)

Gets an entry group.

Parameters
Name	Description
`request`	`GetEntryGroupRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallEntryGroup`	The call object.

GetEntryGroupAsync(GetEntryGroupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EntryGroup> GetEntryGroupAsync(GetEntryGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an entry group.

Parameters
Name	Description
`request`	`GetEntryGroupRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallEntryGroup`	The call object.

GetIamPolicy(GetIamPolicyRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallOptions options)

Gets the access control policy for a resource.

May return:

ANOT_FOUND error if the resource doesn't exist or you don't have the permission to view it.
An empty policy if the resource exists but doesn't have a set policy.

Supported resources are:

Tag templates
Entry groups

Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog.

To call this method, you must have the following Google IAM permissions:

datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.
datacatalog.entryGroups.getIamPolicy to get policies on entry groups.

Parameters
Name	Description
`request`	`GetIamPolicyRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Policy`	The response received from the server.

GetIamPolicy(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the access control policy for a resource.

May return:

ANOT_FOUND error if the resource doesn't exist or you don't have the permission to view it.
An empty policy if the resource exists but doesn't have a set policy.

Supported resources are:

Tag templates
Entry groups

Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog.

To call this method, you must have the following Google IAM permissions:

datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.
datacatalog.entryGroups.getIamPolicy to get policies on entry groups.

Parameters
Name	Description
`request`	`GetIamPolicyRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Policy`	The response received from the server.

GetIamPolicyAsync(GetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallOptions options)

Gets the access control policy for a resource.

May return:

ANOT_FOUND error if the resource doesn't exist or you don't have the permission to view it.
An empty policy if the resource exists but doesn't have a set policy.

Supported resources are:

Tag templates
Entry groups

Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog.

To call this method, you must have the following Google IAM permissions:

datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.
datacatalog.entryGroups.getIamPolicy to get policies on entry groups.

Parameters
Name	Description
`request`	`GetIamPolicyRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallPolicy`	The call object.

GetIamPolicyAsync(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the access control policy for a resource.

May return:

ANOT_FOUND error if the resource doesn't exist or you don't have the permission to view it.
An empty policy if the resource exists but doesn't have a set policy.

Supported resources are:

Tag templates
Entry groups

Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog.

To call this method, you must have the following Google IAM permissions:

datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.
datacatalog.entryGroups.getIamPolicy to get policies on entry groups.

Parameters
Name	Description
`request`	`GetIamPolicyRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallPolicy`	The call object.

GetTagTemplate(GetTagTemplateRequest, CallOptions)

public virtual TagTemplate GetTagTemplate(GetTagTemplateRequest request, CallOptions options)

Gets a tag template.

Parameters
Name	Description
`request`	`GetTagTemplateRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`TagTemplate`	The response received from the server.

GetTagTemplate(GetTagTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual TagTemplate GetTagTemplate(GetTagTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a tag template.

Parameters
Name	Description
`request`	`GetTagTemplateRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`TagTemplate`	The response received from the server.

GetTagTemplateAsync(GetTagTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<TagTemplate> GetTagTemplateAsync(GetTagTemplateRequest request, CallOptions options)

Gets a tag template.

Parameters
Name	Description
`request`	`GetTagTemplateRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallTagTemplate`	The call object.

GetTagTemplateAsync(GetTagTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TagTemplate> GetTagTemplateAsync(GetTagTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a tag template.

Parameters
Name	Description
`request`	`GetTagTemplateRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallTagTemplate`	The call object.

ImportEntries(ImportEntriesRequest, CallOptions)

public virtual Operation ImportEntries(ImportEntriesRequest request, CallOptions options)

Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into Data Catalog. Import of entries is a sync operation that reconciles the state of the third-party system with the Data Catalog.

ImportEntries accepts source data snapshots of a third-party system. Snapshot should be delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer messages of [DumpItem][google.cloud.datacatalog.v1.DumpItem] type.

ImportEntries returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] to return [ImportEntriesMetadata][google.cloud.datacatalog.v1.ImportEntriesMetadata] and an [ImportEntriesResponse][google.cloud.datacatalog.v1.ImportEntriesResponse] message.

Parameters
Name	Description
`request`	`ImportEntriesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

ImportEntries(ImportEntriesRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ImportEntries(ImportEntriesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters
Name	Description
`request`	`ImportEntriesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

ImportEntriesAsync(ImportEntriesRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportEntriesAsync(ImportEntriesRequest request, CallOptions options)

Parameters
Name	Description
`request`	`ImportEntriesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

ImportEntriesAsync(ImportEntriesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ImportEntriesAsync(ImportEntriesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters
Name	Description
`request`	`ImportEntriesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

ListEntries(ListEntriesRequest, CallOptions)

public virtual ListEntriesResponse ListEntries(ListEntriesRequest request, CallOptions options)

Lists entries.

Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].

Parameters
Name	Description
`request`	`ListEntriesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListEntriesResponse`	The response received from the server.

ListEntries(ListEntriesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEntriesResponse ListEntries(ListEntriesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists entries.

Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].

Parameters
Name	Description
`request`	`ListEntriesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ListEntriesResponse`	The response received from the server.

ListEntriesAsync(ListEntriesRequest, CallOptions)

public virtual AsyncUnaryCall<ListEntriesResponse> ListEntriesAsync(ListEntriesRequest request, CallOptions options)

Lists entries.

Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].

Parameters
Name	Description
`request`	`ListEntriesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallListEntriesResponse`	The call object.

ListEntriesAsync(ListEntriesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEntriesResponse> ListEntriesAsync(ListEntriesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists entries.

Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].

Parameters
Name	Description
`request`	`ListEntriesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallListEntriesResponse`	The call object.

ListEntryGroups(ListEntryGroupsRequest, CallOptions)

public virtual ListEntryGroupsResponse ListEntryGroups(ListEntryGroupsRequest request, CallOptions options)

Lists entry groups.

Parameters
Name	Description
`request`	`ListEntryGroupsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListEntryGroupsResponse`	The response received from the server.

ListEntryGroups(ListEntryGroupsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEntryGroupsResponse ListEntryGroups(ListEntryGroupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists entry groups.

Parameters
Name	Description
`request`	`ListEntryGroupsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ListEntryGroupsResponse`	The response received from the server.

ListEntryGroupsAsync(ListEntryGroupsRequest, CallOptions)

public virtual AsyncUnaryCall<ListEntryGroupsResponse> ListEntryGroupsAsync(ListEntryGroupsRequest request, CallOptions options)

Lists entry groups.

Parameters
Name	Description
`request`	`ListEntryGroupsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallListEntryGroupsResponse`	The call object.

ListEntryGroupsAsync(ListEntryGroupsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEntryGroupsResponse> ListEntryGroupsAsync(ListEntryGroupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists entry groups.

Parameters
Name	Description
`request`	`ListEntryGroupsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallListEntryGroupsResponse`	The call object.

ListTags(ListTagsRequest, CallOptions)

public virtual ListTagsResponse ListTags(ListTagsRequest request, CallOptions options)

Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry]. The [columns][google.cloud.datacatalog.v1.Tag.column] in the response are lowercased.

Parameters
Name	Description
`request`	`ListTagsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListTagsResponse`	The response received from the server.

ListTags(ListTagsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListTagsResponse ListTags(ListTagsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry]. The [columns][google.cloud.datacatalog.v1.Tag.column] in the response are lowercased.

Parameters
Name	Description
`request`	`ListTagsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ListTagsResponse`	The response received from the server.

ListTagsAsync(ListTagsRequest, CallOptions)

public virtual AsyncUnaryCall<ListTagsResponse> ListTagsAsync(ListTagsRequest request, CallOptions options)

Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry]. The [columns][google.cloud.datacatalog.v1.Tag.column] in the response are lowercased.

Parameters
Name	Description
`request`	`ListTagsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallListTagsResponse`	The call object.

ListTagsAsync(ListTagsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListTagsResponse> ListTagsAsync(ListTagsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry]. The [columns][google.cloud.datacatalog.v1.Tag.column] in the response are lowercased.

Parameters
Name	Description
`request`	`ListTagsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallListTagsResponse`	The call object.

LookupEntry(LookupEntryRequest, CallOptions)

public virtual Entry LookupEntry(LookupEntryRequest request, CallOptions options)

Gets an entry by its target resource name.

The resource name comes from the source Google Cloud Platform service.

Parameters
Name	Description
`request`	`LookupEntryRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Entry`	The response received from the server.

LookupEntry(LookupEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual Entry LookupEntry(LookupEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an entry by its target resource name.

The resource name comes from the source Google Cloud Platform service.

Parameters
Name	Description
`request`	`LookupEntryRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Entry`	The response received from the server.

LookupEntryAsync(LookupEntryRequest, CallOptions)

public virtual AsyncUnaryCall<Entry> LookupEntryAsync(LookupEntryRequest request, CallOptions options)

Gets an entry by its target resource name.

The resource name comes from the source Google Cloud Platform service.

Parameters
Name	Description
`request`	`LookupEntryRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallEntry`	The call object.

LookupEntryAsync(LookupEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Entry> LookupEntryAsync(LookupEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets an entry by its target resource name.

The resource name comes from the source Google Cloud Platform service.

Parameters
Name	Description
`request`	`LookupEntryRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallEntry`	The call object.

ModifyEntryContacts(ModifyEntryContactsRequest, CallOptions)

public virtual Contacts ModifyEntryContacts(ModifyEntryContactsRequest request, CallOptions options)

Modifies contacts, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry].

To call this method, you must have the datacatalog.entries.updateContacts IAM permission on the corresponding project.

Parameters
Name	Description
`request`	`ModifyEntryContactsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Contacts`	The response received from the server.

ModifyEntryContacts(ModifyEntryContactsRequest, Metadata, DateTime?, CancellationToken)

public virtual Contacts ModifyEntryContacts(ModifyEntryContactsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Modifies contacts, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry].

To call this method, you must have the datacatalog.entries.updateContacts IAM permission on the corresponding project.

Parameters
Name	Description
`request`	`ModifyEntryContactsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Contacts`	The response received from the server.

ModifyEntryContactsAsync(ModifyEntryContactsRequest, CallOptions)

public virtual AsyncUnaryCall<Contacts> ModifyEntryContactsAsync(ModifyEntryContactsRequest request, CallOptions options)

Modifies contacts, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry].

To call this method, you must have the datacatalog.entries.updateContacts IAM permission on the corresponding project.

Parameters
Name	Description
`request`	`ModifyEntryContactsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallContacts`	The call object.

ModifyEntryContactsAsync(ModifyEntryContactsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Contacts> ModifyEntryContactsAsync(ModifyEntryContactsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Modifies contacts, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry].

To call this method, you must have the datacatalog.entries.updateContacts IAM permission on the corresponding project.

Parameters
Name	Description
`request`	`ModifyEntryContactsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallContacts`	The call object.

ModifyEntryOverview(ModifyEntryOverviewRequest, CallOptions)

public virtual EntryOverview ModifyEntryOverview(ModifyEntryOverviewRequest request, CallOptions options)

Modifies entry overview, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry].

To call this method, you must have the datacatalog.entries.updateOverview IAM permission on the corresponding project.

Parameters
Name	Description
`request`	`ModifyEntryOverviewRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`EntryOverview`	The response received from the server.

ModifyEntryOverview(ModifyEntryOverviewRequest, Metadata, DateTime?, CancellationToken)

public virtual EntryOverview ModifyEntryOverview(ModifyEntryOverviewRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Modifies entry overview, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry].

To call this method, you must have the datacatalog.entries.updateOverview IAM permission on the corresponding project.

Parameters
Name	Description
`request`	`ModifyEntryOverviewRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`EntryOverview`	The response received from the server.

ModifyEntryOverviewAsync(ModifyEntryOverviewRequest, CallOptions)

public virtual AsyncUnaryCall<EntryOverview> ModifyEntryOverviewAsync(ModifyEntryOverviewRequest request, CallOptions options)

Modifies entry overview, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry].

To call this method, you must have the datacatalog.entries.updateOverview IAM permission on the corresponding project.

Parameters
Name	Description
`request`	`ModifyEntryOverviewRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallEntryOverview`	The call object.

ModifyEntryOverviewAsync(ModifyEntryOverviewRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EntryOverview> ModifyEntryOverviewAsync(ModifyEntryOverviewRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Modifies entry overview, part of the business context of an [Entry][google.cloud.datacatalog.v1.Entry].

To call this method, you must have the datacatalog.entries.updateOverview IAM permission on the corresponding project.

Parameters
Name	Description
`request`	`ModifyEntryOverviewRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallEntryOverview`	The call object.

NewInstance(ClientBaseConfiguration)

protected override DataCatalog.DataCatalogClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration`

Returns
Type	Description
`DataCatalogDataCatalogClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.DataCatalog.V1.DataCatalog.DataCatalogClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

ReconcileTags(ReconcileTagsRequest, CallOptions)

public virtual Operation ReconcileTags(ReconcileTagsRequest request, CallOptions options)

ReconcileTags creates or updates a list of tags on the entry. If the [ReconcileTagsRequest.force_delete_missing][google.cloud.datacatalog.v1.ReconcileTagsRequest.force_delete_missing] parameter is set, the operation deletes tags not included in the input tag list.

ReconcileTags returns a [long-running operation] [google.longrunning.Operation] resource that can be queried with [Operations.GetOperation][google.longrunning.Operations.GetOperation] to return [ReconcileTagsMetadata] [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and a [ReconcileTagsResponse] [google.cloud.datacatalog.v1.ReconcileTagsResponse] message.

Parameters
Name	Description
`request`	`ReconcileTagsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

ReconcileTags(ReconcileTagsRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ReconcileTags(ReconcileTagsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters
Name	Description
`request`	`ReconcileTagsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

ReconcileTagsAsync(ReconcileTagsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ReconcileTagsAsync(ReconcileTagsRequest request, CallOptions options)

Parameters
Name	Description
`request`	`ReconcileTagsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

ReconcileTagsAsync(ReconcileTagsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ReconcileTagsAsync(ReconcileTagsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters
Name	Description
`request`	`ReconcileTagsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

RenameTagTemplateField(RenameTagTemplateFieldRequest, CallOptions)

public virtual TagTemplateField RenameTagTemplateField(RenameTagTemplateFieldRequest request, CallOptions options)

Renames a field in a tag template.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`RenameTagTemplateFieldRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`TagTemplateField`	The response received from the server.

RenameTagTemplateField(RenameTagTemplateFieldRequest, Metadata, DateTime?, CancellationToken)

public virtual TagTemplateField RenameTagTemplateField(RenameTagTemplateFieldRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Renames a field in a tag template.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`RenameTagTemplateFieldRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`TagTemplateField`	The response received from the server.

RenameTagTemplateFieldAsync(RenameTagTemplateFieldRequest, CallOptions)

public virtual AsyncUnaryCall<TagTemplateField> RenameTagTemplateFieldAsync(RenameTagTemplateFieldRequest request, CallOptions options)

Renames a field in a tag template.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`RenameTagTemplateFieldRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallTagTemplateField`	The call object.

RenameTagTemplateFieldAsync(RenameTagTemplateFieldRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TagTemplateField> RenameTagTemplateFieldAsync(RenameTagTemplateFieldRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Renames a field in a tag template.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`RenameTagTemplateFieldRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallTagTemplateField`	The call object.

RenameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest, CallOptions)

public virtual TagTemplateField RenameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest request, CallOptions options)

Renames an enum value in a tag template.

Within a single enum field, enum values must be unique.

Parameters
Name	Description
`request`	`RenameTagTemplateFieldEnumValueRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`TagTemplateField`	The response received from the server.

RenameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest, Metadata, DateTime?, CancellationToken)

public virtual TagTemplateField RenameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Renames an enum value in a tag template.

Within a single enum field, enum values must be unique.

Parameters
Name	Description
`request`	`RenameTagTemplateFieldEnumValueRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`TagTemplateField`	The response received from the server.

RenameTagTemplateFieldEnumValueAsync(RenameTagTemplateFieldEnumValueRequest, CallOptions)

public virtual AsyncUnaryCall<TagTemplateField> RenameTagTemplateFieldEnumValueAsync(RenameTagTemplateFieldEnumValueRequest request, CallOptions options)

Renames an enum value in a tag template.

Within a single enum field, enum values must be unique.

Parameters
Name	Description
`request`	`RenameTagTemplateFieldEnumValueRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallTagTemplateField`	The call object.

RenameTagTemplateFieldEnumValueAsync(RenameTagTemplateFieldEnumValueRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TagTemplateField> RenameTagTemplateFieldEnumValueAsync(RenameTagTemplateFieldEnumValueRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Renames an enum value in a tag template.

Within a single enum field, enum values must be unique.

Parameters
Name	Description
`request`	`RenameTagTemplateFieldEnumValueRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallTagTemplateField`	The call object.

SearchCatalog(SearchCatalogRequest, CallOptions)

public virtual SearchCatalogResponse SearchCatalog(SearchCatalogRequest request, CallOptions options)

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

This is a Custom Method that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods.

Note: Data Catalog search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries.

For more information, see Data Catalog search syntax.

Parameters
Name	Description
`request`	`SearchCatalogRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`SearchCatalogResponse`	The response received from the server.

SearchCatalog(SearchCatalogRequest, Metadata, DateTime?, CancellationToken)

public virtual SearchCatalogResponse SearchCatalog(SearchCatalogRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

This is a Custom Method that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods.

For more information, see Data Catalog search syntax.

Parameters
Name	Description
`request`	`SearchCatalogRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`SearchCatalogResponse`	The response received from the server.

SearchCatalogAsync(SearchCatalogRequest, CallOptions)

public virtual AsyncUnaryCall<SearchCatalogResponse> SearchCatalogAsync(SearchCatalogRequest request, CallOptions options)

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

This is a Custom Method that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods.

For more information, see Data Catalog search syntax.

Parameters
Name	Description
`request`	`SearchCatalogRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallSearchCatalogResponse`	The call object.

SearchCatalogAsync(SearchCatalogRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchCatalogResponse> SearchCatalogAsync(SearchCatalogRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

This is a Custom Method that doesn't return all information on a resource, only its ID and high level fields. To get more information, you can subsequently call specific get methods.

For more information, see Data Catalog search syntax.

Parameters
Name	Description
`request`	`SearchCatalogRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallSearchCatalogResponse`	The call object.

SetIamPolicy(SetIamPolicyRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallOptions options)

Sets an access control policy for a resource. Replaces any existing policy.

Supported resources are:

Tag templates
Entry groups

Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog.

To call this method, you must have the following Google IAM permissions:

datacatalog.tagTemplates.setIamPolicy to set policies on tag templates.
datacatalog.entryGroups.setIamPolicy to set policies on entry groups.

Parameters
Name	Description
`request`	`SetIamPolicyRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Policy`	The response received from the server.

SetIamPolicy(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets an access control policy for a resource. Replaces any existing policy.

Supported resources are:

Tag templates
Entry groups

To call this method, you must have the following Google IAM permissions:

datacatalog.tagTemplates.setIamPolicy to set policies on tag templates.
datacatalog.entryGroups.setIamPolicy to set policies on entry groups.

Parameters
Name	Description
`request`	`SetIamPolicyRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Policy`	The response received from the server.

SetIamPolicyAsync(SetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallOptions options)

Sets an access control policy for a resource. Replaces any existing policy.

Supported resources are:

Tag templates
Entry groups

To call this method, you must have the following Google IAM permissions:

datacatalog.tagTemplates.setIamPolicy to set policies on tag templates.
datacatalog.entryGroups.setIamPolicy to set policies on entry groups.

Parameters
Name	Description
`request`	`SetIamPolicyRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallPolicy`	The call object.

SetIamPolicyAsync(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets an access control policy for a resource. Replaces any existing policy.

Supported resources are:

Tag templates
Entry groups

To call this method, you must have the following Google IAM permissions:

datacatalog.tagTemplates.setIamPolicy to set policies on tag templates.
datacatalog.entryGroups.setIamPolicy to set policies on entry groups.

Parameters
Name	Description
`request`	`SetIamPolicyRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallPolicy`	The call object.

StarEntry(StarEntryRequest, CallOptions)

public virtual StarEntryResponse StarEntry(StarEntryRequest request, CallOptions options)

Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user. Starring information is private to each user.

Parameters
Name	Description
`request`	`StarEntryRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`StarEntryResponse`	The response received from the server.

StarEntry(StarEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual StarEntryResponse StarEntry(StarEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user. Starring information is private to each user.

Parameters
Name	Description
`request`	`StarEntryRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`StarEntryResponse`	The response received from the server.

StarEntryAsync(StarEntryRequest, CallOptions)

public virtual AsyncUnaryCall<StarEntryResponse> StarEntryAsync(StarEntryRequest request, CallOptions options)

Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user. Starring information is private to each user.

Parameters
Name	Description
`request`	`StarEntryRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallStarEntryResponse`	The call object.

StarEntryAsync(StarEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<StarEntryResponse> StarEntryAsync(StarEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by the current user. Starring information is private to each user.

Parameters
Name	Description
`request`	`StarEntryRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallStarEntryResponse`	The call object.

TestIamPermissions(TestIamPermissionsRequest, CallOptions)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallOptions options)

Gets your permissions on a resource.

Returns an empty set of permissions if the resource doesn't exist.

Supported resources are:

Tag templates
Entry groups

Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog.

No Google IAM permissions are required to call this method.

Parameters
Name	Description
`request`	`TestIamPermissionsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`TestIamPermissionsResponse`	The response received from the server.

TestIamPermissions(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets your permissions on a resource.

Returns an empty set of permissions if the resource doesn't exist.

Supported resources are:

Tag templates
Entry groups

No Google IAM permissions are required to call this method.

Parameters
Name	Description
`request`	`TestIamPermissionsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`TestIamPermissionsResponse`	The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsRequest, CallOptions)

public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallOptions options)

Gets your permissions on a resource.

Returns an empty set of permissions if the resource doesn't exist.

Supported resources are:

Tag templates
Entry groups

No Google IAM permissions are required to call this method.

Parameters
Name	Description
`request`	`TestIamPermissionsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallTestIamPermissionsResponse`	The call object.

TestIamPermissionsAsync(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets your permissions on a resource.

Returns an empty set of permissions if the resource doesn't exist.

Supported resources are:

Tag templates
Entry groups

No Google IAM permissions are required to call this method.

Parameters
Name	Description
`request`	`TestIamPermissionsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallTestIamPermissionsResponse`	The call object.

UnstarEntry(UnstarEntryRequest, CallOptions)

public virtual UnstarEntryResponse UnstarEntry(UnstarEntryRequest request, CallOptions options)

Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by the current user. Starring information is private to each user.

Parameters
Name	Description
`request`	`UnstarEntryRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`UnstarEntryResponse`	The response received from the server.

UnstarEntry(UnstarEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual UnstarEntryResponse UnstarEntry(UnstarEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by the current user. Starring information is private to each user.

Parameters
Name	Description
`request`	`UnstarEntryRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`UnstarEntryResponse`	The response received from the server.

UnstarEntryAsync(UnstarEntryRequest, CallOptions)

public virtual AsyncUnaryCall<UnstarEntryResponse> UnstarEntryAsync(UnstarEntryRequest request, CallOptions options)

Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by the current user. Starring information is private to each user.

Parameters
Name	Description
`request`	`UnstarEntryRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallUnstarEntryResponse`	The call object.

UnstarEntryAsync(UnstarEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<UnstarEntryResponse> UnstarEntryAsync(UnstarEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by the current user. Starring information is private to each user.

Parameters
Name	Description
`request`	`UnstarEntryRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallUnstarEntryResponse`	The call object.

UpdateEntry(UpdateEntryRequest, CallOptions)

public virtual Entry UpdateEntry(UpdateEntryRequest request, CallOptions options)

Updates an existing entry.

You must enable the Data Catalog API in the project identified by the entry.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`UpdateEntryRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Entry`	The response received from the server.

UpdateEntry(UpdateEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual Entry UpdateEntry(UpdateEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing entry.

You must enable the Data Catalog API in the project identified by the entry.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`UpdateEntryRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Entry`	The response received from the server.

UpdateEntryAsync(UpdateEntryRequest, CallOptions)

public virtual AsyncUnaryCall<Entry> UpdateEntryAsync(UpdateEntryRequest request, CallOptions options)

Updates an existing entry.

You must enable the Data Catalog API in the project identified by the entry.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`UpdateEntryRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallEntry`	The call object.

UpdateEntryAsync(UpdateEntryRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Entry> UpdateEntryAsync(UpdateEntryRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing entry.

You must enable the Data Catalog API in the project identified by the entry.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`UpdateEntryRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallEntry`	The call object.

UpdateEntryGroup(UpdateEntryGroupRequest, CallOptions)

public virtual EntryGroup UpdateEntryGroup(UpdateEntryGroupRequest request, CallOptions options)

Updates an entry group.

You must enable the Data Catalog API in the project identified by the entry_group.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`UpdateEntryGroupRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`EntryGroup`	The response received from the server.

UpdateEntryGroup(UpdateEntryGroupRequest, Metadata, DateTime?, CancellationToken)

public virtual EntryGroup UpdateEntryGroup(UpdateEntryGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an entry group.

You must enable the Data Catalog API in the project identified by the entry_group.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`UpdateEntryGroupRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`EntryGroup`	The response received from the server.

UpdateEntryGroupAsync(UpdateEntryGroupRequest, CallOptions)

public virtual AsyncUnaryCall<EntryGroup> UpdateEntryGroupAsync(UpdateEntryGroupRequest request, CallOptions options)

Updates an entry group.

You must enable the Data Catalog API in the project identified by the entry_group.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`UpdateEntryGroupRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallEntryGroup`	The call object.

UpdateEntryGroupAsync(UpdateEntryGroupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EntryGroup> UpdateEntryGroupAsync(UpdateEntryGroupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an entry group.

You must enable the Data Catalog API in the project identified by the entry_group.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`UpdateEntryGroupRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallEntryGroup`	The call object.

UpdateTag(UpdateTagRequest, CallOptions)

public virtual Tag UpdateTag(UpdateTagRequest request, CallOptions options)

Updates an existing tag.

Parameters
Name	Description
`request`	`UpdateTagRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Tag`	The response received from the server.

UpdateTag(UpdateTagRequest, Metadata, DateTime?, CancellationToken)

public virtual Tag UpdateTag(UpdateTagRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing tag.

Parameters
Name	Description
`request`	`UpdateTagRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Tag`	The response received from the server.

UpdateTagAsync(UpdateTagRequest, CallOptions)

public virtual AsyncUnaryCall<Tag> UpdateTagAsync(UpdateTagRequest request, CallOptions options)

Updates an existing tag.

Parameters
Name	Description
`request`	`UpdateTagRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallTag`	The call object.

UpdateTagAsync(UpdateTagRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Tag> UpdateTagAsync(UpdateTagRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing tag.

Parameters
Name	Description
`request`	`UpdateTagRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallTag`	The call object.

UpdateTagTemplate(UpdateTagTemplateRequest, CallOptions)

public virtual TagTemplate UpdateTagTemplate(UpdateTagTemplateRequest request, CallOptions options)

Updates a tag template.

You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods.

You must enable the Data Catalog API in the project identified by the tag_template.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`UpdateTagTemplateRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`TagTemplate`	The response received from the server.

UpdateTagTemplate(UpdateTagTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual TagTemplate UpdateTagTemplate(UpdateTagTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a tag template.

You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods.

You must enable the Data Catalog API in the project identified by the tag_template.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`UpdateTagTemplateRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`TagTemplate`	The response received from the server.

UpdateTagTemplateAsync(UpdateTagTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<TagTemplate> UpdateTagTemplateAsync(UpdateTagTemplateRequest request, CallOptions options)

Updates a tag template.

You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods.

You must enable the Data Catalog API in the project identified by the tag_template.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`UpdateTagTemplateRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallTagTemplate`	The call object.

UpdateTagTemplateAsync(UpdateTagTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TagTemplate> UpdateTagTemplateAsync(UpdateTagTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a tag template.

You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods.

You must enable the Data Catalog API in the project identified by the tag_template.name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`UpdateTagTemplateRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallTagTemplate`	The call object.

UpdateTagTemplateField(UpdateTagTemplateFieldRequest, CallOptions)

public virtual TagTemplateField UpdateTagTemplateField(UpdateTagTemplateFieldRequest request, CallOptions options)

Updates a field in a tag template.

You can't update the field type with this method.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`UpdateTagTemplateFieldRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`TagTemplateField`	The response received from the server.

UpdateTagTemplateField(UpdateTagTemplateFieldRequest, Metadata, DateTime?, CancellationToken)

public virtual TagTemplateField UpdateTagTemplateField(UpdateTagTemplateFieldRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a field in a tag template.

You can't update the field type with this method.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`UpdateTagTemplateFieldRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`TagTemplateField`	The response received from the server.

UpdateTagTemplateFieldAsync(UpdateTagTemplateFieldRequest, CallOptions)

public virtual AsyncUnaryCall<TagTemplateField> UpdateTagTemplateFieldAsync(UpdateTagTemplateFieldRequest request, CallOptions options)

Updates a field in a tag template.

You can't update the field type with this method.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`UpdateTagTemplateFieldRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallTagTemplateField`	The call object.

UpdateTagTemplateFieldAsync(UpdateTagTemplateFieldRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TagTemplateField> UpdateTagTemplateFieldAsync(UpdateTagTemplateFieldRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a field in a tag template.

You can't update the field type with this method.

You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project.

Parameters
Name	Description
`request`	`UpdateTagTemplateFieldRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallTagTemplateField`	The call object.