Class DataCatalog.DataCatalogClient (1.2.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(Channel)

[Obsolete("This constructor overload is present for compatibility only, and will be removed in the next major version")]
public DataCatalogClient(Channel channel)

Creates a new client using a channel.

Parameter
NameDescription
channelGrpc.Core.Channel

The channel 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. Only entries of types 'FILESET', 'CLUSTER', 'DATA_STREAM' or with a user-specified type can be created.

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

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

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

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

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

Parameters
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. Only entries of types 'FILESET', 'CLUSTER', 'DATA_STREAM' or with a user-specified type can be created.

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

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

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

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

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

Parameters
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 EntryGroup.

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

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

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

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

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates an EntryGroup.

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

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

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

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

Parameters
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 EntryGroup.

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

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

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

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

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates an EntryGroup.

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

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

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

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

Parameters
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 on an [Entry][google.cloud.datacatalog.v1.Entry]. Note: The project identified by the parent parameter for the tag and the tag template used to create the tag must be from the same organization.

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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 on an [Entry][google.cloud.datacatalog.v1.Entry]. Note: The project identified by the parent parameter for the tag and the tag template used to create the tag must be from the same organization.

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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. The user should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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. The user should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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. The user should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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. The user should enable the Data Catalog API in the project identified by the parent parameter (see Data Catalog Resource Project for more information).

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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. Only entries created through [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method can be deleted. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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. Only entries created through [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.CreateEntry] method can be deleted. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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 EntryGroup. Only entry groups that do not contain entries can be deleted. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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 EntryGroup. Only entry groups that do not contain entries can be deleted. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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 = default(DateTime? ), 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 = default(DateTime? ), 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 using the template. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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 using the template. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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 that field. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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 that field. Users should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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 = default(DateTime? ), 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 = default(DateTime? ), 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 EntryGroup.

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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets an EntryGroup.

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 EntryGroup.

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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets an EntryGroup.

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. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.

Supported resources are:

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

Callers must have following Google IAM permission

  • datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.
  • datacatalog.entries.getIamPolicy to get policies on entries.
  • datacatalog.entryGroups.getIamPolicy to get policies on entry groups.
Parameters
NameDescription
requestGoogle.Cloud.Iam.V1.GetIamPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Google.Cloud.Iam.V1.Policy

The response received from the server.

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

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

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

Supported resources are:

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

Callers must have following Google IAM permission

  • datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.
  • datacatalog.entries.getIamPolicy to get policies on entries.
  • datacatalog.entryGroups.getIamPolicy to get policies on entry groups.
Parameters
NameDescription
requestGoogle.Cloud.Iam.V1.GetIamPolicyRequest

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
Google.Cloud.Iam.V1.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. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.

Supported resources are:

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

Callers must have following Google IAM permission

  • datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.
  • datacatalog.entries.getIamPolicy to get policies on entries.
  • datacatalog.entryGroups.getIamPolicy to get policies on entry groups.
Parameters
NameDescription
requestGoogle.Cloud.Iam.V1.GetIamPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Google.Cloud.Iam.V1.Policy>

The call object.

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

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

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

Supported resources are:

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

Callers must have following Google IAM permission

  • datacatalog.tagTemplates.getIamPolicy to get policies on tag templates.
  • datacatalog.entries.getIamPolicy to get policies on entries.
  • datacatalog.entryGroups.getIamPolicy to get policies on entry groups.
Parameters
NameDescription
requestGoogle.Cloud.Iam.V1.GetIamPolicyRequest

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<Google.Cloud.Iam.V1.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 = default(DateTime? ), 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 = default(DateTime? ), 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.

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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists entries.

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.

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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists entries.

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 = default(DateTime? ), 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 = default(DateTime? ), 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 the tags on an [Entry][google.cloud.datacatalog.v1.Entry].

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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

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 the tags on an [Entry][google.cloud.datacatalog.v1.Entry].

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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

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)

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

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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)

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

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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.

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. The user should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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. The user should enable the Data Catalog API in the project identified by the name parameter (see Data Catalog Resource Project for more information).

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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. The enum values have to be unique within one enum field.

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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

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. The enum values have to be unique within one enum field.

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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

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, tags that match a query.

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

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

See Data Catalog Search Syntax for more information.

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

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

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

See Data Catalog Search Syntax for more information.

Parameters
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, tags that match a query.

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

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

See Data Catalog Search Syntax for more information.

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

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

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

See Data Catalog Search Syntax for more information.

Parameters
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 the access control policy for a resource. Replaces any existing policy. Supported resources are:

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

Callers must have following Google IAM permission

  • datacatalog.tagTemplates.setIamPolicy to set policies on tag templates.
  • datacatalog.entries.setIamPolicy to set policies on entries.
  • datacatalog.entryGroups.setIamPolicy to set policies on entry groups.
Parameters
NameDescription
requestGoogle.Cloud.Iam.V1.SetIamPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Google.Cloud.Iam.V1.Policy

The response received from the server.

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

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

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

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

Callers must have following Google IAM permission

  • datacatalog.tagTemplates.setIamPolicy to set policies on tag templates.
  • datacatalog.entries.setIamPolicy to set policies on entries.
  • datacatalog.entryGroups.setIamPolicy to set policies on entry groups.
Parameters
NameDescription
requestGoogle.Cloud.Iam.V1.SetIamPolicyRequest

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
Google.Cloud.Iam.V1.Policy

The response received from the server.

SetIamPolicyAsync(SetIamPolicyRequest, CallOptions)

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

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

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

Callers must have following Google IAM permission

  • datacatalog.tagTemplates.setIamPolicy to set policies on tag templates.
  • datacatalog.entries.setIamPolicy to set policies on entries.
  • datacatalog.entryGroups.setIamPolicy to set policies on entry groups.
Parameters
NameDescription
requestGoogle.Cloud.Iam.V1.SetIamPolicyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Google.Cloud.Iam.V1.Policy>

The call object.

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

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

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

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

Callers must have following Google IAM permission

  • datacatalog.tagTemplates.setIamPolicy to set policies on tag templates.
  • datacatalog.entries.setIamPolicy to set policies on entries.
  • datacatalog.entryGroups.setIamPolicy to set policies on entry groups.
Parameters
NameDescription
requestGoogle.Cloud.Iam.V1.SetIamPolicyRequest

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<Google.Cloud.Iam.V1.Policy>

The call object.

TestIamPermissions(TestIamPermissionsRequest, CallOptions)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallOptions options)

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

Supported resources are:

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

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

Parameters
NameDescription
requestGoogle.Cloud.Iam.V1.TestIamPermissionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Google.Cloud.Iam.V1.TestIamPermissionsResponse

The response received from the server.

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

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

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

Supported resources are:

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

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

Parameters
NameDescription
requestGoogle.Cloud.Iam.V1.TestIamPermissionsRequest

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
Google.Cloud.Iam.V1.TestIamPermissionsResponse

The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsRequest, CallOptions)

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

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

Supported resources are:

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

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

Parameters
NameDescription
requestGoogle.Cloud.Iam.V1.TestIamPermissionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Google.Cloud.Iam.V1.TestIamPermissionsResponse>

The call object.

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

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

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

Supported resources are:

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

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

Parameters
NameDescription
requestGoogle.Cloud.Iam.V1.TestIamPermissionsRequest

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<Google.Cloud.Iam.V1.TestIamPermissionsResponse>

The call object.

UpdateEntry(UpdateEntryRequest, CallOptions)

public virtual Entry UpdateEntry(UpdateEntryRequest request, CallOptions options)

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

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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. Users should enable the Data Catalog API in the project identified by the entry.name parameter (see Data Catalog Resource Project for more information).

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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 EntryGroup. The user should enable the Data Catalog API in the project identified by the entry_group.name parameter (see Data Catalog Resource Project for more information).

Parameters
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 = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
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(UpdateEntryGroupRequest request, CallOptions options)

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

Parameters
NameDescription
requestUpdateEntryGroupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<EntryGroup>

The call object.

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

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

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

Parameters
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
AsyncUnaryCall<EntryGroup>

The call object.

UpdateTag(UpdateTagRequest, CallOptions)

public virtual Tag UpdateTag(UpdateTagRequest request, CallOptions options)

Updates an existing tag.

Parameters
NameDescription
requestUpdateTagRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Tag

The response received from the server.

UpdateTag(UpdateTagRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates an existing tag.

Parameters
NameDescription
requestUpdateTagRequest

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.

UpdateTagAsync(UpdateTagRequest, CallOptions)

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

Updates an existing tag.

Parameters
NameDescription
requestUpdateTagRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Tag>

The call object.

UpdateTagAsync(UpdateTagRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Updates an existing tag.

Parameters
NameDescription
requestUpdateTagRequest

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.

UpdateTagTemplate(UpdateTagTemplateRequest, CallOptions)

public virtual TagTemplate UpdateTagTemplate(UpdateTagTemplateRequest request, CallOptions options)

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

Parameters
NameDescription
requestUpdateTagTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TagTemplate

The response received from the server.

UpdateTagTemplate(UpdateTagTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestUpdateTagTemplateRequest

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.

UpdateTagTemplateAsync(UpdateTagTemplateRequest, CallOptions)

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

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

Parameters
NameDescription
requestUpdateTagTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<TagTemplate>

The call object.

UpdateTagTemplateAsync(UpdateTagTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestUpdateTagTemplateRequest

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.

UpdateTagTemplateField(UpdateTagTemplateFieldRequest, CallOptions)

public virtual TagTemplateField UpdateTagTemplateField(UpdateTagTemplateFieldRequest request, CallOptions options)

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

Parameters
NameDescription
requestUpdateTagTemplateFieldRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TagTemplateField

The response received from the server.

UpdateTagTemplateField(UpdateTagTemplateFieldRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestUpdateTagTemplateFieldRequest

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.

UpdateTagTemplateFieldAsync(UpdateTagTemplateFieldRequest, CallOptions)

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

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

Parameters
NameDescription
requestUpdateTagTemplateFieldRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<TagTemplateField>

The call object.

UpdateTagTemplateFieldAsync(UpdateTagTemplateFieldRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestUpdateTagTemplateFieldRequest

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.