Class DataCatalog.DataCatalogClient (2.1.0)

public class DataCatalogClient : ClientBase<DataCatalog.DataCatalogClient>

Client for DataCatalog

Inheritance

Object > ClientBase > ClientBase<DataCatalog.DataCatalogClient> > DataCatalog.DataCatalogClient

Namespace

Google.Cloud.DataCatalog.V1

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
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

DataCatalogClient(ChannelBase)

public DataCatalogClient(ChannelBase channel)

Creates a new client for DataCatalog

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

DataCatalogClient(ClientBase.ClientBaseConfiguration)

protected DataCatalogClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

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
NameDescription
requestCreateEntryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Entry

The response received from the server.

CreateEntry(CreateEntryRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestCreateEntryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestCreateEntryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Entry>

The call object.

CreateEntryAsync(CreateEntryRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestCreateEntryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Entry>

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
NameDescription
requestCreateEntryGroupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
EntryGroup

The response received from the server.

CreateEntryGroup(CreateEntryGroupRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestCreateEntryGroupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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})

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
NameDescription
requestCreateEntryGroupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<EntryGroup>

The call object.

CreateEntryGroupAsync(CreateEntryGroupRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestCreateEntryGroupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<EntryGroup>

The call object.

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
NameDescription
requestCreateTagRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Tag

The response received from the server.

CreateTag(CreateTagRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestCreateTagRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestCreateTagRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Tag>

The call object.

CreateTagAsync(CreateTagRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestCreateTagRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Tag>

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
NameDescription
requestCreateTagTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TagTemplate

The response received from the server.

CreateTagTemplate(CreateTagTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestCreateTagTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestCreateTagTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<TagTemplate>

The call object.

CreateTagTemplateAsync(CreateTagTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestCreateTagTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<TagTemplate>

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
NameDescription
requestCreateTagTemplateFieldRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TagTemplateField

The response received from the server.

CreateTagTemplateField(CreateTagTemplateFieldRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestCreateTagTemplateFieldRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestCreateTagTemplateFieldRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<TagTemplateField>

The call object.

CreateTagTemplateFieldAsync(CreateTagTemplateFieldRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestCreateTagTemplateFieldRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<TagTemplateField>

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
NameDescription
requestDeleteEntryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteEntry(DeleteEntryRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestDeleteEntryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestDeleteEntryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DeleteEntryAsync(DeleteEntryRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestDeleteEntryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

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
NameDescription
requestDeleteEntryGroupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteEntryGroup(DeleteEntryGroupRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestDeleteEntryGroupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestDeleteEntryGroupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DeleteEntryGroupAsync(DeleteEntryGroupRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestDeleteEntryGroupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DeleteTag(DeleteTagRequest, CallOptions)

public virtual Empty DeleteTag(DeleteTagRequest request, CallOptions options)

Deletes a tag.

Parameters
NameDescription
requestDeleteTagRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteTag(DeleteTagRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a tag.

Parameters
NameDescription
requestDeleteTagRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteTagAsync(DeleteTagRequest, CallOptions)

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

Deletes a tag.

Parameters
NameDescription
requestDeleteTagRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DeleteTagAsync(DeleteTagRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a tag.

Parameters
NameDescription
requestDeleteTagRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

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
NameDescription
requestDeleteTagTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteTagTemplate(DeleteTagTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestDeleteTagTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestDeleteTagTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DeleteTagTemplateAsync(DeleteTagTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestDeleteTagTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

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
NameDescription
requestDeleteTagTemplateFieldRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteTagTemplateField(DeleteTagTemplateFieldRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestDeleteTagTemplateFieldRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestDeleteTagTemplateFieldRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DeleteTagTemplateFieldAsync(DeleteTagTemplateFieldRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestDeleteTagTemplateFieldRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

GetEntry(GetEntryRequest, CallOptions)

public virtual Entry GetEntry(GetEntryRequest request, CallOptions options)

Gets an entry.

Parameters
NameDescription
requestGetEntryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Entry

The response received from the server.

GetEntry(GetEntryRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets an entry.

Parameters
NameDescription
requestGetEntryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Entry

The response received from the server.

GetEntryAsync(GetEntryRequest, CallOptions)

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

Gets an entry.

Parameters
NameDescription
requestGetEntryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Entry>

The call object.

GetEntryAsync(GetEntryRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets an entry.

Parameters
NameDescription
requestGetEntryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Entry>

The call object.

GetEntryGroup(GetEntryGroupRequest, CallOptions)

public virtual EntryGroup GetEntryGroup(GetEntryGroupRequest request, CallOptions options)

Gets an entry group.

Parameters
NameDescription
requestGetEntryGroupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
EntryGroup

The response received from the server.

GetEntryGroup(GetEntryGroupRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets an entry group.

Parameters
NameDescription
requestGetEntryGroupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
EntryGroup

The response received from the server.

GetEntryGroupAsync(GetEntryGroupRequest, CallOptions)

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

Gets an entry group.

Parameters
NameDescription
requestGetEntryGroupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<EntryGroup>

The call object.

GetEntryGroupAsync(GetEntryGroupRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets an entry group.

Parameters
NameDescription
requestGetEntryGroupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<EntryGroup>

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
NameDescription
requestGetIamPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Policy

The response received from the server.

GetIamPolicy(GetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestGetIamPolicyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestGetIamPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

The call object.

GetIamPolicyAsync(GetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestGetIamPolicyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

The call object.

GetTagTemplate(GetTagTemplateRequest, CallOptions)

public virtual TagTemplate GetTagTemplate(GetTagTemplateRequest request, CallOptions options)

Gets a tag template.

Parameters
NameDescription
requestGetTagTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TagTemplate

The response received from the server.

GetTagTemplate(GetTagTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets a tag template.

Parameters
NameDescription
requestGetTagTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
TagTemplate

The response received from the server.

GetTagTemplateAsync(GetTagTemplateRequest, CallOptions)

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

Gets a tag template.

Parameters
NameDescription
requestGetTagTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<TagTemplate>

The call object.

GetTagTemplateAsync(GetTagTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets a tag template.

Parameters
NameDescription
requestGetTagTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<TagTemplate>

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
NameDescription
requestListEntriesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListEntriesResponse

The response received from the server.

ListEntries(ListEntriesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestListEntriesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestListEntriesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListEntriesResponse>

The call object.

ListEntriesAsync(ListEntriesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestListEntriesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListEntriesResponse>

The call object.

ListEntryGroups(ListEntryGroupsRequest, CallOptions)

public virtual ListEntryGroupsResponse ListEntryGroups(ListEntryGroupsRequest request, CallOptions options)

Lists entry groups.

Parameters
NameDescription
requestListEntryGroupsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListEntryGroupsResponse

The response received from the server.

ListEntryGroups(ListEntryGroupsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists entry groups.

Parameters
NameDescription
requestListEntryGroupsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListEntryGroupsResponse

The response received from the server.

ListEntryGroupsAsync(ListEntryGroupsRequest, CallOptions)

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

Lists entry groups.

Parameters
NameDescription
requestListEntryGroupsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListEntryGroupsResponse>

The call object.

ListEntryGroupsAsync(ListEntryGroupsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists entry groups.

Parameters
NameDescription
requestListEntryGroupsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListEntryGroupsResponse>

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
NameDescription
requestListTagsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListTagsResponse

The response received from the server.

ListTags(ListTagsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestListTagsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestListTagsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListTagsResponse>

The call object.

ListTagsAsync(ListTagsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestListTagsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListTagsResponse>

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
NameDescription
requestLookupEntryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Entry

The response received from the server.

LookupEntry(LookupEntryRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets an entry by its target resource name.

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

Parameters
NameDescription
requestLookupEntryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestLookupEntryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Entry>

The call object.

LookupEntryAsync(LookupEntryRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets an entry by its target resource name.

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

Parameters
NameDescription
requestLookupEntryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Entry>

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
NameDescription
requestModifyEntryContactsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Contacts

The response received from the server.

ModifyEntryContacts(ModifyEntryContactsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestModifyEntryContactsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestModifyEntryContactsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Contacts>

The call object.

ModifyEntryContactsAsync(ModifyEntryContactsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestModifyEntryContactsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Contacts>

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
NameDescription
requestModifyEntryOverviewRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
EntryOverview

The response received from the server.

ModifyEntryOverview(ModifyEntryOverviewRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestModifyEntryOverviewRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestModifyEntryOverviewRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<EntryOverview>

The call object.

ModifyEntryOverviewAsync(ModifyEntryOverviewRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestModifyEntryOverviewRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<EntryOverview>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
DataCatalog.DataCatalogClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.DataCatalog.V1.DataCatalog.DataCatalogClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

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
NameDescription
requestRenameTagTemplateFieldRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TagTemplateField

The response received from the server.

RenameTagTemplateField(RenameTagTemplateFieldRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestRenameTagTemplateFieldRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestRenameTagTemplateFieldRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<TagTemplateField>

The call object.

RenameTagTemplateFieldAsync(RenameTagTemplateFieldRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestRenameTagTemplateFieldRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<TagTemplateField>

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
NameDescription
requestRenameTagTemplateFieldEnumValueRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TagTemplateField

The response received from the server.

RenameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Renames an enum value in a tag template.

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

Parameters
NameDescription
requestRenameTagTemplateFieldEnumValueRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestRenameTagTemplateFieldEnumValueRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<TagTemplateField>

The call object.

RenameTagTemplateFieldEnumValueAsync(RenameTagTemplateFieldEnumValueRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Renames an enum value in a tag template.

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

Parameters
NameDescription
requestRenameTagTemplateFieldEnumValueRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<TagTemplateField>

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
NameDescription
requestSearchCatalogRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
SearchCatalogResponse

The response received from the server.

SearchCatalog(SearchCatalogRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestSearchCatalogRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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.

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
NameDescription
requestSearchCatalogRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<SearchCatalogResponse>

The call object.

SearchCatalogAsync(SearchCatalogRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestSearchCatalogRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<SearchCatalogResponse>

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
NameDescription
requestSetIamPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Policy

The response received from the server.

SetIamPolicy(SetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestSetIamPolicyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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

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
NameDescription
requestSetIamPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

The call object.

SetIamPolicyAsync(SetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestSetIamPolicyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Policy>

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
NameDescription
requestStarEntryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
StarEntryResponse

The response received from the server.

StarEntry(StarEntryRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestStarEntryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestStarEntryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<StarEntryResponse>

The call object.

StarEntryAsync(StarEntryRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestStarEntryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<StarEntryResponse>

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
NameDescription
requestTestIamPermissionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TestIamPermissionsResponse

The response received from the server.

TestIamPermissions(TestIamPermissionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestTestIamPermissionsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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

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
NameDescription
requestTestIamPermissionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<TestIamPermissionsResponse>

The call object.

TestIamPermissionsAsync(TestIamPermissionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestTestIamPermissionsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<TestIamPermissionsResponse>

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
NameDescription
requestUnstarEntryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
UnstarEntryResponse

The response received from the server.

UnstarEntry(UnstarEntryRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestUnstarEntryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestUnstarEntryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<UnstarEntryResponse>

The call object.

UnstarEntryAsync(UnstarEntryRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestUnstarEntryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<UnstarEntryResponse>

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
NameDescription
requestUpdateEntryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Entry

The response received from the server.

UpdateEntry(UpdateEntryRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestUpdateEntryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestUpdateEntryRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Entry>

The call object.

UpdateEntryAsync(UpdateEntryRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestUpdateEntryRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Entry>

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
NameDescription
requestUpdateEntryGroupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
EntryGroup

The response received from the server.

UpdateEntryGroup(UpdateEntryGroupRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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
NameDescription
requestUpdateEntryGroupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
EntryGroup

The response received from the server.

UpdateEntryGroupAsync(UpdateEntryGroupRequest, CallOptions)

public virtual AsyncUnaryCall<EntryGroup> UpdateEntryGroupAsync(UpdateE