public final class CryptoKeyVersion extends GeneratedMessageV3 implements CryptoKeyVersionOrBuilder
A CryptoKeyVersion represents an
individual cryptographic key, and the associated key material.
An
ENABLED
version can be used for cryptographic operations.
For security reasons, the raw cryptographic key material represented by a
CryptoKeyVersion can never be viewed
or exported. It can only be used to encrypt, decrypt, or sign data when an
authorized user or application invokes Cloud KMS.
Protobuf type google.cloud.kms.v1.CryptoKeyVersion
Static Fields
ALGORITHM_FIELD_NUMBER
public static final int ALGORITHM_FIELD_NUMBER
Field Value
ATTESTATION_FIELD_NUMBER
public static final int ATTESTATION_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DESTROY_EVENT_TIME_FIELD_NUMBER
public static final int DESTROY_EVENT_TIME_FIELD_NUMBER
Field Value
DESTROY_TIME_FIELD_NUMBER
public static final int DESTROY_TIME_FIELD_NUMBER
Field Value
EXTERNAL_PROTECTION_LEVEL_OPTIONS_FIELD_NUMBER
public static final int EXTERNAL_PROTECTION_LEVEL_OPTIONS_FIELD_NUMBER
Field Value
GENERATE_TIME_FIELD_NUMBER
public static final int GENERATE_TIME_FIELD_NUMBER
Field Value
IMPORT_FAILURE_REASON_FIELD_NUMBER
public static final int IMPORT_FAILURE_REASON_FIELD_NUMBER
Field Value
IMPORT_JOB_FIELD_NUMBER
public static final int IMPORT_JOB_FIELD_NUMBER
Field Value
IMPORT_TIME_FIELD_NUMBER
public static final int IMPORT_TIME_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PROTECTION_LEVEL_FIELD_NUMBER
public static final int PROTECTION_LEVEL_FIELD_NUMBER
Field Value
REIMPORT_ELIGIBLE_FIELD_NUMBER
public static final int REIMPORT_ELIGIBLE_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static CryptoKeyVersion getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static CryptoKeyVersion.Builder newBuilder()
Returns
newBuilder(CryptoKeyVersion prototype)
public static CryptoKeyVersion.Builder newBuilder(CryptoKeyVersion prototype)
Parameter
Returns
public static CryptoKeyVersion parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static CryptoKeyVersion parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static CryptoKeyVersion parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CryptoKeyVersion parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static CryptoKeyVersion parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CryptoKeyVersion parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static CryptoKeyVersion parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static CryptoKeyVersion parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static CryptoKeyVersion parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static CryptoKeyVersion parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static CryptoKeyVersion parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CryptoKeyVersion parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<CryptoKeyVersion> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAlgorithm()
public CryptoKeyVersion.CryptoKeyVersionAlgorithm getAlgorithm()
Output only. The
CryptoKeyVersionAlgorithm
that this CryptoKeyVersion
supports.
.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getAlgorithmValue()
public int getAlgorithmValue()
Output only. The
CryptoKeyVersionAlgorithm
that this CryptoKeyVersion
supports.
.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
| int |
The enum numeric value on the wire for algorithm.
|
getAttestation()
public KeyOperationAttestation getAttestation()
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
HSM.
.google.cloud.kms.v1.KeyOperationAttestation attestation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getAttestationOrBuilder()
public KeyOperationAttestationOrBuilder getAttestationOrBuilder()
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
HSM.
.google.cloud.kms.v1.KeyOperationAttestation attestation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime()
public Timestamp getCreateTime()
Output only. The time at which this
CryptoKeyVersion was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time at which this
CryptoKeyVersion was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public CryptoKeyVersion getDefaultInstanceForType()
Returns
getDestroyEventTime()
public Timestamp getDestroyEventTime()
Output only. The time this CryptoKeyVersion's key material was
destroyed. Only present if
state is
DESTROYED.
.google.protobuf.Timestamp destroy_event_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
| Timestamp |
The destroyEventTime.
|
getDestroyEventTimeOrBuilder()
public TimestampOrBuilder getDestroyEventTimeOrBuilder()
Output only. The time this CryptoKeyVersion's key material was
destroyed. Only present if
state is
DESTROYED.
.google.protobuf.Timestamp destroy_event_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDestroyTime()
public Timestamp getDestroyTime()
Output only. The time this
CryptoKeyVersion's key material is
scheduled for destruction. Only present if
state is
DESTROY_SCHEDULED.
.google.protobuf.Timestamp destroy_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDestroyTimeOrBuilder()
public TimestampOrBuilder getDestroyTimeOrBuilder()
Output only. The time this
CryptoKeyVersion's key material is
scheduled for destruction. Only present if
state is
DESTROY_SCHEDULED.
.google.protobuf.Timestamp destroy_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getExternalProtectionLevelOptions()
public ExternalProtectionLevelOptions getExternalProtectionLevelOptions()
ExternalProtectionLevelOptions stores a group of additional fields for
configuring a CryptoKeyVersion that
are specific to the
EXTERNAL protection level
and EXTERNAL_VPC
protection levels.
.google.cloud.kms.v1.ExternalProtectionLevelOptions external_protection_level_options = 17;
getExternalProtectionLevelOptionsOrBuilder()
public ExternalProtectionLevelOptionsOrBuilder getExternalProtectionLevelOptionsOrBuilder()
ExternalProtectionLevelOptions stores a group of additional fields for
configuring a CryptoKeyVersion that
are specific to the
EXTERNAL protection level
and EXTERNAL_VPC
protection levels.
.google.cloud.kms.v1.ExternalProtectionLevelOptions external_protection_level_options = 17;
getGenerateTime()
public Timestamp getGenerateTime()
Output only. The time this
CryptoKeyVersion's key material was
generated.
.google.protobuf.Timestamp generate_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getGenerateTimeOrBuilder()
public TimestampOrBuilder getGenerateTimeOrBuilder()
Output only. The time this
CryptoKeyVersion's key material was
generated.
.google.protobuf.Timestamp generate_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getImportFailureReason()
public String getImportFailureReason()
Output only. The root cause of the most recent import failure. Only present
if state is
IMPORT_FAILED.
string import_failure_reason = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
| String |
The importFailureReason.
|
getImportFailureReasonBytes()
public ByteString getImportFailureReasonBytes()
Output only. The root cause of the most recent import failure. Only present
if state is
IMPORT_FAILED.
string import_failure_reason = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
| ByteString |
The bytes for importFailureReason.
|
getImportJob()
public String getImportJob()
Output only. The name of the ImportJob
used in the most recent import of this
CryptoKeyVersion. Only present if
the underlying key material was imported.
string import_job = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
| String |
The importJob.
|
getImportJobBytes()
public ByteString getImportJobBytes()
Output only. The name of the ImportJob
used in the most recent import of this
CryptoKeyVersion. Only present if
the underlying key material was imported.
string import_job = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
| ByteString |
The bytes for importJob.
|
getImportTime()
public Timestamp getImportTime()
Output only. The time at which this
CryptoKeyVersion's key material was
most recently imported.
.google.protobuf.Timestamp import_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
getImportTimeOrBuilder()
public TimestampOrBuilder getImportTimeOrBuilder()
Output only. The time at which this
CryptoKeyVersion's key material was
most recently imported.
.google.protobuf.Timestamp import_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
getName()
Output only. The resource name for this
CryptoKeyVersion in the format
projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
| String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. The resource name for this
CryptoKeyVersion in the format
projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
getParserForType()
public Parser<CryptoKeyVersion> getParserForType()
Returns
Overrides
getProtectionLevel()
public ProtectionLevel getProtectionLevel()
Output only. The ProtectionLevel
describing how crypto operations are performed with this
CryptoKeyVersion.
.google.cloud.kms.v1.ProtectionLevel protection_level = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getProtectionLevelValue()
public int getProtectionLevelValue()
Output only. The ProtectionLevel
describing how crypto operations are performed with this
CryptoKeyVersion.
.google.cloud.kms.v1.ProtectionLevel protection_level = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
| int |
The enum numeric value on the wire for protectionLevel.
|
getReimportEligible()
public boolean getReimportEligible()
Output only. Whether or not this key version is eligible for reimport, by
being specified as a target in
ImportCryptoKeyVersionRequest.crypto_key_version.
bool reimport_eligible = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
| boolean |
The reimportEligible.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getState()
public CryptoKeyVersion.CryptoKeyVersionState getState()
The current state of the
CryptoKeyVersion.
.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState state = 3;
getStateValue()
public int getStateValue()
The current state of the
CryptoKeyVersion.
.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState state = 3;
| Type |
Description |
| int |
The enum numeric value on the wire for state.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasAttestation()
public boolean hasAttestation()
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
HSM.
.google.cloud.kms.v1.KeyOperationAttestation attestation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
| boolean |
Whether the attestation field is set.
|
hasCreateTime()
public boolean hasCreateTime()
Output only. The time at which this
CryptoKeyVersion was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
| boolean |
Whether the createTime field is set.
|
hasDestroyEventTime()
public boolean hasDestroyEventTime()
Output only. The time this CryptoKeyVersion's key material was
destroyed. Only present if
state is
DESTROYED.
.google.protobuf.Timestamp destroy_event_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
| boolean |
Whether the destroyEventTime field is set.
|
hasDestroyTime()
public boolean hasDestroyTime()
Output only. The time this
CryptoKeyVersion's key material is
scheduled for destruction. Only present if
state is
DESTROY_SCHEDULED.
.google.protobuf.Timestamp destroy_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
| boolean |
Whether the destroyTime field is set.
|
hasExternalProtectionLevelOptions()
public boolean hasExternalProtectionLevelOptions()
ExternalProtectionLevelOptions stores a group of additional fields for
configuring a CryptoKeyVersion that
are specific to the
EXTERNAL protection level
and EXTERNAL_VPC
protection levels.
.google.cloud.kms.v1.ExternalProtectionLevelOptions external_protection_level_options = 17;
| Type |
Description |
| boolean |
Whether the externalProtectionLevelOptions field is set.
|
hasGenerateTime()
public boolean hasGenerateTime()
Output only. The time this
CryptoKeyVersion's key material was
generated.
.google.protobuf.Timestamp generate_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
| boolean |
Whether the generateTime field is set.
|
hasImportTime()
public boolean hasImportTime()
Output only. The time at which this
CryptoKeyVersion's key material was
most recently imported.
.google.protobuf.Timestamp import_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type |
Description |
| boolean |
Whether the importTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public CryptoKeyVersion.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CryptoKeyVersion.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public CryptoKeyVersion.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
