Class TagKeysGrpc.TagKeysBlockingStub (1.23.0)

public static final class TagKeysGrpc.TagKeysBlockingStub extends AbstractBlockingStub<TagKeysGrpc.TagKeysBlockingStub>

A stub to allow clients to do synchronous rpc calls to service TagKeys.

Allow users to create and manage tag keys.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > TagKeysGrpc.TagKeysBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

protected TagKeysGrpc.TagKeysBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
TagKeysGrpc.TagKeysBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createTagKey(CreateTagKeyRequest request)

public Operation createTagKey(CreateTagKeyRequest request)

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.

Parameter
NameDescription
requestCreateTagKeyRequest
Returns
TypeDescription
Operation

deleteTagKey(DeleteTagKeyRequest request)

public Operation deleteTagKey(DeleteTagKeyRequest request)

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

Parameter
NameDescription
requestDeleteTagKeyRequest
Returns
TypeDescription
Operation

getIamPolicy(GetIamPolicyRequest request)

public Policy getIamPolicy(GetIamPolicyRequest request)

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.

Parameter
NameDescription
requestcom.google.iam.v1.GetIamPolicyRequest
Returns
TypeDescription
com.google.iam.v1.Policy

getNamespacedTagKey(GetNamespacedTagKeyRequest request)

public TagKey getNamespacedTagKey(GetNamespacedTagKeyRequest request)

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.

Parameter
NameDescription
requestGetNamespacedTagKeyRequest
Returns
TypeDescription
TagKey

getTagKey(GetTagKeyRequest request)

public TagKey getTagKey(GetTagKeyRequest request)

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.

Parameter
NameDescription
requestGetTagKeyRequest
Returns
TypeDescription
TagKey

listTagKeys(ListTagKeysRequest request)

public ListTagKeysResponse listTagKeys(ListTagKeysRequest request)

Lists all TagKeys for a parent resource.

Parameter
NameDescription
requestListTagKeysRequest
Returns
TypeDescription
ListTagKeysResponse

setIamPolicy(SetIamPolicyRequest request)

public Policy setIamPolicy(SetIamPolicyRequest request)

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.

Parameter
NameDescription
requestcom.google.iam.v1.SetIamPolicyRequest
Returns
TypeDescription
com.google.iam.v1.Policy

testIamPermissions(TestIamPermissionsRequest request)

public TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

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.

Parameter
NameDescription
requestcom.google.iam.v1.TestIamPermissionsRequest
Returns
TypeDescription
com.google.iam.v1.TestIamPermissionsResponse

updateTagKey(UpdateTagKeyRequest request)

public Operation updateTagKey(UpdateTagKeyRequest request)

Updates the attributes of the TagKey resource.

Parameter
NameDescription
requestUpdateTagKeyRequest
Returns
TypeDescription
Operation