GetCryptoKeyResult class

Result data returned by getCryptoKey.

Constructors

GetCryptoKeyResult({required String createTime, required String cryptoKeyBackend, required String destroyScheduledDuration, required bool importOnly, required Map<String, String> labels, required String name, required String nextRotationTime, required CryptoKeyVersionResponse primary, required String purpose, required String rotationPeriod, required CryptoKeyVersionTemplateResponse versionTemplate})
Creates a new GetCryptoKeyResult. createTime The time at which this CryptoKey was created. cryptoKeyBackend 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. destroyScheduledDuration 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. importOnly Immutable. Whether this key may contain imported versions only. labels Labels with user-defined metadata. For more information, see Labeling Keys. name The resource name for this CryptoKey in the format projects/*/locations/*/keyRings/*/cryptoKeys/*. nextRotationTime 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. primary 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. purpose Immutable. The immutable purpose of this CryptoKey. rotationPeriod 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. versionTemplate 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.
const
GetCryptoKeyResult.fromMap(Map<String, dynamic> map)
factory

Properties

createTime → String
The time at which this CryptoKey was created.
final
cryptoKeyBackend → 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, 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.
final
destroyScheduledDuration → String
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.
final
hashCode → int
The hash code for this object.
no setterinherited
importOnly → bool
Immutable. Whether this key may contain imported versions only.
final
labels → Map<String, String>
Labels with user-defined metadata. For more information, see Labeling Keys.
final
name → String
The resource name for this CryptoKey in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.
final
nextRotationTime → String
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.
final
primary → CryptoKeyVersionResponse
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.
final
purpose → String
Immutable. The immutable purpose of this CryptoKey.
final
rotationPeriod → String
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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
versionTemplate → CryptoKeyVersionTemplateResponse
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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited