Secret Manager v1 API - Namespace Google.Cloud.SecretManager.V1 (2.8.0)

Classes

AccessSecretVersionRequest

Request message for [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion].

AccessSecretVersionResponse

Response message for [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion].

AddSecretVersionRequest

Request message for [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion].

CreateSecretRequest

Request message for [SecretManagerService.CreateSecret][google.cloud.secretmanager.v1.SecretManagerService.CreateSecret].

CustomerManagedEncryption

Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK).

CustomerManagedEncryptionStatus

Describes the status of customer-managed encryption.

DeleteSecretRequest

Request message for [SecretManagerService.DeleteSecret][google.cloud.secretmanager.v1.SecretManagerService.DeleteSecret].

DestroySecretVersionRequest

Request message for [SecretManagerService.DestroySecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DestroySecretVersion].

DisableSecretVersionRequest

Request message for [SecretManagerService.DisableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DisableSecretVersion].

EnableManagedRotationRequest

Request message for [SecretManagerService.EnableManagedRotation][google.cloud.secretmanager.v1.SecretManagerService.EnableManagedRotation].

EnableManagedRotationRequest.Types

Container for nested types declared in the EnableManagedRotationRequest message type.

EnableManagedRotationRequest.Types.CloudSQLSingleUserCredentials

These are the credentials required for Cloud SQL DB for Single user Managed Rotation.

EnableSecretVersionRequest

Request message for [SecretManagerService.EnableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.EnableSecretVersion].

GetSecretRequest

Request message for [SecretManagerService.GetSecret][google.cloud.secretmanager.v1.SecretManagerService.GetSecret].

GetSecretVersionRequest

Request message for [SecretManagerService.GetSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.GetSecretVersion].

ListSecretVersionsRequest

Request message for [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions].

ListSecretVersionsResponse

Response message for [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions].

ListSecretsRequest

Request message for [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets].

ListSecretsResponse

Response message for [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets].

Replication

A policy that defines the replication and encryption configuration of data.

Replication.Types

Container for nested types declared in the Replication message type.

Replication.Types.Automatic

A replication policy that replicates the [Secret][google.cloud.secretmanager.v1.Secret] payload without any restrictions.

Replication.Types.UserManaged

A replication policy that replicates the [Secret][google.cloud.secretmanager.v1.Secret] payload into the locations specified in [Replication.UserManaged.replicas][google.cloud.secretmanager.v1.Replication.UserManaged.replicas]

Replication.Types.UserManaged.Types

Container for nested types declared in the UserManaged message type.

Replication.Types.UserManaged.Types.Replica

Represents a Replica for this [Secret][google.cloud.secretmanager.v1.Secret].

ReplicationStatus

The replication status of a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].

ReplicationStatus.Types

Container for nested types declared in the ReplicationStatus message type.

ReplicationStatus.Types.AutomaticStatus

The replication status of a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] using automatic replication.

Only populated if the parent [Secret][google.cloud.secretmanager.v1.Secret] has an automatic replication policy.

ReplicationStatus.Types.UserManagedStatus

The replication status of a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] using user-managed replication.

Only populated if the parent [Secret][google.cloud.secretmanager.v1.Secret] has a user-managed replication policy.

ReplicationStatus.Types.UserManagedStatus.Types

Container for nested types declared in the UserManagedStatus message type.

ReplicationStatus.Types.UserManagedStatus.Types.ReplicaStatus

Describes the status of a user-managed replica for the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].

RotateSecretRequest

Request message for [SecretManagerService.RotateSecret][google.cloud.secretmanager.v1.SecretManagerService.RotateSecret].

Rotation

The rotation time and period for a [Secret][google.cloud.secretmanager.v1.Secret]. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. [Secret.topics][google.cloud.secretmanager.v1.Secret.topics] must be set to configure rotation.

Rotation.Types

Container for nested types declared in the Rotation message type.

Rotation.Types.ManagedRotationStatus

Represents the status of a managed rotation.

This is applicable only to Typed Secrets. It indicates whether the rotation is active and any errors that may have occurred during the asynchronous managed rotation.

Rotation.Types.ManagedRotationStatus.Types

Container for nested types declared in the ManagedRotationStatus message type.

Secret

A [Secret][google.cloud.secretmanager.v1.Secret] is a logical secret whose value and versions can be accessed.

A [Secret][google.cloud.secretmanager.v1.Secret] is made up of zero or more [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] that represent the secret data.

Secret.Types

Container for nested types declared in the Secret message type.

SecretManagerService

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]

SecretManagerService.SecretManagerServiceBase

Base class for server-side implementations of SecretManagerService

SecretManagerService.SecretManagerServiceClient

Client for SecretManagerService

SecretManagerServiceClient

SecretManagerService client wrapper, for convenient use.

SecretManagerServiceClientBuilder

Builder class for SecretManagerServiceClient to provide simple configuration of credentials, endpoint etc.

SecretManagerServiceClientImpl

SecretManagerService client wrapper implementation, for convenient use.

SecretManagerServiceSettings

Settings for SecretManagerServiceClient instances.

SecretName

Resource name for the Secret resource.

SecretPayload

A secret payload resource in the Secret Manager API. This contains the sensitive secret payload that is associated with a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].

SecretVersion

A secret version resource in the Secret Manager API.

SecretVersion.Types

Container for nested types declared in the SecretVersion message type.

SecretVersionName

Resource name for the SecretVersion resource.

Topic

A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret.

TopicName

Resource name for the Topic resource.

UpdateSecretRequest

Request message for [SecretManagerService.UpdateSecret][google.cloud.secretmanager.v1.SecretManagerService.UpdateSecret].

Enums

EnableManagedRotationRequest.CredentialsOneofCase

Enum of possible cases for the "credentials" oneof.

Replication.ReplicationOneofCase

Enum of possible cases for the "replication" oneof.

ReplicationStatus.ReplicationStatusOneofCase

Enum of possible cases for the "replication_status" oneof.

Rotation.Types.ManagedRotationStatus.Types.State

This defines the various states in which the managed rotation can be.

Secret.ExpirationOneofCase

Enum of possible cases for the "expiration" oneof.

Secret.Types.SecretType

This defines the various values of the type of secret can be.

SecretName.ResourceNameType

The possible contents of SecretName.

SecretVersion.Types.State

The state of a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion], indicating if it can be accessed.

SecretVersionName.ResourceNameType

The possible contents of SecretVersionName.

TopicName.ResourceNameType

The possible contents of TopicName.