Data Catalog v1 API - Class PolicyTagManagerClientImpl (2.11.0) 

public sealed class PolicyTagManagerClientImpl : PolicyTagManagerClient

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

PolicyTagManager client wrapper implementation, for convenient use.

Inheritance

object > PolicyTagManagerClient > PolicyTagManagerClientImpl

Namespace

Google.Cloud.DataCatalog.V1

Assembly

Google.Cloud.DataCatalog.V1.dll

Remarks

Policy Tag Manager API service allows you to manage your policy tags and taxonomies.

Policy tags are used to tag BigQuery columns and apply additional access control policies. A taxonomy is a hierarchical grouping of policy tags that classify data along a common axis.

Constructors

PolicyTagManagerClientImpl(PolicyTagManagerClient, PolicyTagManagerSettings, ILogger)

public PolicyTagManagerClientImpl(PolicyTagManager.PolicyTagManagerClient grpcClient, PolicyTagManagerSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient PolicyTagManagerPolicyTagManagerClient

The underlying gRPC client.
settings PolicyTagManagerSettings

The base PolicyTagManagerSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override PolicyTagManager.PolicyTagManagerClient GrpcClient { get; }

The underlying gRPC PolicyTagManager client

Property Value
Type Description
PolicyTagManagerPolicyTagManagerClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

Methods

CreatePolicyTag(CreatePolicyTagRequest, CallSettings)

public override PolicyTag CreatePolicyTag(CreatePolicyTagRequest request, CallSettings callSettings = null)

Creates a policy tag in a taxonomy.

Parameters
Name Description
request CreatePolicyTagRequest

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

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

The RPC response.
Overrides

CreatePolicyTagAsync(CreatePolicyTagRequest, CallSettings)

public override Task<PolicyTag> CreatePolicyTagAsync(CreatePolicyTagRequest request, CallSettings callSettings = null)

Creates a policy tag in a taxonomy.

Parameters
Name Description
request CreatePolicyTagRequest

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

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

A Task containing the RPC response.
Overrides

CreateTaxonomy(CreateTaxonomyRequest, CallSettings)

public override Taxonomy CreateTaxonomy(CreateTaxonomyRequest request, CallSettings callSettings = null)

Creates a taxonomy in a specified project.

The taxonomy is initially empty, that is, it doesn't contain policy tags.

Parameters
Name Description
request CreateTaxonomyRequest

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

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

The RPC response.
Overrides

CreateTaxonomyAsync(CreateTaxonomyRequest, CallSettings)

public override Task<Taxonomy> CreateTaxonomyAsync(CreateTaxonomyRequest request, CallSettings callSettings = null)

Creates a taxonomy in a specified project.

The taxonomy is initially empty, that is, it doesn't contain policy tags.

Parameters
Name Description
request CreateTaxonomyRequest

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

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

A Task containing the RPC response.
Overrides

DeletePolicyTag(DeletePolicyTagRequest, CallSettings)

public override void DeletePolicyTag(DeletePolicyTagRequest request, CallSettings callSettings = null)

Deletes a policy tag together with the following:

  • All of its descendant policy tags, if any
  • Policies associated with the policy tag and its descendants
  • References from BigQuery table schema of the policy tag and its descendants
Parameters
Name Description
request DeletePolicyTagRequest

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

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

DeletePolicyTagAsync(DeletePolicyTagRequest, CallSettings)

public override Task DeletePolicyTagAsync(DeletePolicyTagRequest request, CallSettings callSettings = null)

Deletes a policy tag together with the following:

  • All of its descendant policy tags, if any
  • Policies associated with the policy tag and its descendants
  • References from BigQuery table schema of the policy tag and its descendants
Parameters
Name Description
request DeletePolicyTagRequest

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

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

A Task containing the RPC response.
Overrides

DeleteTaxonomy(DeleteTaxonomyRequest, CallSettings)

public override void DeleteTaxonomy(DeleteTaxonomyRequest request, CallSettings callSettings = null)

Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.

Parameters
Name Description
request DeleteTaxonomyRequest

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

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

DeleteTaxonomyAsync(DeleteTaxonomyRequest, CallSettings)

public override Task DeleteTaxonomyAsync(DeleteTaxonomyRequest request, CallSettings callSettings = null)

Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.

Parameters
Name Description
request DeleteTaxonomyRequest

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

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

A Task containing the RPC response.
Overrides

GetIamPolicy(GetIamPolicyRequest, CallSettings)

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

Gets the IAM policy for a policy tag or a taxonomy.

Parameters
Name Description
request GetIamPolicyRequest

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

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

The RPC response.
Overrides

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

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

Gets the IAM policy for a policy tag or a taxonomy.

Parameters
Name Description
request GetIamPolicyRequest

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

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

A Task containing the RPC response.
Overrides

GetPolicyTag(GetPolicyTagRequest, CallSettings)

public override PolicyTag GetPolicyTag(GetPolicyTagRequest request, CallSettings callSettings = null)

Gets a policy tag.

Parameters
Name Description
request GetPolicyTagRequest

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

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

The RPC response.
Overrides

GetPolicyTagAsync(GetPolicyTagRequest, CallSettings)

public override Task<PolicyTag> GetPolicyTagAsync(GetPolicyTagRequest request, CallSettings callSettings = null)

Gets a policy tag.

Parameters
Name Description
request GetPolicyTagRequest

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

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

A Task containing the RPC response.
Overrides

GetTaxonomy(GetTaxonomyRequest, CallSettings)

public override Taxonomy GetTaxonomy(GetTaxonomyRequest request, CallSettings callSettings = null)

Gets a taxonomy.

Parameters
Name Description
request GetTaxonomyRequest

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

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

The RPC response.
Overrides

GetTaxonomyAsync(GetTaxonomyRequest, CallSettings)

public override Task<Taxonomy> GetTaxonomyAsync(GetTaxonomyRequest request, CallSettings callSettings = null)

Gets a taxonomy.

Parameters
Name Description
request GetTaxonomyRequest

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

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

A Task containing the RPC response.
Overrides

ListPolicyTags(ListPolicyTagsRequest, CallSettings)

public override PagedEnumerable<ListPolicyTagsResponse, PolicyTag> ListPolicyTags(ListPolicyTagsRequest request, CallSettings callSettings = null)

Lists all policy tags in a taxonomy.

Parameters
Name Description
request ListPolicyTagsRequest

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

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

A pageable sequence of PolicyTag resources.
Overrides

ListPolicyTagsAsync(ListPolicyTagsRequest, CallSettings)

public override PagedAsyncEnumerable<ListPolicyTagsResponse, PolicyTag> ListPolicyTagsAsync(ListPolicyTagsRequest request, CallSettings callSettings = null)

Lists all policy tags in a taxonomy.

Parameters
Name Description
request ListPolicyTagsRequest

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

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

A pageable asynchronous sequence of PolicyTag resources.
Overrides

ListTaxonomies(ListTaxonomiesRequest, CallSettings)

public override PagedEnumerable<ListTaxonomiesResponse, Taxonomy> ListTaxonomies(ListTaxonomiesRequest request, CallSettings callSettings = null)

Lists all taxonomies in a project in a particular location that you have a permission to view.

Parameters
Name Description
request ListTaxonomiesRequest

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

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

A pageable sequence of Taxonomy resources.
Overrides

ListTaxonomiesAsync(ListTaxonomiesRequest, CallSettings)

public override PagedAsyncEnumerable<ListTaxonomiesResponse, Taxonomy> ListTaxonomiesAsync(ListTaxonomiesRequest request, CallSettings callSettings = null)

Lists all taxonomies in a project in a particular location that you have a permission to view.

Parameters
Name Description
request ListTaxonomiesRequest

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

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

A pageable asynchronous sequence of Taxonomy resources.
Overrides

SetIamPolicy(SetIamPolicyRequest, CallSettings)

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

Sets the IAM policy for a policy tag or a taxonomy.

Parameters
Name Description
request SetIamPolicyRequest

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

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

The RPC response.
Overrides

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

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

Sets the IAM policy for a policy tag or a taxonomy.

Parameters
Name Description
request SetIamPolicyRequest

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

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

A Task containing the RPC response.
Overrides

TestIamPermissions(TestIamPermissionsRequest, CallSettings)

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

Returns your permissions on a specified policy tag or taxonomy.

Parameters
Name Description
request TestIamPermissionsRequest

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

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

The RPC response.
Overrides

TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

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

Returns your permissions on a specified policy tag or taxonomy.

Parameters
Name Description
request TestIamPermissionsRequest

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

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

A Task containing the RPC response.
Overrides

UpdatePolicyTag(UpdatePolicyTagRequest, CallSettings)

public override PolicyTag UpdatePolicyTag(UpdatePolicyTagRequest request, CallSettings callSettings = null)

Updates a policy tag, including its display name, description, and parent policy tag.

Parameters
Name Description
request UpdatePolicyTagRequest

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

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

The RPC response.
Overrides

UpdatePolicyTagAsync(UpdatePolicyTagRequest, CallSettings)

public override Task<PolicyTag> UpdatePolicyTagAsync(UpdatePolicyTagRequest request, CallSettings callSettings = null)

Updates a policy tag, including its display name, description, and parent policy tag.

Parameters
Name Description
request UpdatePolicyTagRequest

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

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

A Task containing the RPC response.
Overrides

UpdateTaxonomy(UpdateTaxonomyRequest, CallSettings)

public override Taxonomy UpdateTaxonomy(UpdateTaxonomyRequest request, CallSettings callSettings = null)

Updates a taxonomy, including its display name, description, and activated policy types.

Parameters
Name Description
request UpdateTaxonomyRequest

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

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

The RPC response.
Overrides

UpdateTaxonomyAsync(UpdateTaxonomyRequest, CallSettings)

public override Task<Taxonomy> UpdateTaxonomyAsync(UpdateTaxonomyRequest request, CallSettings callSettings = null)

Updates a taxonomy, including its display name, description, and activated policy types.

Parameters
Name Description
request UpdateTaxonomyRequest

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

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

A Task containing the RPC response.
Overrides