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:



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 180

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:



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 180

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:



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 180

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.



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 180

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.



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 180

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:



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 180

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:



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'proto_docs/google/cloud/secretmanager/v1/resources.rb', line 180

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