Data Catalog v1 API - Class PolicyTagManagerSerialization.PolicyTagManagerSerializationClient (2.5.0)

public class PolicyTagManagerSerialization.PolicyTagManagerSerializationClient : ClientBase<PolicyTagManagerSerialization.PolicyTagManagerSerializationClient>

Reference documentation and code samples for the Data Catalog v1 API class PolicyTagManagerSerialization.PolicyTagManagerSerializationClient.

Client for PolicyTagManagerSerialization

Inheritance

object > ClientBase > ClientBasePolicyTagManagerSerializationPolicyTagManagerSerializationClient > PolicyTagManagerSerialization.PolicyTagManagerSerializationClient

Namespace

Google.Cloud.DataCatalog.V1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

PolicyTagManagerSerializationClient()

protected PolicyTagManagerSerializationClient()

Protected parameterless constructor to allow creation of test doubles.

PolicyTagManagerSerializationClient(CallInvoker)

public PolicyTagManagerSerializationClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

PolicyTagManagerSerializationClient(ChannelBase)

public PolicyTagManagerSerializationClient(ChannelBase channel)

Creates a new client for PolicyTagManagerSerialization

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

PolicyTagManagerSerializationClient(ClientBaseConfiguration)

protected PolicyTagManagerSerializationClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

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

Returns
TypeDescription
IAMPolicyIAMPolicyClient

A new IAMPolicy.IAMPolicyClient for the same target as this client.

ExportTaxonomies(ExportTaxonomiesRequest, CallOptions)

public virtual ExportTaxonomiesResponse ExportTaxonomies(ExportTaxonomiesRequest request, CallOptions options)

Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project.

This method generates SerializedTaxonomy protocol buffers with nested policy tags that can be used as input for ImportTaxonomies calls.

Parameters
NameDescription
requestExportTaxonomiesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ExportTaxonomiesResponse

The response received from the server.

ExportTaxonomies(ExportTaxonomiesRequest, Metadata, DateTime?, CancellationToken)

public virtual ExportTaxonomiesResponse ExportTaxonomies(ExportTaxonomiesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project.

This method generates SerializedTaxonomy protocol buffers with nested policy tags that can be used as input for ImportTaxonomies calls.

Parameters
NameDescription
requestExportTaxonomiesRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
ExportTaxonomiesResponse

The response received from the server.

ExportTaxonomiesAsync(ExportTaxonomiesRequest, CallOptions)

public virtual AsyncUnaryCall<ExportTaxonomiesResponse> ExportTaxonomiesAsync(ExportTaxonomiesRequest request, CallOptions options)

Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project.

This method generates SerializedTaxonomy protocol buffers with nested policy tags that can be used as input for ImportTaxonomies calls.

Parameters
NameDescription
requestExportTaxonomiesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallExportTaxonomiesResponse

The call object.

ExportTaxonomiesAsync(ExportTaxonomiesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ExportTaxonomiesResponse> ExportTaxonomiesAsync(ExportTaxonomiesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Exports taxonomies in the requested type and returns them, including their policy tags. The requested taxonomies must belong to the same project.

This method generates SerializedTaxonomy protocol buffers with nested policy tags that can be used as input for ImportTaxonomies calls.

Parameters
NameDescription
requestExportTaxonomiesRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallExportTaxonomiesResponse

The call object.

ImportTaxonomies(ImportTaxonomiesRequest, CallOptions)

public virtual ImportTaxonomiesResponse ImportTaxonomies(ImportTaxonomiesRequest request, CallOptions options)

Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources.

For a cross-regional source, new taxonomies are created by copying from a source in another region.

For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures.

Parameters
NameDescription
requestImportTaxonomiesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ImportTaxonomiesResponse

The response received from the server.

ImportTaxonomies(ImportTaxonomiesRequest, Metadata, DateTime?, CancellationToken)

public virtual ImportTaxonomiesResponse ImportTaxonomies(ImportTaxonomiesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources.

For a cross-regional source, new taxonomies are created by copying from a source in another region.

For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures.

Parameters
NameDescription
requestImportTaxonomiesRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
ImportTaxonomiesResponse

The response received from the server.

ImportTaxonomiesAsync(ImportTaxonomiesRequest, CallOptions)

public virtual AsyncUnaryCall<ImportTaxonomiesResponse> ImportTaxonomiesAsync(ImportTaxonomiesRequest request, CallOptions options)

Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources.

For a cross-regional source, new taxonomies are created by copying from a source in another region.

For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures.

Parameters
NameDescription
requestImportTaxonomiesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallImportTaxonomiesResponse

The call object.

ImportTaxonomiesAsync(ImportTaxonomiesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ImportTaxonomiesResponse> ImportTaxonomiesAsync(ImportTaxonomiesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates new taxonomies (including their policy tags) in a given project by importing from inlined or cross-regional sources.

For a cross-regional source, new taxonomies are created by copying from a source in another region.

For an inlined source, taxonomies and policy tags are created in bulk using nested protocol buffer structures.

Parameters
NameDescription
requestImportTaxonomiesRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallImportTaxonomiesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override PolicyTagManagerSerialization.PolicyTagManagerSerializationClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
PolicyTagManagerSerializationPolicyTagManagerSerializationClient
Overrides

ReplaceTaxonomy(ReplaceTaxonomyRequest, CallOptions)

public virtual Taxonomy ReplaceTaxonomy(ReplaceTaxonomyRequest request, CallOptions options)

Replaces (updates) a taxonomy and all its policy tags.

The taxonomy and its entire hierarchy of policy tags must be represented literally by SerializedTaxonomy and the nested SerializedPolicyTag messages.

This operation automatically does the following:

  • Deletes the existing policy tags that are missing from the SerializedPolicyTag.
  • Creates policy tags that don't have resource names. They are considered new.
  • Updates policy tags with valid resources names accordingly.
Parameters
NameDescription
requestReplaceTaxonomyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Taxonomy

The response received from the server.

ReplaceTaxonomy(ReplaceTaxonomyRequest, Metadata, DateTime?, CancellationToken)

public virtual Taxonomy ReplaceTaxonomy(ReplaceTaxonomyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Replaces (updates) a taxonomy and all its policy tags.

The taxonomy and its entire hierarchy of policy tags must be represented literally by SerializedTaxonomy and the nested SerializedPolicyTag messages.

This operation automatically does the following:

  • Deletes the existing policy tags that are missing from the SerializedPolicyTag.
  • Creates policy tags that don't have resource names. They are considered new.
  • Updates policy tags with valid resources names accordingly.
Parameters
NameDescription
requestReplaceTaxonomyRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
Taxonomy

The response received from the server.

ReplaceTaxonomyAsync(ReplaceTaxonomyRequest, CallOptions)

public virtual AsyncUnaryCall<Taxonomy> ReplaceTaxonomyAsync(ReplaceTaxonomyRequest request, CallOptions options)

Replaces (updates) a taxonomy and all its policy tags.

The taxonomy and its entire hierarchy of policy tags must be represented literally by SerializedTaxonomy and the nested SerializedPolicyTag messages.

This operation automatically does the following:

  • Deletes the existing policy tags that are missing from the SerializedPolicyTag.
  • Creates policy tags that don't have resource names. They are considered new.
  • Updates policy tags with valid resources names accordingly.
Parameters
NameDescription
requestReplaceTaxonomyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallTaxonomy

The call object.

ReplaceTaxonomyAsync(ReplaceTaxonomyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Taxonomy> ReplaceTaxonomyAsync(ReplaceTaxonomyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Replaces (updates) a taxonomy and all its policy tags.

The taxonomy and its entire hierarchy of policy tags must be represented literally by SerializedTaxonomy and the nested SerializedPolicyTag messages.

This operation automatically does the following:

  • Deletes the existing policy tags that are missing from the SerializedPolicyTag.
  • Creates policy tags that don't have resource names. They are considered new.
  • Updates policy tags with valid resources names accordingly.
Parameters
NameDescription
requestReplaceTaxonomyRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallTaxonomy

The call object.