GetCryptoKeyResult

data class GetCryptoKeyResult(val createTime: String, val cryptoKeyBackend: String, val destroyScheduledDuration: String, val importOnly: Boolean, val labels: Map<String, String>, val name: String, val nextRotationTime: String, val primary: CryptoKeyVersionResponse, val purpose: String, val rotationPeriod: String, val versionTemplate: CryptoKeyVersionTemplateResponse)

Constructors

Link copied to clipboard
fun GetCryptoKeyResult(createTime: String, cryptoKeyBackend: String, destroyScheduledDuration: String, importOnly: Boolean, labels: Map<String, String>, name: String, nextRotationTime: String, primary: CryptoKeyVersionResponse, purpose: String, rotationPeriod: String, versionTemplate: CryptoKeyVersionTemplateResponse)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The time at which this CryptoKey was created.

Link copied to clipboard

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, 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.

Link copied to clipboard

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.

Link copied to clipboard

Immutable. Whether this key may contain imported versions only.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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 and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.

Link copied to clipboard

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.

Link copied to clipboard

Immutable. The immutable purpose of this CryptoKey.

Link copied to clipboard

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.

Link copied to clipboard

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. //////*/