Cloud Resource Manager v3 API - Class TagKeys.TagKeysClient (2.4.0)

public class TagKeys.TagKeysClient : ClientBase<TagKeys.TagKeysClient>

Reference documentation and code samples for the Cloud Resource Manager v3 API class TagKeys.TagKeysClient.

Client for TagKeys

Inheritance

object > ClientBase > ClientBase TagKeys TagKeysClient > TagKeys.TagKeysClient

Inherited Members

ClientBase<TagKeys.TagKeysClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.ResourceManager.V3

Assembly

Google.Cloud.ResourceManager.V3.dll

Constructors

TagKeysClient()

protected TagKeysClient()

Protected parameterless constructor to allow creation of test doubles.

TagKeysClient(CallInvoker)

public TagKeysClient(CallInvoker callInvoker)

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

Parameter
Name	Description
`callInvoker`	`CallInvoker` The callInvoker to use to make remote calls.

TagKeysClient(ChannelBase)

public TagKeysClient(ChannelBase channel)

Creates a new client for TagKeys

Parameter
Name	Description
`channel`	`ChannelBase` The channel to use to make remote calls.

TagKeysClient(ClientBaseConfiguration)

protected TagKeysClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration` The client configuration.

Methods

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
`OperationsOperationsClient`	A new Operations client for the same target as this client.

CreateTagKey(CreateTagKeyRequest, CallOptions)

public virtual Operation CreateTagKey(CreateTagKeyRequest request, CallOptions options)

Creates a new TagKey. If another request with the same parameters is sent while the original request is in process, the second request will receive an error. A maximum of 1000 TagKeys can exist under a parent at any given time.

Parameters
Name	Description
`request`	`CreateTagKeyRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

CreateTagKey(CreateTagKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateTagKey(CreateTagKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters
Name	Description
`request`	`CreateTagKeyRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

CreateTagKeyAsync(CreateTagKeyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateTagKeyAsync(CreateTagKeyRequest request, CallOptions options)

Parameters
Name	Description
`request`	`CreateTagKeyRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

CreateTagKeyAsync(CreateTagKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateTagKeyAsync(CreateTagKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters
Name	Description
`request`	`CreateTagKeyRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

DeleteTagKey(DeleteTagKeyRequest, CallOptions)

public virtual Operation DeleteTagKey(DeleteTagKeyRequest request, CallOptions options)

Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.

Parameters
Name	Description
`request`	`DeleteTagKeyRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

DeleteTagKey(DeleteTagKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteTagKey(DeleteTagKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.

Parameters
Name	Description
`request`	`DeleteTagKeyRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

DeleteTagKeyAsync(DeleteTagKeyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteTagKeyAsync(DeleteTagKeyRequest request, CallOptions options)

Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.

Parameters
Name	Description
`request`	`DeleteTagKeyRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

DeleteTagKeyAsync(DeleteTagKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteTagKeyAsync(DeleteTagKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.

Parameters
Name	Description
`request`	`DeleteTagKeyRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

GetIamPolicy(GetIamPolicyRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallOptions options)

Gets the access control policy for a TagKey. The returned policy may be empty if no such policy or resource exists. The resource field should be the TagKey's resource name. For example, "tagKeys/1234". The caller must have cloudresourcemanager.googleapis.com/tagKeys.getIamPolicy permission on the specified TagKey.

Parameters
Name	Description
`request`	`GetIamPolicyRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Policy`	The response received from the server.

GetIamPolicy(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Parameters
Name	Description
`request`	`GetIamPolicyRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Policy`	The response received from the server.

GetIamPolicyAsync(GetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallOptions options)

Parameters
Name	Description
`request`	`GetIamPolicyRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallPolicy`	The call object.

GetIamPolicyAsync(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Parameters
Name	Description
`request`	`GetIamPolicyRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallPolicy`	The call object.

GetNamespacedTagKey(GetNamespacedTagKeyRequest, CallOptions)

public virtual TagKey GetNamespacedTagKey(GetNamespacedTagKeyRequest request, CallOptions options)

Retrieves a TagKey by its namespaced name. This method will return PERMISSION_DENIED if the key does not exist or the user does not have permission to view it.

Parameters
Name	Description
`request`	`GetNamespacedTagKeyRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`TagKey`	The response received from the server.

GetNamespacedTagKey(GetNamespacedTagKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual TagKey GetNamespacedTagKey(GetNamespacedTagKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a TagKey by its namespaced name. This method will return PERMISSION_DENIED if the key does not exist or the user does not have permission to view it.

Parameters
Name	Description
`request`	`GetNamespacedTagKeyRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`TagKey`	The response received from the server.

GetNamespacedTagKeyAsync(GetNamespacedTagKeyRequest, CallOptions)

public virtual AsyncUnaryCall<TagKey> GetNamespacedTagKeyAsync(GetNamespacedTagKeyRequest request, CallOptions options)

Retrieves a TagKey by its namespaced name. This method will return PERMISSION_DENIED if the key does not exist or the user does not have permission to view it.

Parameters
Name	Description
`request`	`GetNamespacedTagKeyRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallTagKey`	The call object.

GetNamespacedTagKeyAsync(GetNamespacedTagKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TagKey> GetNamespacedTagKeyAsync(GetNamespacedTagKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a TagKey by its namespaced name. This method will return PERMISSION_DENIED if the key does not exist or the user does not have permission to view it.

Parameters
Name	Description
`request`	`GetNamespacedTagKeyRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallTagKey`	The call object.

GetTagKey(GetTagKeyRequest, CallOptions)

public virtual TagKey GetTagKey(GetTagKeyRequest request, CallOptions options)

Retrieves a TagKey. This method will return PERMISSION_DENIED if the key does not exist or the user does not have permission to view it.

Parameters
Name	Description
`request`	`GetTagKeyRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`TagKey`	The response received from the server.

GetTagKey(GetTagKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual TagKey GetTagKey(GetTagKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a TagKey. This method will return PERMISSION_DENIED if the key does not exist or the user does not have permission to view it.

Parameters
Name	Description
`request`	`GetTagKeyRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`TagKey`	The response received from the server.

GetTagKeyAsync(GetTagKeyRequest, CallOptions)

public virtual AsyncUnaryCall<TagKey> GetTagKeyAsync(GetTagKeyRequest request, CallOptions options)

Retrieves a TagKey. This method will return PERMISSION_DENIED if the key does not exist or the user does not have permission to view it.

Parameters
Name	Description
`request`	`GetTagKeyRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallTagKey`	The call object.

GetTagKeyAsync(GetTagKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TagKey> GetTagKeyAsync(GetTagKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a TagKey. This method will return PERMISSION_DENIED if the key does not exist or the user does not have permission to view it.

Parameters
Name	Description
`request`	`GetTagKeyRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallTagKey`	The call object.

ListTagKeys(ListTagKeysRequest, CallOptions)

public virtual ListTagKeysResponse ListTagKeys(ListTagKeysRequest request, CallOptions options)

Lists all TagKeys for a parent resource.

Parameters
Name	Description
`request`	`ListTagKeysRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListTagKeysResponse`	The response received from the server.

ListTagKeys(ListTagKeysRequest, Metadata, DateTime?, CancellationToken)

public virtual ListTagKeysResponse ListTagKeys(ListTagKeysRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all TagKeys for a parent resource.

Parameters
Name	Description
`request`	`ListTagKeysRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ListTagKeysResponse`	The response received from the server.

ListTagKeysAsync(ListTagKeysRequest, CallOptions)

public virtual AsyncUnaryCall<ListTagKeysResponse> ListTagKeysAsync(ListTagKeysRequest request, CallOptions options)

Lists all TagKeys for a parent resource.

Parameters
Name	Description
`request`	`ListTagKeysRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallListTagKeysResponse`	The call object.

ListTagKeysAsync(ListTagKeysRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListTagKeysResponse> ListTagKeysAsync(ListTagKeysRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all TagKeys for a parent resource.

Parameters
Name	Description
`request`	`ListTagKeysRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallListTagKeysResponse`	The call object.

NewInstance(ClientBaseConfiguration)

protected override TagKeys.TagKeysClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration`

Returns
Type	Description
`TagKeysTagKeysClient`

Overrides

ClientBase<TagKeys.TagKeysClient>.NewInstance(ClientBase.ClientBaseConfiguration)

SetIamPolicy(SetIamPolicyRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallOptions options)

Sets the access control policy on a TagKey, replacing any existing policy. The resource field should be the TagKey's resource name. For example, "tagKeys/1234". The caller must have resourcemanager.tagKeys.setIamPolicy permission on the identified tagValue.

Parameters
Name	Description
`request`	`SetIamPolicyRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Policy`	The response received from the server.

SetIamPolicy(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Parameters
Name	Description
`request`	`SetIamPolicyRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Policy`	The response received from the server.

SetIamPolicyAsync(SetIamPolicyRequest, CallOptions)

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

Parameters
Name	Description
`request`	`SetIamPolicyRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallPolicy`	The call object.

SetIamPolicyAsync(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Parameters
Name	Description
`request`	`SetIamPolicyRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallPolicy`	The call object.

TestIamPermissions(TestIamPermissionsRequest, CallOptions)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallOptions options)

Returns permissions that a caller has on the specified TagKey. The resource field should be the TagKey's resource name. For example, "tagKeys/1234".

There are no permissions required for making this API call.

Parameters
Name	Description
`request`	`TestIamPermissionsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`TestIamPermissionsResponse`	The response received from the server.

TestIamPermissions(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)

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

Returns permissions that a caller has on the specified TagKey. The resource field should be the TagKey's resource name. For example, "tagKeys/1234".

There are no permissions required for making this API call.

Parameters
Name	Description
`request`	`TestIamPermissionsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`TestIamPermissionsResponse`	The response received from the server.

TestIamPermissionsAsync(TestIamPermissionsRequest, CallOptions)

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

Returns permissions that a caller has on the specified TagKey. The resource field should be the TagKey's resource name. For example, "tagKeys/1234".

There are no permissions required for making this API call.

Parameters
Name	Description
`request`	`TestIamPermissionsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallTestIamPermissionsResponse`	The call object.

TestIamPermissionsAsync(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)

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

Returns permissions that a caller has on the specified TagKey. The resource field should be the TagKey's resource name. For example, "tagKeys/1234".

There are no permissions required for making this API call.

Parameters
Name	Description
`request`	`TestIamPermissionsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallTestIamPermissionsResponse`	The call object.

UpdateTagKey(UpdateTagKeyRequest, CallOptions)

public virtual Operation UpdateTagKey(UpdateTagKeyRequest request, CallOptions options)

Updates the attributes of the TagKey resource.

Parameters
Name	Description
`request`	`UpdateTagKeyRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

UpdateTagKey(UpdateTagKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateTagKey(UpdateTagKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the attributes of the TagKey resource.

Parameters
Name	Description
`request`	`UpdateTagKeyRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

UpdateTagKeyAsync(UpdateTagKeyRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateTagKeyAsync(UpdateTagKeyRequest request, CallOptions options)

Updates the attributes of the TagKey resource.

Parameters
Name	Description
`request`	`UpdateTagKeyRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

UpdateTagKeyAsync(UpdateTagKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateTagKeyAsync(UpdateTagKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the attributes of the TagKey resource.

Parameters
Name	Description
`request`	`UpdateTagKeyRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.