public sealed class TagKeysClientImpl : TagKeysClientTagKeys client wrapper implementation, for convenient use.
Namespace
Google.Cloud.ResourceManager.V3Assembly
Google.Cloud.ResourceManager.V3.dll
Remarks
Allow users to create and manage tag keys.
Constructors
TagKeysClientImpl(TagKeys.TagKeysClient, TagKeysSettings)
public TagKeysClientImpl(TagKeys.TagKeysClient grpcClient, TagKeysSettings settings)Constructs a client wrapper for the TagKeys service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient |
TagKeys.TagKeysClientThe underlying gRPC client. |
settings |
TagKeysSettingsThe base TagKeysSettings used within this client. |
Properties
CreateTagKeyOperationsClient
public override OperationsClient CreateTagKeyOperationsClient { get; }The long-running operations client for CreateTagKey.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
DeleteTagKeyOperationsClient
public override OperationsClient DeleteTagKeyOperationsClient { get; }The long-running operations client for DeleteTagKey.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
GrpcClient
public override TagKeys.TagKeysClient GrpcClient { get; }The underlying gRPC TagKeys client
| Property Value | |
|---|---|
| Type | Description |
TagKeys.TagKeysClient |
|
UpdateTagKeyOperationsClient
public override OperationsClient UpdateTagKeyOperationsClient { get; }The long-running operations client for UpdateTagKey.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient |
|
Methods
CreateTagKey(CreateTagKeyRequest, CallSettings)
public override Operation<TagKey, CreateTagKeyMetadata> CreateTagKey(CreateTagKeyRequest request, CallSettings callSettings = null)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 300 TagKeys can exist under a parent at any given time.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateTagKeyRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<TagKey, CreateTagKeyMetadata> |
The RPC response. |
CreateTagKeyAsync(CreateTagKeyRequest, CallSettings)
public override Task<Operation<TagKey, CreateTagKeyMetadata>> CreateTagKeyAsync(CreateTagKeyRequest request, CallSettings callSettings = null)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 300 TagKeys can exist under a parent at any given time.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateTagKeyRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<TagKey, CreateTagKeyMetadata>> |
A Task containing the RPC response. |
DeleteTagKey(DeleteTagKeyRequest, CallSettings)
public override Operation<TagKey, DeleteTagKeyMetadata> DeleteTagKey(DeleteTagKeyRequest request, CallSettings callSettings = null)Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteTagKeyRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<TagKey, DeleteTagKeyMetadata> |
The RPC response. |
DeleteTagKeyAsync(DeleteTagKeyRequest, CallSettings)
public override Task<Operation<TagKey, DeleteTagKeyMetadata>> DeleteTagKeyAsync(DeleteTagKeyRequest request, CallSettings callSettings = null)Deletes a TagKey. The TagKey cannot be deleted if it has any child TagValues.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteTagKeyRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<TagKey, DeleteTagKeyMetadata>> |
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 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 |
GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf 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 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 |
GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Policy> |
A Task containing the RPC response. |
GetTagKey(GetTagKeyRequest, CallSettings)
public override TagKey GetTagKey(GetTagKeyRequest request, CallSettings callSettings = null)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 |
GetTagKeyRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TagKey |
The RPC response. |
GetTagKeyAsync(GetTagKeyRequest, CallSettings)
public override Task<TagKey> GetTagKeyAsync(GetTagKeyRequest request, CallSettings callSettings = null)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 |
GetTagKeyRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<TagKey> |
A Task containing the RPC response. |
ListTagKeys(ListTagKeysRequest, CallSettings)
public override PagedEnumerable<ListTagKeysResponse, TagKey> ListTagKeys(ListTagKeysRequest request, CallSettings callSettings = null)Lists all TagKeys for a parent resource.
| Parameters | |
|---|---|
| Name | Description |
request |
ListTagKeysRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListTagKeysResponse, TagKey> |
A pageable sequence of TagKey resources. |
ListTagKeysAsync(ListTagKeysRequest, CallSettings)
public override PagedAsyncEnumerable<ListTagKeysResponse, TagKey> ListTagKeysAsync(ListTagKeysRequest request, CallSettings callSettings = null)Lists all TagKeys for a parent resource.
| Parameters | |
|---|---|
| Name | Description |
request |
ListTagKeysRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListTagKeysResponse, TagKey> |
A pageable asynchronous sequence of TagKey resources. |
SetIamPolicy(SetIamPolicyRequest, CallSettings)
public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)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 |
SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf 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 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 |
SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Policy> |
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 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 |
TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf 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 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 |
TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<TestIamPermissionsResponse> |
A Task containing the RPC response. |
UpdateTagKey(UpdateTagKeyRequest, CallSettings)
public override Operation<TagKey, UpdateTagKeyMetadata> UpdateTagKey(UpdateTagKeyRequest request, CallSettings callSettings = null)Updates the attributes of the TagKey resource.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateTagKeyRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<TagKey, UpdateTagKeyMetadata> |
The RPC response. |
UpdateTagKeyAsync(UpdateTagKeyRequest, CallSettings)
public override Task<Operation<TagKey, UpdateTagKeyMetadata>> UpdateTagKeyAsync(UpdateTagKeyRequest request, CallSettings callSettings = null)Updates the attributes of the TagKey resource.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateTagKeyRequestThe request object containing all of the parameters for the API call. |
callSettings |
CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<TagKey, UpdateTagKeyMetadata>> |
A Task containing the RPC response. |