Reference documentation and code samples for the Secret Manager V1 API class Google::Cloud::SecretManager::V1::SecretVersion.
A secret version resource in the Secret Manager API.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#client_specified_payload_checksum
def client_specified_payload_checksum() -> ::Boolean
Returns
- (::Boolean) — Output only. True if payload checksum specified in SecretPayload object has been received by SecretManagerService on SecretManagerService.AddSecretVersion.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time at which the SecretVersion was created.
#customer_managed_encryption
def customer_managed_encryption() -> ::Google::Cloud::SecretManager::V1::CustomerManagedEncryptionStatus
Returns
- (::Google::Cloud::SecretManager::V1::CustomerManagedEncryptionStatus) — Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used and Secret is a Regionalised Secret.
#destroy_time
def destroy_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
#etag
def etag() -> ::String
Returns
- (::String) — Output only. Etag of the currently stored SecretVersion.
#name
def name() -> ::String
Returns
-
(::String) — Output only. The resource name of the
SecretVersion in the format
projects/*/secrets/*/versions/*.SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.
#replication_status
def replication_status() -> ::Google::Cloud::SecretManager::V1::ReplicationStatus
Returns
- (::Google::Cloud::SecretManager::V1::ReplicationStatus) — The replication status of the SecretVersion.
#replication_status=
def replication_status=(value) -> ::Google::Cloud::SecretManager::V1::ReplicationStatus
Parameter
- value (::Google::Cloud::SecretManager::V1::ReplicationStatus) — The replication status of the SecretVersion.
Returns
- (::Google::Cloud::SecretManager::V1::ReplicationStatus) — The replication status of the SecretVersion.
#scheduled_destroy_time
def scheduled_destroy_time() -> ::Google::Protobuf::Timestamp
Returns
-
(::Google::Protobuf::Timestamp) — Optional. Output only. Scheduled destroy time for secret version.
This is a part of the Delayed secret version destroy feature. For a
Secret with a valid version destroy TTL, when a secert version is
destroyed, the version is moved to disabled state and it is scheduled for
destruction. The version is destroyed only after the
scheduled_destroy_time.
#state
def state() -> ::Google::Cloud::SecretManager::V1::SecretVersion::State
Returns
- (::Google::Cloud::SecretManager::V1::SecretVersion::State) — Output only. The current state of the SecretVersion.