Class AutokeyAdminGrpc.AutokeyAdminBlockingV2Stub (2.83.0)

public static final class AutokeyAdminGrpc.AutokeyAdminBlockingV2Stub extends AbstractBlockingStub<AutokeyAdminGrpc.AutokeyAdminBlockingV2Stub>

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

Provides interfaces for managing Cloud KMS Autokey folder-level configurations. A configuration is inherited by all descendent projects. A configuration at one folder overrides any other configurations in its ancestry. Setting a configuration on a folder is a prerequisite for Cloud KMS Autokey, so that users working in a descendant project can request provisioned CryptoKeys, ready for Customer Managed Encryption Key (CMEK) use, on-demand.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > AutokeyAdminGrpc.AutokeyAdminBlockingV2Stub

Methods

build(Channel channel, CallOptions callOptions)

protected AutokeyAdminGrpc.AutokeyAdminBlockingV2Stub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
AutokeyAdminGrpc.AutokeyAdminBlockingV2Stub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

getAutokeyConfig(GetAutokeyConfigRequest request)

public AutokeyConfig getAutokeyConfig(GetAutokeyConfigRequest request)

Returns the AutokeyConfig for a folder.

Parameter
Name Description
request GetAutokeyConfigRequest
Returns
Type Description
AutokeyConfig
Exceptions
Type Description
io.grpc.StatusException

showEffectiveAutokeyConfig(ShowEffectiveAutokeyConfigRequest request)

public ShowEffectiveAutokeyConfigResponse showEffectiveAutokeyConfig(ShowEffectiveAutokeyConfigRequest request)

Returns the effective Cloud KMS Autokey configuration for a given project.

Parameter
Name Description
request ShowEffectiveAutokeyConfigRequest
Returns
Type Description
ShowEffectiveAutokeyConfigResponse
Exceptions
Type Description
io.grpc.StatusException

updateAutokeyConfig(UpdateAutokeyConfigRequest request)

public AutokeyConfig updateAutokeyConfig(UpdateAutokeyConfigRequest request)

Updates the AutokeyConfig for a folder. The caller must have both cloudkms.autokeyConfigs.update permission on the parent folder and cloudkms.cryptoKeys.setIamPolicy permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.

Parameter
Name Description
request UpdateAutokeyConfigRequest
Returns
Type Description
AutokeyConfig
Exceptions
Type Description
io.grpc.StatusException