com.google.cloud.kms.v1.resources

Value parameters

createTime

Output only. The time at which this [CryptoKey][google.cloud.kms.v1.CryptoKey] was created.

cryptoKeyBackend

Immutable. The resource name of the backend environment where the key material for all [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] associated with this [CryptoKey][google.cloud.kms.v1.CryptoKey] reside and where all related cryptographic operations are performed. Only applicable if [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] have a [ProtectionLevel][google.cloud.kms.v1.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][google.cloud.kms.v1.ProtectionLevel] in the future.

destroyScheduledDuration

Immutable. The period of time that versions of this key spend in the [DESTROY_SCHEDULED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROY_SCHEDULED] state before transitioning to [DESTROYED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROYED]. If not specified at creation time, the default duration is 24 hours.

importOnly

Immutable. Whether this key may contain imported versions only.

labels

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

name

Output only. The resource name for this [CryptoKey][google.cloud.kms.v1.CryptoKey] in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

nextRotationTime

At [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time], the Key Management Service will automatically:

1. Create a new version of this [CryptoKey][google.cloud.kms.v1.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][google.cloud.kms.v1.CryptoKey.next_rotation_time]. Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose] [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT] support automatic rotation. For other keys, this field must be omitted.

primary

Output only. A copy of the "primary" [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] that will be used by [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] when this [CryptoKey][google.cloud.kms.v1.CryptoKey] is given in [EncryptRequest.name][google.cloud.kms.v1.EncryptRequest.name]. The [CryptoKey][google.cloud.kms.v1.CryptoKey]'s primary version can be updated via [UpdateCryptoKeyPrimaryVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersion]. Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose] [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT] may have a primary. For other keys, this field will be omitted.

purpose

Immutable. The immutable purpose of this [CryptoKey][google.cloud.kms.v1.CryptoKey].

versionTemplate

A template describing settings for new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] instances. The properties of new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] instances created by either [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion] or auto-rotation are controlled by this template.

Attributes

Companion

object

Source

CryptoKey.scala

Supertypes

trait Updatable[CryptoKey]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Companion

class

Source

CryptoKey.scala

Supertypes

trait Product

trait Mirror

trait GeneratedMessageCompanion[CryptoKey]

trait Serializable

class Object

trait Matchable

class Any

Show all

Self type

CryptoKey.type

Value parameters

algorithm

Output only. The [CryptoKeyVersionAlgorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm] that this [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] supports.

attestation

Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with [protection_level][google.cloud.kms.v1.CryptoKeyVersion.protection_level] [HSM][google.cloud.kms.v1.ProtectionLevel.HSM].

createTime

Output only. The time at which this [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] was created.

destroyEventTime

Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if [state][google.cloud.kms.v1.CryptoKeyVersion.state] is [DESTROYED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROYED].

destroyTime

Output only. The time this [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]'s key material is scheduled for destruction. Only present if [state][google.cloud.kms.v1.CryptoKeyVersion.state] is [DESTROY_SCHEDULED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROY_SCHEDULED].

externalDestructionFailureReason

Output only. The root cause of the most recent external destruction failure. Only present if [state][google.cloud.kms.v1.CryptoKeyVersion.state] is [EXTERNAL_DESTRUCTION_FAILED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.EXTERNAL_DESTRUCTION_FAILED].

externalProtectionLevelOptions

ExternalProtectionLevelOptions stores a group of additional fields for configuring a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] that are specific to the [EXTERNAL][google.cloud.kms.v1.ProtectionLevel.EXTERNAL] protection level and [EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC] protection levels.

generateTime

Output only. The time this [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]'s key material was generated.

generationFailureReason

Output only. The root cause of the most recent generation failure. Only present if [state][google.cloud.kms.v1.CryptoKeyVersion.state] is [GENERATION_FAILED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.GENERATION_FAILED].

importFailureReason

Output only. The root cause of the most recent import failure. Only present if [state][google.cloud.kms.v1.CryptoKeyVersion.state] is [IMPORT_FAILED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.IMPORT_FAILED].

importJob

Output only. The name of the [ImportJob][google.cloud.kms.v1.ImportJob] used in the most recent import of this [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]. Only present if the underlying key material was imported.

importTime

Output only. The time at which this [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]'s key material was most recently imported.

name

Output only. The resource name for this [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.

protectionLevel

Output only. The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] describing how crypto operations are performed with this [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].

reimportEligible

Output only. Whether or not this key version is eligible for reimport, by being specified as a target in [ImportCryptoKeyVersionRequest.crypto_key_version][google.cloud.kms.v1.ImportCryptoKeyVersionRequest.crypto_key_version].

state

The current state of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].

Attributes

Companion

object

Source

CryptoKeyVersion.scala

Supertypes

trait Updatable[CryptoKeyVersion]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Companion

class

Source

CryptoKeyVersion.scala

Supertypes

trait Product

trait Mirror

trait GeneratedMessageCompanion[CryptoKeyVersion]

trait Serializable

class Object

trait Matchable

class Any

Show all

Self type

CryptoKeyVersion.type

Value parameters

algorithm

Required. [Algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm] to use when creating a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] based on this template. For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted and [CryptoKey.purpose][google.cloud.kms.v1.CryptoKey.purpose] is [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT].

protectionLevel

[ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] to use when creating a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] based on this template. Immutable. Defaults to [SOFTWARE][google.cloud.kms.v1.ProtectionLevel.SOFTWARE].

Attributes

Companion

object

Source

CryptoKeyVersionTemplate.scala

Supertypes

trait Updatable[CryptoKeyVersionTemplate]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Companion

class

Source

CryptoKeyVersionTemplate.scala

Supertypes

trait Product

trait Mirror

trait GeneratedMessageCompanion[CryptoKeyVersionTemplate]

trait Serializable

class Object

trait Matchable

class Any

Show all

Self type

CryptoKeyVersionTemplate.type

Value parameters

ekmConnectionKeyPath

The path to the external key material on the EKM when using [EkmConnection][google.cloud.kms.v1.EkmConnection] e.g., "v0/my/key". Set this field instead of external_key_uri when using an [EkmConnection][google.cloud.kms.v1.EkmConnection].

externalKeyUri

The URI for an external resource that this [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] represents.

Attributes

Companion

object

Source

ExternalProtectionLevelOptions.scala

Supertypes

trait Updatable[ExternalProtectionLevelOptions]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Companion

class

Source

ExternalProtectionLevelOptions.scala

Supertypes

trait Product

trait Mirror

trait GeneratedMessageCompanion[ExternalProtectionLevelOptions]

trait Serializable

class Object

trait Matchable

class Any

Show all

Self type

ExternalProtectionLevelOptions.type

Value parameters

attestation

Output only. Statement that was generated and signed by the key creator (for example, an HSM) at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only present if the chosen [ImportMethod][google.cloud.kms.v1.ImportJob.ImportMethod] is one with a protection level of [HSM][google.cloud.kms.v1.ProtectionLevel.HSM].

createTime

Output only. The time at which this [ImportJob][google.cloud.kms.v1.ImportJob] was created.

expireEventTime

Output only. The time this [ImportJob][google.cloud.kms.v1.ImportJob] expired. Only present if [state][google.cloud.kms.v1.ImportJob.state] is [EXPIRED][google.cloud.kms.v1.ImportJob.ImportJobState.EXPIRED].

expireTime

Output only. The time at which this [ImportJob][google.cloud.kms.v1.ImportJob] is scheduled for expiration and can no longer be used to import key material.

generateTime

Output only. The time this [ImportJob][google.cloud.kms.v1.ImportJob]'s key material was generated.

importMethod

Required. Immutable. The wrapping method to be used for incoming key material.

name

Output only. The resource name for this [ImportJob][google.cloud.kms.v1.ImportJob] in the format projects/*/locations/*/keyRings/*/importJobs/*.

protectionLevel

Required. Immutable. The protection level of the [ImportJob][google.cloud.kms.v1.ImportJob]. This must match the [protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level] of the [version_template][google.cloud.kms.v1.CryptoKey.version_template] on the [CryptoKey][google.cloud.kms.v1.CryptoKey] you attempt to import into.

publicKey

Output only. The public key with which to wrap key material prior to import. Only returned if [state][google.cloud.kms.v1.ImportJob.state] is [ACTIVE][google.cloud.kms.v1.ImportJob.ImportJobState.ACTIVE].

state

Output only. The current state of the [ImportJob][google.cloud.kms.v1.ImportJob], indicating if it can be used.

Attributes

Companion

object

Source

ImportJob.scala

Supertypes

trait Updatable[ImportJob]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Companion

class

Source

ImportJob.scala

Supertypes

trait Product

trait Mirror

trait GeneratedMessageCompanion[ImportJob]

trait Serializable

class Object

trait Matchable

class Any

Show all

Self type

ImportJob.type

Value parameters

certChains

Output only. The certificate chains needed to validate the attestation

content

Output only. The attestation data provided by the HSM when the key operation was performed.

format

Output only. The format of the attestation data.

Attributes

Companion

object

Source

KeyOperationAttestation.scala

Supertypes

trait Updatable[KeyOperationAttestation]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Companion

class

Source

KeyOperationAttestation.scala

Supertypes

trait Product

trait Mirror

trait GeneratedMessageCompanion[KeyOperationAttestation]

trait Serializable

class Object

trait Matchable

class Any

Show all

Self type

KeyOperationAttestation.type

Value parameters

createTime

Output only. The time at which this [KeyRing][google.cloud.kms.v1.KeyRing] was created.

name

Output only. The resource name for the [KeyRing][google.cloud.kms.v1.KeyRing] in the format projects/*/locations/*/keyRings/*.

Attributes

Companion

object

Source

KeyRing.scala

Supertypes

trait Updatable[KeyRing]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Companion

class

Source

KeyRing.scala

Supertypes

trait Product

trait Mirror

trait GeneratedMessageCompanion[KeyRing]

trait Serializable

class Object

trait Matchable

class Any

Show all

Self type

KeyRing.type

Attributes

Companion

object

Source

ProtectionLevel.scala

Supertypes

trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Known subtypes

object EXTERNAL.type

object EXTERNAL_VPC.type

object HSM.type

object PROTECTION_LEVEL_UNSPECIFIED.type

trait Recognized

object SOFTWARE.type

class Unrecognized

Show all

Attributes

Companion

class

Source

ProtectionLevel.scala

Supertypes

trait Sum

trait Mirror

trait GeneratedEnumCompanion[ProtectionLevel]

trait Serializable

class Object

trait Matchable

class Any

Show all

Self type

ProtectionLevel.type

Value parameters

algorithm

The [Algorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm] associated with this key.

name

The [name][google.cloud.kms.v1.CryptoKeyVersion.name] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key. Provided here for verification. NOTE: This field is in Beta.

pem

The public key, encoded in PEM format. For more information, see the RFC 7468 sections for General Considerations and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13).

pemCrc32C

Integrity verification field. A CRC32C checksum of the returned [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem]. An integrity check of [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem] can be performed by computing the CRC32C checksum of [PublicKey.pem][google.cloud.kms.v1.PublicKey.pem] and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta.

protectionLevel

The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key.

Attributes

Companion

object

Source

PublicKey.scala

Supertypes

trait Updatable[PublicKey]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any

Show all

Attributes

Companion

class

Source

PublicKey.scala

Supertypes

trait Product

trait Mirror

trait GeneratedMessageCompanion[PublicKey]

trait Serializable

class Object

trait Matchable

class Any

Show all

Self type

PublicKey.type

Attributes

Source

ResourcesProto.scala

Supertypes

class GeneratedFileObject

class Object

trait Matchable

class Any

Self type

ResourcesProto.type