Class PolicyTagManagerClientImpl (1.2.0)

public sealed class PolicyTagManagerClientImpl : PolicyTagManagerClient

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 clients to manage their 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(PolicyTagManager.PolicyTagManagerClient, PolicyTagManagerSettings)

public PolicyTagManagerClientImpl(PolicyTagManager.PolicyTagManagerClient grpcClient, PolicyTagManagerSettings settings)

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

Parameters
NameDescription
grpcClientPolicyTagManager.PolicyTagManagerClient

The underlying gRPC client.

settingsPolicyTagManagerSettings

The base PolicyTagManagerSettings used within this client.

Properties

GrpcClient

public override PolicyTagManager.PolicyTagManagerClient GrpcClient { get; }

The underlying gRPC PolicyTagManager client

Property Value
TypeDescription
PolicyTagManager.PolicyTagManagerClient
Overrides

Methods

CreatePolicyTag(CreatePolicyTagRequest, CallSettings)

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

Creates a policy tag in a taxonomy.

Parameters
NameDescription
requestCreatePolicyTagRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PolicyTag>

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, i.e., does not contain policy tags.

Parameters
NameDescription
requestCreateTaxonomyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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, i.e., does not contain policy tags.

Parameters
NameDescription
requestCreateTaxonomyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Taxonomy>

A Task containing the RPC response.

Overrides

DeletePolicyTag(DeletePolicyTagRequest, CallSettings)

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

Deletes a policy tag. This method also deletes:

  • all of its descendant policy tags, if any
  • the policies associated with the policy tag and its descendants
  • references from BigQuery table schema of the policy tag and its descendants.
Parameters
NameDescription
requestDeletePolicyTagRequest

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

callSettingsCallSettings

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. This method also deletes:

  • all of its descendant policy tags, if any
  • the policies associated with the policy tag and its descendants
  • references from BigQuery table schema of the policy tag and its descendants.
Parameters
NameDescription
requestDeletePolicyTagRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

DeleteTaxonomy(DeleteTaxonomyRequest, CallSettings)

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

Deletes a taxonomy. This method will also delete all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.

Parameters
NameDescription
requestDeleteTaxonomyRequest

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

callSettingsCallSettings

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. This method will also delete all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.

Parameters
NameDescription
requestDeleteTaxonomyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestGoogle.Cloud.Iam.V1.GetIamPolicyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.Cloud.Iam.V1.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
NameDescription
requestGoogle.Cloud.Iam.V1.GetIamPolicyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

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

A Task containing the RPC response.

Overrides

GetPolicyTag(GetPolicyTagRequest, CallSettings)

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

Gets a policy tag.

Parameters
NameDescription
requestGetPolicyTagRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PolicyTag

The RPC response.

Overrides

GetPolicyTagAsync(GetPolicyTagRequest, CallSettings)

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

Gets a policy tag.

Parameters
NameDescription
requestGetPolicyTagRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PolicyTag>

A Task containing the RPC response.

Overrides

GetTaxonomy(GetTaxonomyRequest, CallSettings)

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

Gets a taxonomy.

Parameters
NameDescription
requestGetTaxonomyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Taxonomy

The RPC response.

Overrides

GetTaxonomyAsync(GetTaxonomyRequest, CallSettings)

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

Gets a taxonomy.

Parameters
NameDescription
requestGetTaxonomyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Taxonomy>

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListPolicyTagsResponse, PolicyTag>

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

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListPolicyTagsResponse, PolicyTag>

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 the caller has permission to view.

Parameters
NameDescription
requestListTaxonomiesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListTaxonomiesResponse, Taxonomy>

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 the caller has permission to view.

Parameters
NameDescription
requestListTaxonomiesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListTaxonomiesResponse, Taxonomy>

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
NameDescription
requestGoogle.Cloud.Iam.V1.SetIamPolicyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.Cloud.Iam.V1.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
NameDescription
requestGoogle.Cloud.Iam.V1.SetIamPolicyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

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

A Task containing the RPC response.

Overrides

TestIamPermissions(TestIamPermissionsRequest, CallSettings)

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

Returns the permissions that a caller has on a specified policy tag or taxonomy.

Parameters
NameDescription
requestGoogle.Cloud.Iam.V1.TestIamPermissionsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Google.Cloud.Iam.V1.TestIamPermissionsResponse

The RPC response.

Overrides

TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

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

Returns the permissions that a caller has on a specified policy tag or taxonomy.

Parameters
NameDescription
requestGoogle.Cloud.Iam.V1.TestIamPermissionsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

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

A Task containing the RPC response.

Overrides

UpdatePolicyTag(UpdatePolicyTagRequest, CallSettings)

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

Updates a policy tag. This method can update the policy tag's display name, description, and parent policy tag.

Parameters
NameDescription
requestUpdatePolicyTagRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PolicyTag

The RPC response.

Overrides

UpdatePolicyTagAsync(UpdatePolicyTagRequest, CallSettings)

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

Updates a policy tag. This method can update the policy tag's display name, description, and parent policy tag.

Parameters
NameDescription
requestUpdatePolicyTagRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PolicyTag>

A Task containing the RPC response.

Overrides

UpdateTaxonomy(UpdateTaxonomyRequest, CallSettings)

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

Updates a taxonomy. This method can update the taxonomy's display name, description, and activated policy types.

Parameters
NameDescription
requestUpdateTaxonomyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Taxonomy

The RPC response.

Overrides

UpdateTaxonomyAsync(UpdateTaxonomyRequest, CallSettings)

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

Updates a taxonomy. This method can update the taxonomy's display name, description, and activated policy types.

Parameters
NameDescription
requestUpdateTaxonomyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Taxonomy>

A Task containing the RPC response.

Overrides