Cloud Resource Manager v3 API - Class TagKeysClientImpl (2.5.0)

Version latest

• 2.5.0 (latest)
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class TagKeysClientImpl : TagKeysClient

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

TagKeys client wrapper implementation, for convenient use.

Inheritance

object > TagKeysClient > TagKeysClientImpl

Inherited Members

TagKeysClient.DefaultEndpoint

TagKeysClient.DefaultScopes

TagKeysClient.ServiceMetadata

TagKeysClient.CreateAsync(CancellationToken)

TagKeysClient.Create()

TagKeysClient.ShutdownDefaultChannelsAsync()

TagKeysClient.ListTagKeys(string, string, int?, CallSettings)

TagKeysClient.ListTagKeysAsync(string, string, int?, CallSettings)

TagKeysClient.ListTagKeys(IResourceName, string, int?, CallSettings)

TagKeysClient.ListTagKeysAsync(IResourceName, string, int?, CallSettings)

TagKeysClient.GetTagKeyAsync(GetTagKeyRequest, CancellationToken)

TagKeysClient.GetTagKey(string, CallSettings)

TagKeysClient.GetTagKeyAsync(string, CallSettings)

TagKeysClient.GetTagKeyAsync(string, CancellationToken)

TagKeysClient.GetTagKey(TagKeyName, CallSettings)

TagKeysClient.GetTagKeyAsync(TagKeyName, CallSettings)

TagKeysClient.GetTagKeyAsync(TagKeyName, CancellationToken)

TagKeysClient.GetNamespacedTagKeyAsync(GetNamespacedTagKeyRequest, CancellationToken)

TagKeysClient.GetNamespacedTagKey(string, CallSettings)

TagKeysClient.GetNamespacedTagKeyAsync(string, CallSettings)

TagKeysClient.GetNamespacedTagKeyAsync(string, CancellationToken)

TagKeysClient.GetNamespacedTagKey(TagKeyName, CallSettings)

TagKeysClient.GetNamespacedTagKeyAsync(TagKeyName, CallSettings)

TagKeysClient.GetNamespacedTagKeyAsync(TagKeyName, CancellationToken)

TagKeysClient.CreateTagKeyAsync(CreateTagKeyRequest, CancellationToken)

TagKeysClient.PollOnceCreateTagKey(string, CallSettings)

TagKeysClient.PollOnceCreateTagKeyAsync(string, CallSettings)

TagKeysClient.CreateTagKey(TagKey, CallSettings)

TagKeysClient.CreateTagKeyAsync(TagKey, CallSettings)

TagKeysClient.CreateTagKeyAsync(TagKey, CancellationToken)

TagKeysClient.UpdateTagKeyAsync(UpdateTagKeyRequest, CancellationToken)

TagKeysClient.PollOnceUpdateTagKey(string, CallSettings)

TagKeysClient.PollOnceUpdateTagKeyAsync(string, CallSettings)

TagKeysClient.UpdateTagKey(TagKey, FieldMask, CallSettings)

TagKeysClient.UpdateTagKeyAsync(TagKey, FieldMask, CallSettings)

TagKeysClient.UpdateTagKeyAsync(TagKey, FieldMask, CancellationToken)

TagKeysClient.DeleteTagKeyAsync(DeleteTagKeyRequest, CancellationToken)

TagKeysClient.PollOnceDeleteTagKey(string, CallSettings)

TagKeysClient.PollOnceDeleteTagKeyAsync(string, CallSettings)

TagKeysClient.DeleteTagKey(string, CallSettings)

TagKeysClient.DeleteTagKeyAsync(string, CallSettings)

TagKeysClient.DeleteTagKeyAsync(string, CancellationToken)

TagKeysClient.DeleteTagKey(TagKeyName, CallSettings)

TagKeysClient.DeleteTagKeyAsync(TagKeyName, CallSettings)

TagKeysClient.DeleteTagKeyAsync(TagKeyName, CancellationToken)

TagKeysClient.GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)

TagKeysClient.GetIamPolicy(string, CallSettings)

TagKeysClient.GetIamPolicyAsync(string, CallSettings)

TagKeysClient.GetIamPolicyAsync(string, CancellationToken)

TagKeysClient.GetIamPolicy(IResourceName, CallSettings)

TagKeysClient.GetIamPolicyAsync(IResourceName, CallSettings)

TagKeysClient.GetIamPolicyAsync(IResourceName, CancellationToken)

TagKeysClient.SetIamPolicyAsync(SetIamPolicyRequest, CancellationToken)

TagKeysClient.SetIamPolicy(string, Policy, CallSettings)

TagKeysClient.SetIamPolicyAsync(string, Policy, CallSettings)

TagKeysClient.SetIamPolicyAsync(string, Policy, CancellationToken)

TagKeysClient.SetIamPolicy(IResourceName, Policy, CallSettings)

TagKeysClient.SetIamPolicyAsync(IResourceName, Policy, CallSettings)

TagKeysClient.SetIamPolicyAsync(IResourceName, Policy, CancellationToken)

TagKeysClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CancellationToken)

TagKeysClient.TestIamPermissions(string, IEnumerable<string>, CallSettings)

TagKeysClient.TestIamPermissionsAsync(string, IEnumerable<string>, CallSettings)

TagKeysClient.TestIamPermissionsAsync(string, IEnumerable<string>, CancellationToken)

TagKeysClient.TestIamPermissions(IResourceName, IEnumerable<string>, CallSettings)

TagKeysClient.TestIamPermissionsAsync(IResourceName, IEnumerable<string>, CallSettings)

TagKeysClient.TestIamPermissionsAsync(IResourceName, IEnumerable<string>, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.ResourceManager.V3

Assembly

Google.Cloud.ResourceManager.V3.dll

Remarks

Allow users to create and manage tag keys.

Constructors

TagKeysClientImpl(TagKeysClient, TagKeysSettings, ILogger)

public TagKeysClientImpl(TagKeys.TagKeysClient grpcClient, TagKeysSettings settings, ILogger logger)

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

Parameters
Name	Description
grpcClient	TagKeysTagKeysClient The underlying gRPC client.
settings	TagKeysSettings The base TagKeysSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

CreateTagKeyOperationsClient

public override OperationsClient CreateTagKeyOperationsClient { get; }

The long-running operations client for CreateTagKey.

Property Value
Type	Description
OperationsClient

Overrides

TagKeysClient.CreateTagKeyOperationsClient

DeleteTagKeyOperationsClient

public override OperationsClient DeleteTagKeyOperationsClient { get; }

The long-running operations client for DeleteTagKey.

Property Value
Type	Description
OperationsClient

Overrides

TagKeysClient.DeleteTagKeyOperationsClient

GrpcClient

public override TagKeys.TagKeysClient GrpcClient { get; }

The underlying gRPC TagKeys client

Property Value
Type	Description
TagKeysTagKeysClient

Overrides

TagKeysClient.GrpcClient

UpdateTagKeyOperationsClient

public override OperationsClient UpdateTagKeyOperationsClient { get; }

The long-running operations client for UpdateTagKey.

Property Value
Type	Description
OperationsClient

Overrides

TagKeysClient.UpdateTagKeyOperationsClient

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 1000 TagKeys can exist under a parent at any given time.

Parameters
Name	Description
request	CreateTagKeyRequest 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
OperationTagKeyCreateTagKeyMetadata	The RPC response.

Overrides

TagKeysClient.CreateTagKey(CreateTagKeyRequest, CallSettings)

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 1000 TagKeys can exist under a parent at any given time.

Parameters
Name	Description
request	CreateTagKeyRequest 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
TaskOperationTagKeyCreateTagKeyMetadata	A Task containing the RPC response.

Overrides

TagKeysClient.CreateTagKeyAsync(CreateTagKeyRequest, CallSettings)

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	DeleteTagKeyRequest 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
OperationTagKeyDeleteTagKeyMetadata	The RPC response.

Overrides

TagKeysClient.DeleteTagKey(DeleteTagKeyRequest, CallSettings)

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	DeleteTagKeyRequest 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
TaskOperationTagKeyDeleteTagKeyMetadata	A Task containing the RPC response.

Overrides

TagKeysClient.DeleteTagKeyAsync(DeleteTagKeyRequest, CallSettings)

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	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.

Overrides

TagKeysClient.GetIamPolicy(GetIamPolicyRequest, CallSettings)

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	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.

Overrides

TagKeysClient.GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

GetNamespacedTagKey(GetNamespacedTagKeyRequest, CallSettings)

public override TagKey GetNamespacedTagKey(GetNamespacedTagKeyRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TagKey	The RPC response.

Overrides

TagKeysClient.GetNamespacedTagKey(GetNamespacedTagKeyRequest, CallSettings)

GetNamespacedTagKeyAsync(GetNamespacedTagKeyRequest, CallSettings)

public override Task<TagKey> GetNamespacedTagKeyAsync(GetNamespacedTagKeyRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskTagKey	A Task containing the RPC response.

Overrides

TagKeysClient.GetNamespacedTagKeyAsync(GetNamespacedTagKeyRequest, CallSettings)

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	GetTagKeyRequest 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
TagKey	The RPC response.

Overrides

TagKeysClient.GetTagKey(GetTagKeyRequest, CallSettings)

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	GetTagKeyRequest 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
TaskTagKey	A Task containing the RPC response.

Overrides

TagKeysClient.GetTagKeyAsync(GetTagKeyRequest, CallSettings)

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	ListTagKeysRequest 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
PagedEnumerableListTagKeysResponseTagKey	A pageable sequence of TagKey resources.

Overrides

TagKeysClient.ListTagKeys(ListTagKeysRequest, CallSettings)

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	ListTagKeysRequest 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
PagedAsyncEnumerableListTagKeysResponseTagKey	A pageable asynchronous sequence of TagKey resources.

Overrides

TagKeysClient.ListTagKeysAsync(ListTagKeysRequest, CallSettings)

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	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.

Overrides

TagKeysClient.SetIamPolicy(SetIamPolicyRequest, CallSettings)

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	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.

Overrides

TagKeysClient.SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

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	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.

Overrides

TagKeysClient.TestIamPermissions(TestIamPermissionsRequest, CallSettings)

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	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.

Overrides

TagKeysClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

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	UpdateTagKeyRequest 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
OperationTagKeyUpdateTagKeyMetadata	The RPC response.

Overrides

TagKeysClient.UpdateTagKey(UpdateTagKeyRequest, CallSettings)

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	UpdateTagKeyRequest 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
TaskOperationTagKeyUpdateTagKeyMetadata	A Task containing the RPC response.

Overrides

TagKeysClient.UpdateTagKeyAsync(UpdateTagKeyRequest, CallSettings)