Class: Google::Cloud::Kms::V1::CryptoKey
- Inherits:
-
Object
- Object
- Google::Cloud::Kms::V1::CryptoKey
- Defined in:
- lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/resources.rb
Overview
Defined Under Namespace
Modules: CryptoKeyPurpose
Instance Attribute Summary collapse
-
#create_time ⇒ Google::Protobuf::Timestamp
Output only.
-
#labels ⇒ Hash{String => String}
Labels with user-defined metadata.
-
#name ⇒ String
Output only.
-
#next_rotation_time ⇒ Google::Protobuf::Timestamp
At next_rotation_time, the Key Management Service will automatically:.
-
#primary ⇒ Google::Cloud::Kms::V1::CryptoKeyVersion
Output only.
-
#purpose ⇒ Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose
The immutable purpose of this CryptoKey.
-
#rotation_period ⇒ Google::Protobuf::Duration
next_rotation_time will be advanced by this period when the service automatically rotates a key.
Instance Attribute Details
#create_time ⇒ Google::Protobuf::Timestamp
Returns Output only. The time at which this CryptoKey was created.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/resources.rb', line 74 class CryptoKey # {Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} describes the capabilities of a {Google::Cloud::Kms::V1::CryptoKey CryptoKey}. Two # keys with the same purpose may use different underlying algorithms, but # must support the same set of operations. module CryptoKeyPurpose # Not specified. CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0 # {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {Google::Cloud::Kms::V1::KeyManagementService::Encrypt Encrypt} and # {Google::Cloud::Kms::V1::KeyManagementService::Decrypt Decrypt}. ENCRYPT_DECRYPT = 1 end end |
#labels ⇒ Hash{String => String}
Returns Labels with user-defined metadata. For more information, see Labeling Keys.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/resources.rb', line 74 class CryptoKey # {Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} describes the capabilities of a {Google::Cloud::Kms::V1::CryptoKey CryptoKey}. Two # keys with the same purpose may use different underlying algorithms, but # must support the same set of operations. module CryptoKeyPurpose # Not specified. CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0 # {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {Google::Cloud::Kms::V1::KeyManagementService::Encrypt Encrypt} and # {Google::Cloud::Kms::V1::KeyManagementService::Decrypt Decrypt}. ENCRYPT_DECRYPT = 1 end end |
#name ⇒ String
Returns Output only. The resource name for this CryptoKey in the format +projects//locations//keyRings//cryptoKeys/+.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/resources.rb', line 74 class CryptoKey # {Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} describes the capabilities of a {Google::Cloud::Kms::V1::CryptoKey CryptoKey}. Two # keys with the same purpose may use different underlying algorithms, but # must support the same set of operations. module CryptoKeyPurpose # Not specified. CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0 # {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {Google::Cloud::Kms::V1::KeyManagementService::Encrypt Encrypt} and # {Google::Cloud::Kms::V1::KeyManagementService::Decrypt Decrypt}. ENCRYPT_DECRYPT = 1 end end |
#next_rotation_time ⇒ Google::Protobuf::Timestamp
Returns At next_rotation_time, the Key Management Service will automatically:
- Create a new version of this CryptoKey.
- Mark the new version as primary.
Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/resources.rb', line 74 class CryptoKey # {Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} describes the capabilities of a {Google::Cloud::Kms::V1::CryptoKey CryptoKey}. Two # keys with the same purpose may use different underlying algorithms, but # must support the same set of operations. module CryptoKeyPurpose # Not specified. CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0 # {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {Google::Cloud::Kms::V1::KeyManagementService::Encrypt Encrypt} and # {Google::Cloud::Kms::V1::KeyManagementService::Decrypt Decrypt}. ENCRYPT_DECRYPT = 1 end end |
#primary ⇒ Google::Cloud::Kms::V1::CryptoKeyVersion
Returns Output only. A copy of the "primary" CryptoKeyVersion that will be used by Encrypt when this CryptoKey is given in EncryptRequest#name.
The CryptoKey's primary version can be updated via UpdateCryptoKeyPrimaryVersion.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/resources.rb', line 74 class CryptoKey # {Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} describes the capabilities of a {Google::Cloud::Kms::V1::CryptoKey CryptoKey}. Two # keys with the same purpose may use different underlying algorithms, but # must support the same set of operations. module CryptoKeyPurpose # Not specified. CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0 # {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {Google::Cloud::Kms::V1::KeyManagementService::Encrypt Encrypt} and # {Google::Cloud::Kms::V1::KeyManagementService::Decrypt Decrypt}. ENCRYPT_DECRYPT = 1 end end |
#purpose ⇒ Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose
Returns The immutable purpose of this CryptoKey. Currently, the only acceptable purpose is ENCRYPT_DECRYPT.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/resources.rb', line 74 class CryptoKey # {Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} describes the capabilities of a {Google::Cloud::Kms::V1::CryptoKey CryptoKey}. Two # keys with the same purpose may use different underlying algorithms, but # must support the same set of operations. module CryptoKeyPurpose # Not specified. CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0 # {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {Google::Cloud::Kms::V1::KeyManagementService::Encrypt Encrypt} and # {Google::Cloud::Kms::V1::KeyManagementService::Decrypt Decrypt}. ENCRYPT_DECRYPT = 1 end end |
#rotation_period ⇒ Google::Protobuf::Duration
Returns next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least one day.
If rotation_period is set, next_rotation_time must also be set.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/resources.rb', line 74 class CryptoKey # {Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} describes the capabilities of a {Google::Cloud::Kms::V1::CryptoKey CryptoKey}. Two # keys with the same purpose may use different underlying algorithms, but # must support the same set of operations. module CryptoKeyPurpose # Not specified. CRYPTO_KEY_PURPOSE_UNSPECIFIED = 0 # {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {Google::Cloud::Kms::V1::KeyManagementService::Encrypt Encrypt} and # {Google::Cloud::Kms::V1::KeyManagementService::Decrypt Decrypt}. ENCRYPT_DECRYPT = 1 end end |