Class TagKeysGrpc.TagKeysStub (1.20.0)

public static final class TagKeysGrpc.TagKeysStub extends AbstractAsyncStub<TagKeysGrpc.TagKeysStub>

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

Allow users to create and manage tag keys.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > TagKeysGrpc.TagKeysStub

Methods

build(Channel channel, CallOptions callOptions)

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

createTagKey(CreateTagKeyRequest request, StreamObserver<Operation> responseObserver)

public void createTagKey(CreateTagKeyRequest request, StreamObserver<Operation> responseObserver)

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
NameDescription
requestCreateTagKeyRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

deleteTagKey(DeleteTagKeyRequest request, StreamObserver<Operation> responseObserver)

public void deleteTagKey(DeleteTagKeyRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
NameDescription
requestDeleteTagKeyRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public void getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

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
NameDescription
requestcom.google.iam.v1.GetIamPolicyRequest
responseObserverio.grpc.stub.StreamObserver<com.google.iam.v1.Policy>

getNamespacedTagKey(GetNamespacedTagKeyRequest request, StreamObserver<TagKey> responseObserver)

public void getNamespacedTagKey(GetNamespacedTagKeyRequest request, StreamObserver<TagKey> responseObserver)

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
NameDescription
requestGetNamespacedTagKeyRequest
responseObserverio.grpc.stub.StreamObserver<TagKey>

getTagKey(GetTagKeyRequest request, StreamObserver<TagKey> responseObserver)

public void getTagKey(GetTagKeyRequest request, StreamObserver<TagKey> responseObserver)

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
NameDescription
requestGetTagKeyRequest
responseObserverio.grpc.stub.StreamObserver<TagKey>

listTagKeys(ListTagKeysRequest request, StreamObserver<ListTagKeysResponse> responseObserver)

public void listTagKeys(ListTagKeysRequest request, StreamObserver<ListTagKeysResponse> responseObserver)

Lists all TagKeys for a parent resource.

Parameters
NameDescription
requestListTagKeysRequest
responseObserverio.grpc.stub.StreamObserver<ListTagKeysResponse>

setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public void setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

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
NameDescription
requestcom.google.iam.v1.SetIamPolicyRequest
responseObserverio.grpc.stub.StreamObserver<com.google.iam.v1.Policy>

testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

public void testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

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
NameDescription
requestcom.google.iam.v1.TestIamPermissionsRequest
responseObserverio.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse>

updateTagKey(UpdateTagKeyRequest request, StreamObserver<Operation> responseObserver)

public void updateTagKey(UpdateTagKeyRequest request, StreamObserver<Operation> responseObserver)

Updates the attributes of the TagKey resource.

Parameters
NameDescription
requestUpdateTagKeyRequest
responseObserverio.grpc.stub.StreamObserver<Operation>