Class: Google::Cloud::Kms::V1::CryptoKey

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

Overview

A CryptoKey represents a logical key that can be used for cryptographic operations.

A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations.

Defined Under Namespace

Modules: CryptoKeyPurpose Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

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

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

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140

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 [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] and
    # [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt].
    ENCRYPT_DECRYPT = 1

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_SIGN = 5

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricDecrypt][google.cloud.kms.v1.KeyManagementService.AsymmetricDecrypt]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_DECRYPT = 6

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [RawEncrypt][google.cloud.kms.v1.KeyManagementService.RawEncrypt]
    # and [RawDecrypt][google.cloud.kms.v1.KeyManagementService.RawDecrypt].
    # This purpose is meant to be used for interoperable symmetric
    # encryption and does not support automatic CryptoKey rotation.
    RAW_ENCRYPT_DECRYPT = 7

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [MacSign][google.cloud.kms.v1.KeyManagementService.MacSign].
    MAC = 9
  end
end

#crypto_key_backend ⇒ ::String

Returns Immutable. The resource name of the backend environment where the key material for all CryptoKeyVersions associated with this CryptoKey reside and where all related cryptographic operations are performed. Only applicable if CryptoKeyVersions have a ProtectionLevel of [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], with the resource name in the format projects/*/locations/*/ekmConnections/*. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future.

Returns:

  • (::String) —

    Immutable. The resource name of the backend environment where the key material for all CryptoKeyVersions associated with this CryptoKey reside and where all related cryptographic operations are performed. Only applicable if CryptoKeyVersions have a ProtectionLevel of [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], with the resource name in the format projects/*/locations/*/ekmConnections/*. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140

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 [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] and
    # [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt].
    ENCRYPT_DECRYPT = 1

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_SIGN = 5

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricDecrypt][google.cloud.kms.v1.KeyManagementService.AsymmetricDecrypt]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_DECRYPT = 6

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [RawEncrypt][google.cloud.kms.v1.KeyManagementService.RawEncrypt]
    # and [RawDecrypt][google.cloud.kms.v1.KeyManagementService.RawDecrypt].
    # This purpose is meant to be used for interoperable symmetric
    # encryption and does not support automatic CryptoKey rotation.
    RAW_ENCRYPT_DECRYPT = 7

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [MacSign][google.cloud.kms.v1.KeyManagementService.MacSign].
    MAC = 9
  end
end

#destroy_scheduled_duration ⇒ ::Google::Protobuf::Duration

Returns Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 24 hours.

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140

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 [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] and
    # [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt].
    ENCRYPT_DECRYPT = 1

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_SIGN = 5

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricDecrypt][google.cloud.kms.v1.KeyManagementService.AsymmetricDecrypt]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_DECRYPT = 6

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [RawEncrypt][google.cloud.kms.v1.KeyManagementService.RawEncrypt]
    # and [RawDecrypt][google.cloud.kms.v1.KeyManagementService.RawDecrypt].
    # This purpose is meant to be used for interoperable symmetric
    # encryption and does not support automatic CryptoKey rotation.
    RAW_ENCRYPT_DECRYPT = 7

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [MacSign][google.cloud.kms.v1.KeyManagementService.MacSign].
    MAC = 9
  end
end

#import_only ⇒ ::Boolean

Returns Immutable. Whether this key may contain imported versions only.

Returns:

  • (::Boolean) —

    Immutable. Whether this key may contain imported versions only.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140

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 [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] and
    # [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt].
    ENCRYPT_DECRYPT = 1

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_SIGN = 5

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricDecrypt][google.cloud.kms.v1.KeyManagementService.AsymmetricDecrypt]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_DECRYPT = 6

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [RawEncrypt][google.cloud.kms.v1.KeyManagementService.RawEncrypt]
    # and [RawDecrypt][google.cloud.kms.v1.KeyManagementService.RawDecrypt].
    # This purpose is meant to be used for interoperable symmetric
    # encryption and does not support automatic CryptoKey rotation.
    RAW_ENCRYPT_DECRYPT = 7

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [MacSign][google.cloud.kms.v1.KeyManagementService.MacSign].
    MAC = 9
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Labels with user-defined metadata. For more information, see Labeling Keys.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Labels with user-defined metadata. For more information, see Labeling Keys.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140

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 [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] and
    # [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt].
    ENCRYPT_DECRYPT = 1

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_SIGN = 5

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricDecrypt][google.cloud.kms.v1.KeyManagementService.AsymmetricDecrypt]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_DECRYPT = 6

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [RawEncrypt][google.cloud.kms.v1.KeyManagementService.RawEncrypt]
    # and [RawDecrypt][google.cloud.kms.v1.KeyManagementService.RawDecrypt].
    # This purpose is meant to be used for interoperable symmetric
    # encryption and does not support automatic CryptoKey rotation.
    RAW_ENCRYPT_DECRYPT = 7

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [MacSign][google.cloud.kms.v1.KeyManagementService.MacSign].
    MAC = 9
  end
end

#name ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140

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 [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] and
    # [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt].
    ENCRYPT_DECRYPT = 1

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_SIGN = 5

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricDecrypt][google.cloud.kms.v1.KeyManagementService.AsymmetricDecrypt]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_DECRYPT = 6

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [RawEncrypt][google.cloud.kms.v1.KeyManagementService.RawEncrypt]
    # and [RawDecrypt][google.cloud.kms.v1.KeyManagementService.RawDecrypt].
    # This purpose is meant to be used for interoperable symmetric
    # encryption and does not support automatic CryptoKey rotation.
    RAW_ENCRYPT_DECRYPT = 7

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [MacSign][google.cloud.kms.v1.KeyManagementService.MacSign].
    MAC = 9
  end
end

#next_rotation_time ⇒ ::Google::Protobuf::Timestamp

Returns At next_rotation_time, the Key Management Service will automatically:

  1. Create a new version of this CryptoKey.
  2. Mark the new version as primary.

Key rotations performed manually via [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion] and [UpdateCryptoKeyPrimaryVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersion] do not affect next_rotation_time.

Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.

Returns:

  • (::Google::Protobuf::Timestamp) —

    At next_rotation_time, the Key Management Service will automatically:

    1. Create a new version of this CryptoKey.
    2. Mark the new version as primary.

    Key rotations performed manually via [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion] and [UpdateCryptoKeyPrimaryVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersion] do not affect next_rotation_time.

    Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140

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 [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] and
    # [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt].
    ENCRYPT_DECRYPT = 1

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_SIGN = 5

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricDecrypt][google.cloud.kms.v1.KeyManagementService.AsymmetricDecrypt]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_DECRYPT = 6

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [RawEncrypt][google.cloud.kms.v1.KeyManagementService.RawEncrypt]
    # and [RawDecrypt][google.cloud.kms.v1.KeyManagementService.RawDecrypt].
    # This purpose is meant to be used for interoperable symmetric
    # encryption and does not support automatic CryptoKey rotation.
    RAW_ENCRYPT_DECRYPT = 7

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [MacSign][google.cloud.kms.v1.KeyManagementService.MacSign].
    MAC = 9
  end
end

#primary ⇒ ::Google::Cloud::Kms::V1::CryptoKeyVersion (readonly)

Returns Output only. A copy of the "primary" CryptoKeyVersion that will be used by [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] when this CryptoKey is given in [EncryptRequest.name][google.cloud.kms.v1.EncryptRequest.name].

The CryptoKey's primary version can be updated via [UpdateCryptoKeyPrimaryVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersion].

Keys with purpose ENCRYPT_DECRYPT may have a primary. For other keys, this field will be omitted.

Returns:

  • (::Google::Cloud::Kms::V1::CryptoKeyVersion) —

    Output only. A copy of the "primary" CryptoKeyVersion that will be used by [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] when this CryptoKey is given in [EncryptRequest.name][google.cloud.kms.v1.EncryptRequest.name].

    The CryptoKey's primary version can be updated via [UpdateCryptoKeyPrimaryVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersion].

    Keys with purpose ENCRYPT_DECRYPT may have a primary. For other keys, this field will be omitted.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140

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 [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] and
    # [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt].
    ENCRYPT_DECRYPT = 1

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_SIGN = 5

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricDecrypt][google.cloud.kms.v1.KeyManagementService.AsymmetricDecrypt]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_DECRYPT = 6

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [RawEncrypt][google.cloud.kms.v1.KeyManagementService.RawEncrypt]
    # and [RawDecrypt][google.cloud.kms.v1.KeyManagementService.RawDecrypt].
    # This purpose is meant to be used for interoperable symmetric
    # encryption and does not support automatic CryptoKey rotation.
    RAW_ENCRYPT_DECRYPT = 7

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [MacSign][google.cloud.kms.v1.KeyManagementService.MacSign].
    MAC = 9
  end
end

#purpose ⇒ ::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose

Returns Immutable. The immutable purpose of this CryptoKey.

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140

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 [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] and
    # [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt].
    ENCRYPT_DECRYPT = 1

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_SIGN = 5

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricDecrypt][google.cloud.kms.v1.KeyManagementService.AsymmetricDecrypt]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_DECRYPT = 6

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [RawEncrypt][google.cloud.kms.v1.KeyManagementService.RawEncrypt]
    # and [RawDecrypt][google.cloud.kms.v1.KeyManagementService.RawDecrypt].
    # This purpose is meant to be used for interoperable symmetric
    # encryption and does not support automatic CryptoKey rotation.
    RAW_ENCRYPT_DECRYPT = 7

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [MacSign][google.cloud.kms.v1.KeyManagementService.MacSign].
    MAC = 9
  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.

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140

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 [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] and
    # [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt].
    ENCRYPT_DECRYPT = 1

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_SIGN = 5

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricDecrypt][google.cloud.kms.v1.KeyManagementService.AsymmetricDecrypt]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_DECRYPT = 6

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [RawEncrypt][google.cloud.kms.v1.KeyManagementService.RawEncrypt]
    # and [RawDecrypt][google.cloud.kms.v1.KeyManagementService.RawDecrypt].
    # This purpose is meant to be used for interoperable symmetric
    # encryption and does not support automatic CryptoKey rotation.
    RAW_ENCRYPT_DECRYPT = 7

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [MacSign][google.cloud.kms.v1.KeyManagementService.MacSign].
    MAC = 9
  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][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion] or auto-rotation are controlled by this template.

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'proto_docs/google/cloud/kms/v1/resources.rb', line 140

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 [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] and
    # [Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt].
    ENCRYPT_DECRYPT = 1

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_SIGN = 5

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with
    # [AsymmetricDecrypt][google.cloud.kms.v1.KeyManagementService.AsymmetricDecrypt]
    # and
    # [GetPublicKey][google.cloud.kms.v1.KeyManagementService.GetPublicKey].
    ASYMMETRIC_DECRYPT = 6

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [RawEncrypt][google.cloud.kms.v1.KeyManagementService.RawEncrypt]
    # and [RawDecrypt][google.cloud.kms.v1.KeyManagementService.RawDecrypt].
    # This purpose is meant to be used for interoperable symmetric
    # encryption and does not support automatic CryptoKey rotation.
    RAW_ENCRYPT_DECRYPT = 7

    # {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with this purpose may be used
    # with [MacSign][google.cloud.kms.v1.KeyManagementService.MacSign].
    MAC = 9
  end
end