Class: Google::Cloud::SecretManager::V1::SecretVersion

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/secretmanager/v1/resources.rb

Overview

A secret version resource in the Secret Manager API.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#client_specified_payload_checksum ⇒ ::Boolean (readonly)

Returns Output only. True if payload checksum specified in SecretPayload object has been received by SecretManagerService on SecretManagerService.AddSecretVersion.

Returns:



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 213

class SecretVersion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The state of a
  # {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion}, indicating if
  # it can be accessed.
  module State
    # Not specified. This value is unused and invalid.
    STATE_UNSPECIFIED = 0

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} may be
    # accessed.
    ENABLED = 1

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} may not
    # be accessed, but the secret data is still available and can be placed
    # back into the
    # {::Google::Cloud::SecretManager::V1::SecretVersion::State::ENABLED ENABLED}
    # state.
    DISABLED = 2

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} is
    # destroyed and the secret data is no longer stored. A version may not
    # leave this state once entered.
    DESTROYED = 3
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time at which the SecretVersion was created.

Returns:



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 213

class SecretVersion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The state of a
  # {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion}, indicating if
  # it can be accessed.
  module State
    # Not specified. This value is unused and invalid.
    STATE_UNSPECIFIED = 0

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} may be
    # accessed.
    ENABLED = 1

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} may not
    # be accessed, but the secret data is still available and can be placed
    # back into the
    # {::Google::Cloud::SecretManager::V1::SecretVersion::State::ENABLED ENABLED}
    # state.
    DISABLED = 2

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} is
    # destroyed and the secret data is no longer stored. A version may not
    # leave this state once entered.
    DESTROYED = 3
  end
end

#customer_managed_encryption ⇒ ::Google::Cloud::SecretManager::V1::CustomerManagedEncryptionStatus (readonly)

Returns Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used and Secret is a Regionalised Secret.

Returns:



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 213

class SecretVersion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The state of a
  # {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion}, indicating if
  # it can be accessed.
  module State
    # Not specified. This value is unused and invalid.
    STATE_UNSPECIFIED = 0

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} may be
    # accessed.
    ENABLED = 1

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} may not
    # be accessed, but the secret data is still available and can be placed
    # back into the
    # {::Google::Cloud::SecretManager::V1::SecretVersion::State::ENABLED ENABLED}
    # state.
    DISABLED = 2

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} is
    # destroyed and the secret data is no longer stored. A version may not
    # leave this state once entered.
    DESTROYED = 3
  end
end

#destroy_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.

Returns:



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 213

class SecretVersion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The state of a
  # {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion}, indicating if
  # it can be accessed.
  module State
    # Not specified. This value is unused and invalid.
    STATE_UNSPECIFIED = 0

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} may be
    # accessed.
    ENABLED = 1

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} may not
    # be accessed, but the secret data is still available and can be placed
    # back into the
    # {::Google::Cloud::SecretManager::V1::SecretVersion::State::ENABLED ENABLED}
    # state.
    DISABLED = 2

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} is
    # destroyed and the secret data is no longer stored. A version may not
    # leave this state once entered.
    DESTROYED = 3
  end
end

#etag ⇒ ::String (readonly)

Returns Output only. Etag of the currently stored SecretVersion.

Returns:

  • (::String) —

    Output only. Etag of the currently stored SecretVersion.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 213

class SecretVersion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The state of a
  # {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion}, indicating if
  # it can be accessed.
  module State
    # Not specified. This value is unused and invalid.
    STATE_UNSPECIFIED = 0

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} may be
    # accessed.
    ENABLED = 1

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} may not
    # be accessed, but the secret data is still available and can be placed
    # back into the
    # {::Google::Cloud::SecretManager::V1::SecretVersion::State::ENABLED ENABLED}
    # state.
    DISABLED = 2

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} is
    # destroyed and the secret data is no longer stored. A version may not
    # leave this state once entered.
    DESTROYED = 3
  end
end

#name ⇒ ::String (readonly)

Returns 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.

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.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 213

class SecretVersion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The state of a
  # {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion}, indicating if
  # it can be accessed.
  module State
    # Not specified. This value is unused and invalid.
    STATE_UNSPECIFIED = 0

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} may be
    # accessed.
    ENABLED = 1

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} may not
    # be accessed, but the secret data is still available and can be placed
    # back into the
    # {::Google::Cloud::SecretManager::V1::SecretVersion::State::ENABLED ENABLED}
    # state.
    DISABLED = 2

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} is
    # destroyed and the secret data is no longer stored. A version may not
    # leave this state once entered.
    DESTROYED = 3
  end
end

#replication_status ⇒ ::Google::Cloud::SecretManager::V1::ReplicationStatus

Returns The replication status of the SecretVersion.

Returns:



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 213

class SecretVersion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The state of a
  # {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion}, indicating if
  # it can be accessed.
  module State
    # Not specified. This value is unused and invalid.
    STATE_UNSPECIFIED = 0

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} may be
    # accessed.
    ENABLED = 1

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} may not
    # be accessed, but the secret data is still available and can be placed
    # back into the
    # {::Google::Cloud::SecretManager::V1::SecretVersion::State::ENABLED ENABLED}
    # state.
    DISABLED = 2

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} is
    # destroyed and the secret data is no longer stored. A version may not
    # leave this state once entered.
    DESTROYED = 3
  end
end

#scheduled_destroy_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns 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.

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.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 213

class SecretVersion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The state of a
  # {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion}, indicating if
  # it can be accessed.
  module State
    # Not specified. This value is unused and invalid.
    STATE_UNSPECIFIED = 0

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} may be
    # accessed.
    ENABLED = 1

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} may not
    # be accessed, but the secret data is still available and can be placed
    # back into the
    # {::Google::Cloud::SecretManager::V1::SecretVersion::State::ENABLED ENABLED}
    # state.
    DISABLED = 2

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} is
    # destroyed and the secret data is no longer stored. A version may not
    # leave this state once entered.
    DESTROYED = 3
  end
end

#state ⇒ ::Google::Cloud::SecretManager::V1::SecretVersion::State (readonly)

Returns Output only. The current state of the SecretVersion.

Returns:



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 213

class SecretVersion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The state of a
  # {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion}, indicating if
  # it can be accessed.
  module State
    # Not specified. This value is unused and invalid.
    STATE_UNSPECIFIED = 0

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} may be
    # accessed.
    ENABLED = 1

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} may not
    # be accessed, but the secret data is still available and can be placed
    # back into the
    # {::Google::Cloud::SecretManager::V1::SecretVersion::State::ENABLED ENABLED}
    # state.
    DISABLED = 2

    # The {::Google::Cloud::SecretManager::V1::SecretVersion SecretVersion} is
    # destroyed and the secret data is no longer stored. A version may not
    # leave this state once entered.
    DESTROYED = 3
  end
end