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

[BindServiceMethod(typeof(TagKeys), "BindService")]
public abstract class TagKeys.TagKeysBase

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

Base class for server-side implementations of TagKeys

Inheritance

object > TagKeys.TagKeysBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.ResourceManager.V3

Assembly

Google.Cloud.ResourceManager.V3.dll

Methods

CreateTagKey(CreateTagKeyRequest, ServerCallContext)

public virtual Task<Operation> CreateTagKey(CreateTagKeyRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteTagKey(DeleteTagKeyRequest, ServerCallContext)

public virtual Task<Operation> DeleteTagKey(DeleteTagKeyRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`DeleteTagKeyRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

GetIamPolicy(GetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> GetIamPolicy(GetIamPolicyRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPolicy`	The response to send back to the client (wrapped by a task).

GetNamespacedTagKey(GetNamespacedTagKeyRequest, ServerCallContext)

public virtual Task<TagKey> GetNamespacedTagKey(GetNamespacedTagKeyRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskTagKey`	The response to send back to the client (wrapped by a task).

GetTagKey(GetTagKeyRequest, ServerCallContext)

public virtual Task<TagKey> GetTagKey(GetTagKeyRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskTagKey`	The response to send back to the client (wrapped by a task).

ListTagKeys(ListTagKeysRequest, ServerCallContext)

public virtual Task<ListTagKeysResponse> ListTagKeys(ListTagKeysRequest request, ServerCallContext context)

Lists all TagKeys for a parent resource.

Parameters
Name	Description
`request`	`ListTagKeysRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListTagKeysResponse`	The response to send back to the client (wrapped by a task).

SetIamPolicy(SetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> SetIamPolicy(SetIamPolicyRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPolicy`	The response to send back to the client (wrapped by a task).

TestIamPermissions(TestIamPermissionsRequest, ServerCallContext)

public virtual Task<TestIamPermissionsResponse> TestIamPermissions(TestIamPermissionsRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskTestIamPermissionsResponse`	The response to send back to the client (wrapped by a task).

UpdateTagKey(UpdateTagKeyRequest, ServerCallContext)

public virtual Task<Operation> UpdateTagKey(UpdateTagKeyRequest request, ServerCallContext context)

Updates the attributes of the TagKey resource.

Parameters
Name	Description
`request`	`UpdateTagKeyRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).