@Generated("by gapic-generator-java")
Package com.google.cloud.secretmanager.v1
A client to Secret Manager API
The interfaces provided are listed below, along with usage samples.
======================= SecretManagerServiceClient =======================
Service Description: Secret Manager Service
Manages secrets and operations using those secrets. Implements a REST model with the following objects:
- [Secret][google.cloud.secretmanager.v1.Secret]
- [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]
Sample for SecretManagerServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (SecretManagerServiceClient secretManagerServiceClient =
SecretManagerServiceClient.create()) {
ProjectName parent = ProjectName.of("[PROJECT]");
String secretId = "secretId945974251";
Secret secret = Secret.newBuilder().build();
Secret response = secretManagerServiceClient.createSecret(parent, secretId, secret);
}
-
Class Summary Class Description AccessSecretVersionRequest Request message for [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion].AccessSecretVersionRequest.Builder Request message for [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion].AccessSecretVersionResponse Response message for [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion].AccessSecretVersionResponse.Builder Response message for [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion].AddSecretVersionRequest Request message for [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion].AddSecretVersionRequest.Builder Request message for [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion].CreateSecretRequest Request message for [SecretManagerService.CreateSecret][google.cloud.secretmanager.v1.SecretManagerService.CreateSecret].CreateSecretRequest.Builder Request message for [SecretManagerService.CreateSecret][google.cloud.secretmanager.v1.SecretManagerService.CreateSecret].CustomerManagedEncryption Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK).CustomerManagedEncryption.Builder Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK).CustomerManagedEncryptionStatus Describes the status of customer-managed encryption.CustomerManagedEncryptionStatus.Builder Describes the status of customer-managed encryption.DeleteSecretRequest Request message for [SecretManagerService.DeleteSecret][google.cloud.secretmanager.v1.SecretManagerService.DeleteSecret].DeleteSecretRequest.Builder Request message for [SecretManagerService.DeleteSecret][google.cloud.secretmanager.v1.SecretManagerService.DeleteSecret].DestroySecretVersionRequest Request message for [SecretManagerService.DestroySecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DestroySecretVersion].DestroySecretVersionRequest.Builder Request message for [SecretManagerService.DestroySecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DestroySecretVersion].DisableSecretVersionRequest Request message for [SecretManagerService.DisableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DisableSecretVersion].DisableSecretVersionRequest.Builder Request message for [SecretManagerService.DisableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DisableSecretVersion].EnableSecretVersionRequest Request message for [SecretManagerService.EnableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.EnableSecretVersion].EnableSecretVersionRequest.Builder Request message for [SecretManagerService.EnableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.EnableSecretVersion].GetSecretRequest Request message for [SecretManagerService.GetSecret][google.cloud.secretmanager.v1.SecretManagerService.GetSecret].GetSecretRequest.Builder Request message for [SecretManagerService.GetSecret][google.cloud.secretmanager.v1.SecretManagerService.GetSecret].GetSecretVersionRequest Request message for [SecretManagerService.GetSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.GetSecretVersion].GetSecretVersionRequest.Builder Request message for [SecretManagerService.GetSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.GetSecretVersion].ListSecretsRequest Request message for [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets].ListSecretsRequest.Builder Request message for [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets].ListSecretsResponse Response message for [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets].ListSecretsResponse.Builder Response message for [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets].ListSecretVersionsRequest Request message for [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions].ListSecretVersionsRequest.Builder Request message for [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions].ListSecretVersionsResponse Response message for [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions].ListSecretVersionsResponse.Builder Response message for [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions].ProjectName ProjectName.Builder Builder for projects/{project}.Replication A policy that defines the replication and encryption configuration of data.Replication.Automatic A replication policy that replicates the [Secret][google.cloud.secretmanager.v1.Secret] payload without any restrictions.Replication.Automatic.Builder A replication policy that replicates the [Secret][google.cloud.secretmanager.v1.Secret] payload without any restrictions.Replication.Builder A policy that defines the replication and encryption configuration of data.Replication.UserManaged A replication policy that replicates the [Secret][google.cloud.secretmanager.v1.Secret] payload into the locations specified in [Secret.replication.user_managed.replicas][]Replication.UserManaged.Builder A replication policy that replicates the [Secret][google.cloud.secretmanager.v1.Secret] payload into the locations specified in [Secret.replication.user_managed.replicas][]Replication.UserManaged.Replica Represents a Replica for this [Secret][google.cloud.secretmanager.v1.Secret].Replication.UserManaged.Replica.Builder Represents a Replica for this [Secret][google.cloud.secretmanager.v1.Secret].ReplicationStatus The replication status of a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].ReplicationStatus.AutomaticStatus The replication status of a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] using automatic replication.ReplicationStatus.AutomaticStatus.Builder The replication status of a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] using automatic replication.ReplicationStatus.Builder The replication status of a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].ReplicationStatus.UserManagedStatus The replication status of a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] using user-managed replication.ReplicationStatus.UserManagedStatus.Builder The replication status of a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] using user-managed replication.ReplicationStatus.UserManagedStatus.ReplicaStatus Describes the status of a user-managed replica for the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].ReplicationStatus.UserManagedStatus.ReplicaStatus.Builder Describes the status of a user-managed replica for the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].ResourcesProto Rotation The rotation time and period for a [Secret][google.cloud.secretmanager.v1.Secret].Rotation.Builder The rotation time and period for a [Secret][google.cloud.secretmanager.v1.Secret].Secret A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret whose value and versions can be accessed.Secret.Builder A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret whose value and versions can be accessed.SecretManagerServiceClient Service Description: Secret Manager ServiceSecretManagerServiceClient.ListSecretsFixedSizeCollection SecretManagerServiceClient.ListSecretsPage SecretManagerServiceClient.ListSecretsPagedResponse SecretManagerServiceClient.ListSecretVersionsFixedSizeCollection SecretManagerServiceClient.ListSecretVersionsPage SecretManagerServiceClient.ListSecretVersionsPagedResponse SecretManagerServiceGrpc Secret Manager Service Manages secrets and operations using those secrets.SecretManagerServiceGrpc.SecretManagerServiceBlockingStub A stub to allow clients to do synchronous rpc calls to service SecretManagerService.SecretManagerServiceGrpc.SecretManagerServiceFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service SecretManagerService.SecretManagerServiceGrpc.SecretManagerServiceImplBase Base class for the server implementation of the service SecretManagerService.SecretManagerServiceGrpc.SecretManagerServiceStub A stub to allow clients to do asynchronous rpc calls to service SecretManagerService.SecretManagerServiceSettings Settings class to configure an instance ofSecretManagerServiceClient
.SecretManagerServiceSettings.Builder Builder for SecretManagerServiceSettings.SecretName SecretName.Builder Builder for projects/{project}/secrets/{secret}.SecretPayload A secret payload resource in the Secret Manager API.SecretPayload.Builder A secret payload resource in the Secret Manager API.SecretVersion A secret version resource in the Secret Manager API.SecretVersion.Builder A secret version resource in the Secret Manager API.SecretVersionName SecretVersionName.Builder Builder for projects/{project}/secrets/{secret}/versions/{secret_version}.ServiceProto Topic A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret.Topic.Builder A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret.UpdateSecretRequest Request message for [SecretManagerService.UpdateSecret][google.cloud.secretmanager.v1.SecretManagerService.UpdateSecret].UpdateSecretRequest.Builder Request message for [SecretManagerService.UpdateSecret][google.cloud.secretmanager.v1.SecretManagerService.UpdateSecret]. -
Enum Summary Enum Description Replication.ReplicationCase ReplicationStatus.ReplicationStatusCase Secret.ExpirationCase SecretVersion.State The state of a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion], indicating if it can be accessed.