Cloud Resource Manager v3 API - Class TagValues.TagValuesClient (2.5.0) 

public class TagValues.TagValuesClient : ClientBase<TagValues.TagValuesClient>

Reference documentation and code samples for the Cloud Resource Manager v3 API class TagValues.TagValuesClient.

Client for TagValues

Inheritance

object > ClientBase > ClientBaseTagValuesTagValuesClient > TagValues.TagValuesClient

Namespace

Google.Cloud.ResourceManager.V3

Assembly

Google.Cloud.ResourceManager.V3.dll

Constructors

TagValuesClient()

protected TagValuesClient()

Protected parameterless constructor to allow creation of test doubles.

TagValuesClient(CallInvoker)

public TagValuesClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

TagValuesClient(ChannelBase)

public TagValuesClient(ChannelBase channel)

Creates a new client for TagValues

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

TagValuesClient(ClientBaseConfiguration)

protected TagValuesClient(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.

CreateTagValue(CreateTagValueRequest, CallOptions)

public virtual Operation CreateTagValue(CreateTagValueRequest request, CallOptions options)

Creates a TagValue as a child of the specified TagKey. If a 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 TagValues can exist under a TagKey at any given time.

Parameters
Name Description
request CreateTagValueRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

CreateTagValue(CreateTagValueRequest, Metadata, DateTime?, CancellationToken)

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

Creates a TagValue as a child of the specified TagKey. If a 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 TagValues can exist under a TagKey at any given time.

Parameters
Name Description
request CreateTagValueRequest

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.

CreateTagValueAsync(CreateTagValueRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateTagValueAsync(CreateTagValueRequest request, CallOptions options)

Creates a TagValue as a child of the specified TagKey. If a 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 TagValues can exist under a TagKey at any given time.

Parameters
Name Description
request CreateTagValueRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateTagValueAsync(CreateTagValueRequest, Metadata, DateTime?, CancellationToken)

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

Creates a TagValue as a child of the specified TagKey. If a 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 TagValues can exist under a TagKey at any given time.

Parameters
Name Description
request CreateTagValueRequest

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.

DeleteTagValue(DeleteTagValueRequest, CallOptions)

public virtual Operation DeleteTagValue(DeleteTagValueRequest request, CallOptions options)

Deletes a TagValue. The TagValue cannot have any bindings when it is deleted.

Parameters
Name Description
request DeleteTagValueRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

DeleteTagValue(DeleteTagValueRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a TagValue. The TagValue cannot have any bindings when it is deleted.

Parameters
Name Description
request DeleteTagValueRequest

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.

DeleteTagValueAsync(DeleteTagValueRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteTagValueAsync(DeleteTagValueRequest request, CallOptions options)

Deletes a TagValue. The TagValue cannot have any bindings when it is deleted.

Parameters
Name Description
request DeleteTagValueRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteTagValueAsync(DeleteTagValueRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a TagValue. The TagValue cannot have any bindings when it is deleted.

Parameters
Name Description
request DeleteTagValueRequest

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 TagValue. The returned policy may be empty if no such policy or resource exists. The resource field should be the TagValue's resource name. For example: tagValues/1234. The caller must have the cloudresourcemanager.googleapis.com/tagValues.getIamPolicy permission on the identified TagValue to get the access control policy.

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)

Gets the access control policy for a TagValue. The returned policy may be empty if no such policy or resource exists. The resource field should be the TagValue's resource name. For example: tagValues/1234. The caller must have the cloudresourcemanager.googleapis.com/tagValues.getIamPolicy permission on the identified TagValue to get the access control policy.

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)

Gets the access control policy for a TagValue. The returned policy may be empty if no such policy or resource exists. The resource field should be the TagValue's resource name. For example: tagValues/1234. The caller must have the cloudresourcemanager.googleapis.com/tagValues.getIamPolicy permission on the identified TagValue to get the access control policy.

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)

Gets the access control policy for a TagValue. The returned policy may be empty if no such policy or resource exists. The resource field should be the TagValue's resource name. For example: tagValues/1234. The caller must have the cloudresourcemanager.googleapis.com/tagValues.getIamPolicy permission on the identified TagValue to get the access control policy.

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.

GetNamespacedTagValue(GetNamespacedTagValueRequest, CallOptions)

public virtual TagValue GetNamespacedTagValue(GetNamespacedTagValueRequest request, CallOptions options)

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

Parameters
Name Description
request GetNamespacedTagValueRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
TagValue

The response received from the server.

GetNamespacedTagValue(GetNamespacedTagValueRequest, Metadata, DateTime?, CancellationToken)

public virtual TagValue GetNamespacedTagValue(GetNamespacedTagValueRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetNamespacedTagValueRequest

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
TagValue

The response received from the server.

GetNamespacedTagValueAsync(GetNamespacedTagValueRequest, CallOptions)

public virtual AsyncUnaryCall<TagValue> GetNamespacedTagValueAsync(GetNamespacedTagValueRequest request, CallOptions options)

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

Parameters
Name Description
request GetNamespacedTagValueRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallTagValue

The call object.

GetNamespacedTagValueAsync(GetNamespacedTagValueRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TagValue> GetNamespacedTagValueAsync(GetNamespacedTagValueRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetNamespacedTagValueRequest

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
AsyncUnaryCallTagValue

The call object.

GetTagValue(GetTagValueRequest, CallOptions)

public virtual TagValue GetTagValue(GetTagValueRequest request, CallOptions options)

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

Parameters
Name Description
request GetTagValueRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
TagValue

The response received from the server.

GetTagValue(GetTagValueRequest, Metadata, DateTime?, CancellationToken)

public virtual TagValue GetTagValue(GetTagValueRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetTagValueRequest

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
TagValue

The response received from the server.

GetTagValueAsync(GetTagValueRequest, CallOptions)

public virtual AsyncUnaryCall<TagValue> GetTagValueAsync(GetTagValueRequest request, CallOptions options)

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

Parameters
Name Description
request GetTagValueRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallTagValue

The call object.

GetTagValueAsync(GetTagValueRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TagValue> GetTagValueAsync(GetTagValueRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetTagValueRequest

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
AsyncUnaryCallTagValue

The call object.

ListTagValues(ListTagValuesRequest, CallOptions)

public virtual ListTagValuesResponse ListTagValues(ListTagValuesRequest request, CallOptions options)

Lists all TagValues for a specific TagKey.

Parameters
Name Description
request ListTagValuesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListTagValuesResponse

The response received from the server.

ListTagValues(ListTagValuesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListTagValuesResponse ListTagValues(ListTagValuesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all TagValues for a specific TagKey.

Parameters
Name Description
request ListTagValuesRequest

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
ListTagValuesResponse

The response received from the server.

ListTagValuesAsync(ListTagValuesRequest, CallOptions)

public virtual AsyncUnaryCall<ListTagValuesResponse> ListTagValuesAsync(ListTagValuesRequest request, CallOptions options)

Lists all TagValues for a specific TagKey.

Parameters
Name Description
request ListTagValuesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListTagValuesResponse

The call object.

ListTagValuesAsync(ListTagValuesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListTagValuesResponse> ListTagValuesAsync(ListTagValuesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all TagValues for a specific TagKey.

Parameters
Name Description
request ListTagValuesRequest

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
AsyncUnaryCallListTagValuesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override TagValues.TagValuesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
TagValuesTagValuesClient
Overrides

SetIamPolicy(SetIamPolicyRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallOptions options)

Sets the access control policy on a TagValue, replacing any existing policy. The resource field should be the TagValue's resource name. For example: tagValues/1234. The caller must have resourcemanager.tagValues.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)

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

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)

Sets the access control policy on a TagValue, replacing any existing policy. The resource field should be the TagValue's resource name. For example: tagValues/1234. The caller must have resourcemanager.tagValues.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
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)

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

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 TagValue. The resource field should be the TagValue's resource name. For example: tagValues/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 TagValue. The resource field should be the TagValue's resource name. For example: tagValues/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 TagValue. The resource field should be the TagValue's resource name. For example: tagValues/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 TagValue. The resource field should be the TagValue's resource name. For example: tagValues/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.

UpdateTagValue(UpdateTagValueRequest, CallOptions)

public virtual Operation UpdateTagValue(UpdateTagValueRequest request, CallOptions options)

Updates the attributes of the TagValue resource.

Parameters
Name Description
request UpdateTagValueRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

UpdateTagValue(UpdateTagValueRequest, Metadata, DateTime?, CancellationToken)

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

Updates the attributes of the TagValue resource.

Parameters
Name Description
request UpdateTagValueRequest

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.

UpdateTagValueAsync(UpdateTagValueRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateTagValueAsync(UpdateTagValueRequest request, CallOptions options)

Updates the attributes of the TagValue resource.

Parameters
Name Description
request UpdateTagValueRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateTagValueAsync(UpdateTagValueRequest, Metadata, DateTime?, CancellationToken)

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

Updates the attributes of the TagValue resource.

Parameters
Name Description
request UpdateTagValueRequest

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.