Class SecretManagerServiceGrpc.SecretManagerServiceBlockingStub (2.48.0)

public static final class SecretManagerServiceGrpc.SecretManagerServiceBlockingStub extends AbstractBlockingStub<SecretManagerServiceGrpc.SecretManagerServiceBlockingStub>

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

Secret Manager Service Manages secrets and operations using those secrets. Implements a REST model with the following objects:

  • Secret
  • SecretVersion

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > SecretManagerServiceGrpc.SecretManagerServiceBlockingStub

Methods

accessSecretVersion(AccessSecretVersionRequest request)

public AccessSecretVersionResponse accessSecretVersion(AccessSecretVersionRequest request)

Accesses a SecretVersion. This call returns the secret data. projects/*/secrets/*/versions/latest is an alias to the most recently created SecretVersion.

Parameter
Name Description
request AccessSecretVersionRequest
Returns
Type Description
AccessSecretVersionResponse

addSecretVersion(AddSecretVersionRequest request)

public SecretVersion addSecretVersion(AddSecretVersionRequest request)

Creates a new SecretVersion containing secret data and attaches it to an existing Secret.

Parameter
Name Description
request AddSecretVersionRequest
Returns
Type Description
SecretVersion

build(Channel channel, CallOptions callOptions)

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

createSecret(CreateSecretRequest request)

public Secret createSecret(CreateSecretRequest request)

Creates a new Secret containing no SecretVersions.

Parameter
Name Description
request CreateSecretRequest
Returns
Type Description
Secret

deleteSecret(DeleteSecretRequest request)

public Empty deleteSecret(DeleteSecretRequest request)

Deletes a Secret.

Parameter
Name Description
request DeleteSecretRequest
Returns
Type Description
Empty

destroySecretVersion(DestroySecretVersionRequest request)

public SecretVersion destroySecretVersion(DestroySecretVersionRequest request)

Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.

Parameter
Name Description
request DestroySecretVersionRequest
Returns
Type Description
SecretVersion

disableSecretVersion(DisableSecretVersionRequest request)

public SecretVersion disableSecretVersion(DisableSecretVersionRequest request)

Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED.

Parameter
Name Description
request DisableSecretVersionRequest
Returns
Type Description
SecretVersion

enableSecretVersion(EnableSecretVersionRequest request)

public SecretVersion enableSecretVersion(EnableSecretVersionRequest request)

Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED.

Parameter
Name Description
request EnableSecretVersionRequest
Returns
Type Description
SecretVersion

getIamPolicy(GetIamPolicyRequest request)

public Policy getIamPolicy(GetIamPolicyRequest request)

Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set.

Parameter
Name Description
request com.google.iam.v1.GetIamPolicyRequest
Returns
Type Description
com.google.iam.v1.Policy

getSecret(GetSecretRequest request)

public Secret getSecret(GetSecretRequest request)

Gets metadata for a given Secret.

Parameter
Name Description
request GetSecretRequest
Returns
Type Description
Secret

getSecretVersion(GetSecretVersionRequest request)

public SecretVersion getSecretVersion(GetSecretVersionRequest request)

Gets metadata for a SecretVersion. projects/*/secrets/*/versions/latest is an alias to the most recently created SecretVersion.

Parameter
Name Description
request GetSecretVersionRequest
Returns
Type Description
SecretVersion

listSecretVersions(ListSecretVersionsRequest request)

public ListSecretVersionsResponse listSecretVersions(ListSecretVersionsRequest request)

Lists SecretVersions. This call does not return secret data.

Parameter
Name Description
request ListSecretVersionsRequest
Returns
Type Description
ListSecretVersionsResponse

listSecrets(ListSecretsRequest request)

public ListSecretsResponse listSecrets(ListSecretsRequest request)

Lists Secrets.

Parameter
Name Description
request ListSecretsRequest
Returns
Type Description
ListSecretsResponse

setIamPolicy(SetIamPolicyRequest request)

public Policy setIamPolicy(SetIamPolicyRequest request)

Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret.

Parameter
Name Description
request com.google.iam.v1.SetIamPolicyRequest
Returns
Type Description
com.google.iam.v1.Policy

testIamPermissions(TestIamPermissionsRequest request)

public TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameter
Name Description
request com.google.iam.v1.TestIamPermissionsRequest
Returns
Type Description
com.google.iam.v1.TestIamPermissionsResponse

updateSecret(UpdateSecretRequest request)

public Secret updateSecret(UpdateSecretRequest request)

Updates metadata of an existing Secret.

Parameter
Name Description
request UpdateSecretRequest
Returns
Type Description
Secret