Class: Google::Cloud::Kms::V1::CryptoKeyVersion

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/resources.rb

Overview

A CryptoKeyVersion represents an individual cryptographic key, and the associated key material.

It can be used for cryptographic operations either directly, or via its parent CryptoKey, in which case the server will choose the appropriate version for the operation.

For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt or decrypt data when an authorized user or application invokes Cloud KMS.

Defined Under Namespace

Modules: CryptoKeyVersionState

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ Google::Protobuf::Timestamp

Returns Output only. The time at which this CryptoKeyVersion was created.

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/resources.rb', line 120

class CryptoKeyVersion
  # The state of a {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}, indicating if it can be used.
  module CryptoKeyVersionState
    # Not specified.
    CRYPTO_KEY_VERSION_STATE_UNSPECIFIED = 0

    # This version may be used in {Google::Cloud::Kms::V1::KeyManagementService::Encrypt Encrypt} and
    # {Google::Cloud::Kms::V1::KeyManagementService::Decrypt Decrypt} requests.
    ENABLED = 1

    # This version may not be used, but the key material is still available,
    # and the version can be placed back into the {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::ENABLED ENABLED} state.
    DISABLED = 2

    # This version is destroyed, and the key material is no longer stored.
    # A version may not leave this state once entered.
    DESTROYED = 3

    # This version is scheduled for destruction, and will be destroyed soon.
    # Call
    # {Google::Cloud::Kms::V1::KeyManagementService::RestoreCryptoKeyVersion RestoreCryptoKeyVersion}
    # to put it back into the {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::DISABLED DISABLED} state.
    DESTROY_SCHEDULED = 4
  end
end

#destroy_event_time ⇒ Google::Protobuf::Timestamp

Returns Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/resources.rb', line 120

class CryptoKeyVersion
  # The state of a {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}, indicating if it can be used.
  module CryptoKeyVersionState
    # Not specified.
    CRYPTO_KEY_VERSION_STATE_UNSPECIFIED = 0

    # This version may be used in {Google::Cloud::Kms::V1::KeyManagementService::Encrypt Encrypt} and
    # {Google::Cloud::Kms::V1::KeyManagementService::Decrypt Decrypt} requests.
    ENABLED = 1

    # This version may not be used, but the key material is still available,
    # and the version can be placed back into the {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::ENABLED ENABLED} state.
    DISABLED = 2

    # This version is destroyed, and the key material is no longer stored.
    # A version may not leave this state once entered.
    DESTROYED = 3

    # This version is scheduled for destruction, and will be destroyed soon.
    # Call
    # {Google::Cloud::Kms::V1::KeyManagementService::RestoreCryptoKeyVersion RestoreCryptoKeyVersion}
    # to put it back into the {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::DISABLED DISABLED} state.
    DESTROY_SCHEDULED = 4
  end
end

#destroy_time ⇒ Google::Protobuf::Timestamp

Returns Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/resources.rb', line 120

class CryptoKeyVersion
  # The state of a {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}, indicating if it can be used.
  module CryptoKeyVersionState
    # Not specified.
    CRYPTO_KEY_VERSION_STATE_UNSPECIFIED = 0

    # This version may be used in {Google::Cloud::Kms::V1::KeyManagementService::Encrypt Encrypt} and
    # {Google::Cloud::Kms::V1::KeyManagementService::Decrypt Decrypt} requests.
    ENABLED = 1

    # This version may not be used, but the key material is still available,
    # and the version can be placed back into the {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::ENABLED ENABLED} state.
    DISABLED = 2

    # This version is destroyed, and the key material is no longer stored.
    # A version may not leave this state once entered.
    DESTROYED = 3

    # This version is scheduled for destruction, and will be destroyed soon.
    # Call
    # {Google::Cloud::Kms::V1::KeyManagementService::RestoreCryptoKeyVersion RestoreCryptoKeyVersion}
    # to put it back into the {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::DISABLED DISABLED} state.
    DESTROY_SCHEDULED = 4
  end
end

#name ⇒ String

Returns Output only. The resource name for this CryptoKeyVersion in the format +projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*+.

Returns:

  • (String) —

    Output only. The resource name for this CryptoKeyVersion in the format +projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*+.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/resources.rb', line 120

class CryptoKeyVersion
  # The state of a {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}, indicating if it can be used.
  module CryptoKeyVersionState
    # Not specified.
    CRYPTO_KEY_VERSION_STATE_UNSPECIFIED = 0

    # This version may be used in {Google::Cloud::Kms::V1::KeyManagementService::Encrypt Encrypt} and
    # {Google::Cloud::Kms::V1::KeyManagementService::Decrypt Decrypt} requests.
    ENABLED = 1

    # This version may not be used, but the key material is still available,
    # and the version can be placed back into the {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::ENABLED ENABLED} state.
    DISABLED = 2

    # This version is destroyed, and the key material is no longer stored.
    # A version may not leave this state once entered.
    DESTROYED = 3

    # This version is scheduled for destruction, and will be destroyed soon.
    # Call
    # {Google::Cloud::Kms::V1::KeyManagementService::RestoreCryptoKeyVersion RestoreCryptoKeyVersion}
    # to put it back into the {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::DISABLED DISABLED} state.
    DESTROY_SCHEDULED = 4
  end
end

#state ⇒ Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState

Returns The current state of the CryptoKeyVersion.

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/resources.rb', line 120

class CryptoKeyVersion
  # The state of a {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}, indicating if it can be used.
  module CryptoKeyVersionState
    # Not specified.
    CRYPTO_KEY_VERSION_STATE_UNSPECIFIED = 0

    # This version may be used in {Google::Cloud::Kms::V1::KeyManagementService::Encrypt Encrypt} and
    # {Google::Cloud::Kms::V1::KeyManagementService::Decrypt Decrypt} requests.
    ENABLED = 1

    # This version may not be used, but the key material is still available,
    # and the version can be placed back into the {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::ENABLED ENABLED} state.
    DISABLED = 2

    # This version is destroyed, and the key material is no longer stored.
    # A version may not leave this state once entered.
    DESTROYED = 3

    # This version is scheduled for destruction, and will be destroyed soon.
    # Call
    # {Google::Cloud::Kms::V1::KeyManagementService::RestoreCryptoKeyVersion RestoreCryptoKeyVersion}
    # to put it back into the {Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::DISABLED DISABLED} state.
    DESTROY_SCHEDULED = 4
  end
end