Class CryptoKeyVersion.Builder (2.5.1)

Version 2.5.1

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.54.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.8
• 2.5.3
• 2.4.4
• 2.3.1

public static final class CryptoKeyVersion.Builder extends GeneratedMessageV3.Builder<CryptoKeyVersion.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CryptoKeyVersion.Builder

Implements

CryptoKeyVersionOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CryptoKeyVersion.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
CryptoKeyVersion.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public CryptoKeyVersion build()

Returns

Type	Description
CryptoKeyVersion

buildPartial()

public CryptoKeyVersion buildPartial()

Returns

Type	Description
CryptoKeyVersion

clear()

public CryptoKeyVersion.Builder clear()

Returns

Type	Description
CryptoKeyVersion.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAlgorithm()

public CryptoKeyVersion.Builder clearAlgorithm()

Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

clearAttestation()

public CryptoKeyVersion.Builder clearAttestation()

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];

Returns

Type	Description
CryptoKeyVersion.Builder

clearCreateTime()

public CryptoKeyVersion.Builder clearCreateTime()

Output only. The time at which this CryptoKeyVersion was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
CryptoKeyVersion.Builder

clearDestroyEventTime()

public CryptoKeyVersion.Builder clearDestroyEventTime()

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];

Returns

Type	Description
CryptoKeyVersion.Builder

clearDestroyTime()

public CryptoKeyVersion.Builder clearDestroyTime()

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];

Returns

Type	Description
CryptoKeyVersion.Builder

clearExternalProtectionLevelOptions()

public CryptoKeyVersion.Builder clearExternalProtectionLevelOptions()

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;

Returns

Type	Description
CryptoKeyVersion.Builder

clearField(Descriptors.FieldDescriptor field)

public CryptoKeyVersion.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
CryptoKeyVersion.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearGenerateTime()

public CryptoKeyVersion.Builder clearGenerateTime()

Output only. The time this CryptoKeyVersion's key material was generated.

.google.protobuf.Timestamp generate_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
CryptoKeyVersion.Builder

clearImportFailureReason()

public CryptoKeyVersion.Builder clearImportFailureReason()

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];

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

clearImportJob()

public CryptoKeyVersion.Builder clearImportJob()

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];

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

clearImportTime()

public CryptoKeyVersion.Builder clearImportTime()

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];

Returns

Type	Description
CryptoKeyVersion.Builder

clearName()

public CryptoKeyVersion.Builder clearName()

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];

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CryptoKeyVersion.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
CryptoKeyVersion.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearProtectionLevel()

public CryptoKeyVersion.Builder clearProtectionLevel()

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];

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

clearReimportEligible()

public CryptoKeyVersion.Builder clearReimportEligible()

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];

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

clearState()

public CryptoKeyVersion.Builder clearState()

The current state of the CryptoKeyVersion.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState state = 3;

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

clone()

public CryptoKeyVersion.Builder clone()

Returns

Type	Description
CryptoKeyVersion.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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];

Returns

Type	Description
CryptoKeyVersion.CryptoKeyVersionAlgorithm	The algorithm.

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];

Returns

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];

Returns

Type	Description
KeyOperationAttestation	The attestation.

getAttestationBuilder()

public KeyOperationAttestation.Builder getAttestationBuilder()

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];

Returns

Type	Description
KeyOperationAttestation.Builder

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];

Returns

Type	Description
KeyOperationAttestationOrBuilder

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];

Returns

Type	Description
Timestamp	The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time at which this CryptoKeyVersion was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Builder

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];

Returns

Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public CryptoKeyVersion getDefaultInstanceForType()

Returns

Type	Description
CryptoKeyVersion

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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];

Returns

Type	Description
Timestamp	The destroyEventTime.

getDestroyEventTimeBuilder()

public Timestamp.Builder getDestroyEventTimeBuilder()

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];

Returns

Type	Description
Builder

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];

Returns

Type	Description
TimestampOrBuilder

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];

Returns

Type	Description
Timestamp	The destroyTime.

getDestroyTimeBuilder()

public Timestamp.Builder getDestroyTimeBuilder()

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];

Returns

Type	Description
Builder

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];

Returns

Type	Description
TimestampOrBuilder

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;

Returns

Type	Description
ExternalProtectionLevelOptions	The externalProtectionLevelOptions.

getExternalProtectionLevelOptionsBuilder()

public ExternalProtectionLevelOptions.Builder getExternalProtectionLevelOptionsBuilder()

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;

Returns

Type	Description
ExternalProtectionLevelOptions.Builder

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;

Returns

Type	Description
ExternalProtectionLevelOptionsOrBuilder

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];

Returns

Type	Description
Timestamp	The generateTime.

getGenerateTimeBuilder()

public Timestamp.Builder getGenerateTimeBuilder()

Output only. The time this CryptoKeyVersion's key material was generated.

.google.protobuf.Timestamp generate_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Builder

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];

Returns

Type	Description
TimestampOrBuilder

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];

Returns

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];

Returns

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];

Returns

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];

Returns

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];

Returns

Type	Description
Timestamp	The importTime.

getImportTimeBuilder()

public Timestamp.Builder getImportTimeBuilder()

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];

Returns

Type	Description
Builder

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];

Returns

Type	Description
TimestampOrBuilder

getName()

public String 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];

Returns

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];

Returns

Type	Description
ByteString	The bytes for name.

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];

Returns

Type	Description
ProtectionLevel	The protectionLevel.

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];

Returns

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];

Returns

Type	Description
boolean	The reimportEligible.

getState()

public CryptoKeyVersion.CryptoKeyVersionState getState()

The current state of the CryptoKeyVersion.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState state = 3;

Returns

Type	Description
CryptoKeyVersion.CryptoKeyVersionState	The state.

getStateValue()

public int getStateValue()

The current state of the CryptoKeyVersion.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState state = 3;

Returns

Type	Description
int	The enum numeric value on the wire for state.

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];

Returns

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];

Returns

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];

Returns

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];

Returns

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;

Returns

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];

Returns

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];

Returns

Type	Description
boolean	Whether the importTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeAttestation(KeyOperationAttestation value)

public CryptoKeyVersion.Builder mergeAttestation(KeyOperationAttestation value)

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];

Parameter

Name	Description
value	KeyOperationAttestation

Returns

Type	Description
CryptoKeyVersion.Builder

mergeCreateTime(Timestamp value)

public CryptoKeyVersion.Builder mergeCreateTime(Timestamp value)

Output only. The time at which this CryptoKeyVersion was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
CryptoKeyVersion.Builder

mergeDestroyEventTime(Timestamp value)

public CryptoKeyVersion.Builder mergeDestroyEventTime(Timestamp value)

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];

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
CryptoKeyVersion.Builder

mergeDestroyTime(Timestamp value)

public CryptoKeyVersion.Builder mergeDestroyTime(Timestamp value)

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];

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
CryptoKeyVersion.Builder

mergeExternalProtectionLevelOptions(ExternalProtectionLevelOptions value)

public CryptoKeyVersion.Builder mergeExternalProtectionLevelOptions(ExternalProtectionLevelOptions value)

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;

Parameter

Name	Description
value	ExternalProtectionLevelOptions

Returns

Type	Description
CryptoKeyVersion.Builder

mergeFrom(CryptoKeyVersion other)

public CryptoKeyVersion.Builder mergeFrom(CryptoKeyVersion other)

Parameter

Name	Description
other	CryptoKeyVersion

Returns

Type	Description
CryptoKeyVersion.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CryptoKeyVersion.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
CryptoKeyVersion.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public CryptoKeyVersion.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
CryptoKeyVersion.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeGenerateTime(Timestamp value)

public CryptoKeyVersion.Builder mergeGenerateTime(Timestamp value)

Output only. The time this CryptoKeyVersion's key material was generated.

.google.protobuf.Timestamp generate_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
CryptoKeyVersion.Builder

mergeImportTime(Timestamp value)

public CryptoKeyVersion.Builder mergeImportTime(Timestamp value)

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];

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
CryptoKeyVersion.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CryptoKeyVersion.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
CryptoKeyVersion.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAlgorithm(CryptoKeyVersion.CryptoKeyVersionAlgorithm value)

public CryptoKeyVersion.Builder setAlgorithm(CryptoKeyVersion.CryptoKeyVersionAlgorithm value)

Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	CryptoKeyVersion.CryptoKeyVersionAlgorithm The algorithm to set.

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

setAlgorithmValue(int value)

public CryptoKeyVersion.Builder setAlgorithmValue(int value)

Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	int The enum numeric value on the wire for algorithm to set.

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

setAttestation(KeyOperationAttestation value)

public CryptoKeyVersion.Builder setAttestation(KeyOperationAttestation value)

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];

Parameter

Name	Description
value	KeyOperationAttestation

Returns

Type	Description
CryptoKeyVersion.Builder

setAttestation(KeyOperationAttestation.Builder builderForValue)

public CryptoKeyVersion.Builder setAttestation(KeyOperationAttestation.Builder builderForValue)

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];

Parameter

Name	Description
builderForValue	KeyOperationAttestation.Builder

Returns

Type	Description
CryptoKeyVersion.Builder

setCreateTime(Timestamp value)

public CryptoKeyVersion.Builder setCreateTime(Timestamp value)

Output only. The time at which this CryptoKeyVersion was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
CryptoKeyVersion.Builder

setCreateTime(Timestamp.Builder builderForValue)

public CryptoKeyVersion.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time at which this CryptoKeyVersion was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
CryptoKeyVersion.Builder

setDestroyEventTime(Timestamp value)

public CryptoKeyVersion.Builder setDestroyEventTime(Timestamp value)

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];

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
CryptoKeyVersion.Builder

setDestroyEventTime(Timestamp.Builder builderForValue)

public CryptoKeyVersion.Builder setDestroyEventTime(Timestamp.Builder builderForValue)

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];

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
CryptoKeyVersion.Builder

setDestroyTime(Timestamp value)

public CryptoKeyVersion.Builder setDestroyTime(Timestamp value)

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];

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
CryptoKeyVersion.Builder

setDestroyTime(Timestamp.Builder builderForValue)

public CryptoKeyVersion.Builder setDestroyTime(Timestamp.Builder builderForValue)

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];

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
CryptoKeyVersion.Builder

setExternalProtectionLevelOptions(ExternalProtectionLevelOptions value)

public CryptoKeyVersion.Builder setExternalProtectionLevelOptions(ExternalProtectionLevelOptions value)

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;

Parameter

Name	Description
value	ExternalProtectionLevelOptions

Returns

Type	Description
CryptoKeyVersion.Builder

setExternalProtectionLevelOptions(ExternalProtectionLevelOptions.Builder builderForValue)

public CryptoKeyVersion.Builder setExternalProtectionLevelOptions(ExternalProtectionLevelOptions.Builder builderForValue)

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;

Parameter

Name	Description
builderForValue	ExternalProtectionLevelOptions.Builder

Returns

Type	Description
CryptoKeyVersion.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CryptoKeyVersion.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
CryptoKeyVersion.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setGenerateTime(Timestamp value)

public CryptoKeyVersion.Builder setGenerateTime(Timestamp value)

Output only. The time this CryptoKeyVersion's key material was generated.

.google.protobuf.Timestamp generate_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
CryptoKeyVersion.Builder

setGenerateTime(Timestamp.Builder builderForValue)

public CryptoKeyVersion.Builder setGenerateTime(Timestamp.Builder builderForValue)

Output only. The time this CryptoKeyVersion's key material was generated.

.google.protobuf.Timestamp generate_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
CryptoKeyVersion.Builder

setImportFailureReason(String value)

public CryptoKeyVersion.Builder setImportFailureReason(String value)

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];

Parameter

Name	Description
value	String The importFailureReason to set.

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

setImportFailureReasonBytes(ByteString value)

public CryptoKeyVersion.Builder setImportFailureReasonBytes(ByteString value)

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];

Parameter

Name	Description
value	ByteString The bytes for importFailureReason to set.

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

setImportJob(String value)

public CryptoKeyVersion.Builder setImportJob(String value)

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];

Parameter

Name	Description
value	String The importJob to set.

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

setImportJobBytes(ByteString value)

public CryptoKeyVersion.Builder setImportJobBytes(ByteString value)

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];

Parameter

Name	Description
value	ByteString The bytes for importJob to set.

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

setImportTime(Timestamp value)

public CryptoKeyVersion.Builder setImportTime(Timestamp value)

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];

Parameter

Name	Description
value	Timestamp

Returns

Type	Description
CryptoKeyVersion.Builder

setImportTime(Timestamp.Builder builderForValue)

public CryptoKeyVersion.Builder setImportTime(Timestamp.Builder builderForValue)

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];

Parameter

Name	Description
builderForValue	Builder

Returns

Type	Description
CryptoKeyVersion.Builder

setName(String value)

public CryptoKeyVersion.Builder setName(String value)

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];

Parameter

Name	Description
value	String The name to set.

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

setNameBytes(ByteString value)

public CryptoKeyVersion.Builder setNameBytes(ByteString value)

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];

Parameter

Name	Description
value	ByteString The bytes for name to set.

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

setProtectionLevel(ProtectionLevel value)

public CryptoKeyVersion.Builder setProtectionLevel(ProtectionLevel value)

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];

Parameter

Name	Description
value	ProtectionLevel The protectionLevel to set.

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

setProtectionLevelValue(int value)

public CryptoKeyVersion.Builder setProtectionLevelValue(int value)

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];

Parameter

Name	Description
value	int The enum numeric value on the wire for protectionLevel to set.

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

setReimportEligible(boolean value)

public CryptoKeyVersion.Builder setReimportEligible(boolean value)

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];

Parameter

Name	Description
value	boolean The reimportEligible to set.

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CryptoKeyVersion.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
CryptoKeyVersion.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setState(CryptoKeyVersion.CryptoKeyVersionState value)

public CryptoKeyVersion.Builder setState(CryptoKeyVersion.CryptoKeyVersionState value)

The current state of the CryptoKeyVersion.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState state = 3;

Parameter

Name	Description
value	CryptoKeyVersion.CryptoKeyVersionState The state to set.

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

setStateValue(int value)

public CryptoKeyVersion.Builder setStateValue(int value)

The current state of the CryptoKeyVersion.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState state = 3;

Parameter

Name	Description
value	int The enum numeric value on the wire for state to set.

Returns

Type	Description
CryptoKeyVersion.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CryptoKeyVersion.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
CryptoKeyVersion.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)