Class: Google::Cloud::Kms::V1::CryptoKey
- Inherits:
-
Object
- Object
- Google::Cloud::Kms::V1::CryptoKey
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/kms/v1/resources.rb
Overview
Defined Under Namespace
Modules: CryptoKeyPurpose Classes: LabelsEntry
Instance Attribute Summary collapse
-
#create_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Labels with user-defined metadata.
-
#name ⇒ ::String
readonly
Output only.
-
#next_rotation_time ⇒ ::Google::Protobuf::Timestamp
At next_rotation_time, the Key Management Service will automatically:.
-
#primary ⇒ ::Google::Cloud::Kms::V1::CryptoKeyVersion
readonly
Output only.
-
#purpose ⇒ ::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose
Immutable.
-
#rotation_period ⇒ ::Google::Protobuf::Duration
next_rotation_time will be advanced by this period when the service automatically rotates a key.
-
#version_template ⇒ ::Google::Cloud::Kms::V1::CryptoKeyVersionTemplate
A template describing settings for new CryptoKeyVersion instances.
Instance Attribute Details
#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The time at which this CryptoKey was created.
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 |
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 100 class CryptoKey include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} describes the cryptographic capabilities of a # {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used for the operations allowed by # its purpose. For more information, see # [Key purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes). 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::Client#encrypt Encrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}. ENCRYPT_DECRYPT = 1 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_SIGN = 5 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_DECRYPT = 6 end end |
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Returns Labels with user-defined metadata. For more information, see Labeling Keys.
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 |
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 100 class CryptoKey include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} describes the cryptographic capabilities of a # {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used for the operations allowed by # its purpose. For more information, see # [Key purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes). 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::Client#encrypt Encrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}. ENCRYPT_DECRYPT = 1 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_SIGN = 5 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_DECRYPT = 6 end end |
#name ⇒ ::String (readonly)
Returns Output only. The resource name for this CryptoKey in the format
projects/*/locations/*/keyRings/*/cryptoKeys/*
.
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 |
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 100 class CryptoKey include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} describes the cryptographic capabilities of a # {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used for the operations allowed by # its purpose. For more information, see # [Key purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes). 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::Client#encrypt Encrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}. ENCRYPT_DECRYPT = 1 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_SIGN = 5 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_DECRYPT = 6 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.
Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 |
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 100 class CryptoKey include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} describes the cryptographic capabilities of a # {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used for the operations allowed by # its purpose. For more information, see # [Key purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes). 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::Client#encrypt Encrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}. ENCRYPT_DECRYPT = 1 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_SIGN = 5 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_DECRYPT = 6 end end |
#primary ⇒ ::Google::Cloud::Kms::V1::CryptoKeyVersion (readonly)
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.
Keys with purpose ENCRYPT_DECRYPT may have a primary. For other keys, this field will be omitted.
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 |
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 100 class CryptoKey include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} describes the cryptographic capabilities of a # {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used for the operations allowed by # its purpose. For more information, see # [Key purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes). 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::Client#encrypt Encrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}. ENCRYPT_DECRYPT = 1 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_SIGN = 5 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_DECRYPT = 6 end end |
#purpose ⇒ ::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose
Returns Immutable. The immutable purpose of this CryptoKey.
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 |
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 100 class CryptoKey include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} describes the cryptographic capabilities of a # {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used for the operations allowed by # its purpose. For more information, see # [Key purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes). 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::Client#encrypt Encrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}. ENCRYPT_DECRYPT = 1 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_SIGN = 5 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_DECRYPT = 6 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 24 hours and at most 876,000 hours.
If rotation_period is set, next_rotation_time must also be set.
Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 |
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 100 class CryptoKey include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} describes the cryptographic capabilities of a # {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used for the operations allowed by # its purpose. For more information, see # [Key purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes). 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::Client#encrypt Encrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}. ENCRYPT_DECRYPT = 1 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_SIGN = 5 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_DECRYPT = 6 end end |
#version_template ⇒ ::Google::Cloud::Kms::V1::CryptoKeyVersionTemplate
Returns A template describing settings for new CryptoKeyVersion instances. The properties of new CryptoKeyVersion instances created by either CreateCryptoKeyVersion or auto-rotation are controlled by this template.
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 |
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 100 class CryptoKey include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose CryptoKeyPurpose} describes the cryptographic capabilities of a # {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}. A given key can only be used for the operations allowed by # its purpose. For more information, see # [Key purposes](https://cloud.google.com/kms/docs/algorithms#key_purposes). 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::Client#encrypt Encrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#decrypt Decrypt}. ENCRYPT_DECRYPT = 1 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_sign AsymmetricSign} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_SIGN = 5 # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used with # {::Google::Cloud::Kms::V1::KeyManagementService::Client#asymmetric_decrypt AsymmetricDecrypt} and # {::Google::Cloud::Kms::V1::KeyManagementService::Client#get_public_key GetPublicKey}. ASYMMETRIC_DECRYPT = 6 end end |