Interface SecretManagerServiceGrpc.AsyncService (2.37.0)

public static interface SecretManagerServiceGrpc.AsyncService

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

  • Secret
  • SecretVersion

Methods

accessSecretVersion(AccessSecretVersionRequest request, StreamObserver<AccessSecretVersionResponse> responseObserver)

public default void accessSecretVersion(AccessSecretVersionRequest request, StreamObserver<AccessSecretVersionResponse> responseObserver)

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

Parameters
NameDescription
requestAccessSecretVersionRequest
responseObserverio.grpc.stub.StreamObserver<AccessSecretVersionResponse>

addSecretVersion(AddSecretVersionRequest request, StreamObserver<SecretVersion> responseObserver)

public default void addSecretVersion(AddSecretVersionRequest request, StreamObserver<SecretVersion> responseObserver)

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

Parameters
NameDescription
requestAddSecretVersionRequest
responseObserverio.grpc.stub.StreamObserver<SecretVersion>

createSecret(CreateSecretRequest request, StreamObserver<Secret> responseObserver)

public default void createSecret(CreateSecretRequest request, StreamObserver<Secret> responseObserver)

Creates a new Secret containing no SecretVersions.

Parameters
NameDescription
requestCreateSecretRequest
responseObserverio.grpc.stub.StreamObserver<Secret>

deleteSecret(DeleteSecretRequest request, StreamObserver<Empty> responseObserver)

public default void deleteSecret(DeleteSecretRequest request, StreamObserver<Empty> responseObserver)

Deletes a Secret.

Parameters
NameDescription
requestDeleteSecretRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

destroySecretVersion(DestroySecretVersionRequest request, StreamObserver<SecretVersion> responseObserver)

public default void destroySecretVersion(DestroySecretVersionRequest request, StreamObserver<SecretVersion> responseObserver)

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

Parameters
NameDescription
requestDestroySecretVersionRequest
responseObserverio.grpc.stub.StreamObserver<SecretVersion>

disableSecretVersion(DisableSecretVersionRequest request, StreamObserver<SecretVersion> responseObserver)

public default void disableSecretVersion(DisableSecretVersionRequest request, StreamObserver<SecretVersion> responseObserver)

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

Parameters
NameDescription
requestDisableSecretVersionRequest
responseObserverio.grpc.stub.StreamObserver<SecretVersion>

enableSecretVersion(EnableSecretVersionRequest request, StreamObserver<SecretVersion> responseObserver)

public default void enableSecretVersion(EnableSecretVersionRequest request, StreamObserver<SecretVersion> responseObserver)

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

Parameters
NameDescription
requestEnableSecretVersionRequest
responseObserverio.grpc.stub.StreamObserver<SecretVersion>

getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

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

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

Parameters
NameDescription
requestcom.google.iam.v1.GetIamPolicyRequest
responseObserverio.grpc.stub.StreamObserver<com.google.iam.v1.Policy>

getSecret(GetSecretRequest request, StreamObserver<Secret> responseObserver)

public default void getSecret(GetSecretRequest request, StreamObserver<Secret> responseObserver)

Gets metadata for a given Secret.

Parameters
NameDescription
requestGetSecretRequest
responseObserverio.grpc.stub.StreamObserver<Secret>

getSecretVersion(GetSecretVersionRequest request, StreamObserver<SecretVersion> responseObserver)

public default void getSecretVersion(GetSecretVersionRequest request, StreamObserver<SecretVersion> responseObserver)

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

Parameters
NameDescription
requestGetSecretVersionRequest
responseObserverio.grpc.stub.StreamObserver<SecretVersion>

listSecretVersions(ListSecretVersionsRequest request, StreamObserver<ListSecretVersionsResponse> responseObserver)

public default void listSecretVersions(ListSecretVersionsRequest request, StreamObserver<ListSecretVersionsResponse> responseObserver)

Lists SecretVersions. This call does not return secret data.

Parameters
NameDescription
requestListSecretVersionsRequest
responseObserverio.grpc.stub.StreamObserver<ListSecretVersionsResponse>

listSecrets(ListSecretsRequest request, StreamObserver<ListSecretsResponse> responseObserver)

public default void listSecrets(ListSecretsRequest request, StreamObserver<ListSecretsResponse> responseObserver)

Lists Secrets.

Parameters
NameDescription
requestListSecretsRequest
responseObserverio.grpc.stub.StreamObserver<ListSecretsResponse>

setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

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

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.

Parameters
NameDescription
requestcom.google.iam.v1.SetIamPolicyRequest
responseObserverio.grpc.stub.StreamObserver<com.google.iam.v1.Policy>

testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

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

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.

Parameters
NameDescription
requestcom.google.iam.v1.TestIamPermissionsRequest
responseObserverio.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse>

updateSecret(UpdateSecretRequest request, StreamObserver<Secret> responseObserver)

public default void updateSecret(UpdateSecretRequest request, StreamObserver<Secret> responseObserver)

Updates metadata of an existing Secret.

Parameters
NameDescription
requestUpdateSecretRequest
responseObserverio.grpc.stub.StreamObserver<Secret>