public sealed class TagValuesClientImpl : TagValuesClient
Reference documentation and code samples for the Cloud Resource Manager v3 API class TagValuesClientImpl.
TagValues client wrapper implementation, for convenient use.
Namespace
Google.Cloud.ResourceManager.V3Assembly
Google.Cloud.ResourceManager.V3.dll
Remarks
Allow users to create and manage tag values.
Constructors
TagValuesClientImpl(TagValuesClient, TagValuesSettings, ILogger)
public TagValuesClientImpl(TagValues.TagValuesClient grpcClient, TagValuesSettings settings, ILogger logger)
Constructs a client wrapper for the TagValues service, with the specified gRPC client and settings.
Parameters | |
---|---|
Name | Description |
grpcClient | TagValuesTagValuesClient The underlying gRPC client. |
settings | TagValuesSettings The base TagValuesSettings used within this client. |
logger | ILogger Optional ILogger to use within this client. |
Properties
CreateTagValueOperationsClient
public override OperationsClient CreateTagValueOperationsClient { get; }
The long-running operations client for CreateTagValue
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteTagValueOperationsClient
public override OperationsClient DeleteTagValueOperationsClient { get; }
The long-running operations client for DeleteTagValue
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public override TagValues.TagValuesClient GrpcClient { get; }
The underlying gRPC TagValues client
Property Value | |
---|---|
Type | Description |
TagValuesTagValuesClient |
UpdateTagValueOperationsClient
public override OperationsClient UpdateTagValueOperationsClient { get; }
The long-running operations client for UpdateTagValue
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
Methods
CreateTagValue(CreateTagValueRequest, CallSettings)
public override Operation<TagValue, CreateTagValueMetadata> CreateTagValue(CreateTagValueRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
OperationTagValueCreateTagValueMetadata | The RPC response. |
CreateTagValueAsync(CreateTagValueRequest, CallSettings)
public override Task<Operation<TagValue, CreateTagValueMetadata>> CreateTagValueAsync(CreateTagValueRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskOperationTagValueCreateTagValueMetadata | A Task containing the RPC response. |
DeleteTagValue(DeleteTagValueRequest, CallSettings)
public override Operation<TagValue, DeleteTagValueMetadata> DeleteTagValue(DeleteTagValueRequest request, CallSettings callSettings = null)
Deletes a TagValue. The TagValue cannot have any bindings when it is deleted.
Parameters | |
---|---|
Name | Description |
request | DeleteTagValueRequest 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 |
OperationTagValueDeleteTagValueMetadata | The RPC response. |
DeleteTagValueAsync(DeleteTagValueRequest, CallSettings)
public override Task<Operation<TagValue, DeleteTagValueMetadata>> DeleteTagValueAsync(DeleteTagValueRequest request, CallSettings callSettings = null)
Deletes a TagValue. The TagValue cannot have any bindings when it is deleted.
Parameters | |
---|---|
Name | Description |
request | DeleteTagValueRequest 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 |
TaskOperationTagValueDeleteTagValueMetadata | A Task containing the RPC response. |
GetIamPolicy(GetIamPolicyRequest, CallSettings)
public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)
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 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. |
GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)
public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)
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 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. |
GetNamespacedTagValue(GetNamespacedTagValueRequest, CallSettings)
public override TagValue GetNamespacedTagValue(GetNamespacedTagValueRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagValue | The RPC response. |
GetNamespacedTagValueAsync(GetNamespacedTagValueRequest, CallSettings)
public override Task<TagValue> GetNamespacedTagValueAsync(GetNamespacedTagValueRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagValue | A Task containing the RPC response. |
GetTagValue(GetTagValueRequest, CallSettings)
public override TagValue GetTagValue(GetTagValueRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TagValue | The RPC response. |
GetTagValueAsync(GetTagValueRequest, CallSettings)
public override Task<TagValue> GetTagValueAsync(GetTagValueRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTagValue | A Task containing the RPC response. |
ListTagValues(ListTagValuesRequest, CallSettings)
public override PagedEnumerable<ListTagValuesResponse, TagValue> ListTagValues(ListTagValuesRequest request, CallSettings callSettings = null)
Lists all TagValues for a specific TagKey.
Parameters | |
---|---|
Name | Description |
request | ListTagValuesRequest 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 |
PagedEnumerableListTagValuesResponseTagValue | A pageable sequence of TagValue resources. |
ListTagValuesAsync(ListTagValuesRequest, CallSettings)
public override PagedAsyncEnumerable<ListTagValuesResponse, TagValue> ListTagValuesAsync(ListTagValuesRequest request, CallSettings callSettings = null)
Lists all TagValues for a specific TagKey.
Parameters | |
---|---|
Name | Description |
request | ListTagValuesRequest 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 |
PagedAsyncEnumerableListTagValuesResponseTagValue | A pageable asynchronous sequence of TagValue resources. |
SetIamPolicy(SetIamPolicyRequest, CallSettings)
public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)
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 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. |
SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)
public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)
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 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. |
TestIamPermissions(TestIamPermissionsRequest, CallSettings)
public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)
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 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. |
TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)
public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)
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 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. |
UpdateTagValue(UpdateTagValueRequest, CallSettings)
public override Operation<TagValue, UpdateTagValueMetadata> UpdateTagValue(UpdateTagValueRequest request, CallSettings callSettings = null)
Updates the attributes of the TagValue resource.
Parameters | |
---|---|
Name | Description |
request | UpdateTagValueRequest 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 |
OperationTagValueUpdateTagValueMetadata | The RPC response. |
UpdateTagValueAsync(UpdateTagValueRequest, CallSettings)
public override Task<Operation<TagValue, UpdateTagValueMetadata>> UpdateTagValueAsync(UpdateTagValueRequest request, CallSettings callSettings = null)
Updates the attributes of the TagValue resource.
Parameters | |
---|---|
Name | Description |
request | UpdateTagValueRequest 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 |
TaskOperationTagValueUpdateTagValueMetadata | A Task containing the RPC response. |