Class CryptoKeyVersion

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.kms.v1.CryptoKeyVersion
All Implemented Interfaces:
CryptoKeyVersionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class CryptoKeyVersion extends com.google.protobuf.GeneratedMessage implements CryptoKeyVersionOrBuilder
 A [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] represents an
 individual cryptographic key, and the associated key material.

 An
 [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED]
 version can be used for cryptographic operations.

 For security reasons, the raw cryptographic key material represented by a
 [CryptoKeyVersion][google.cloud.kms.v1.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
See Also:
  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:
    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:
    • PROTECTION_LEVEL_FIELD_NUMBER

      public static final int PROTECTION_LEVEL_FIELD_NUMBER
      See Also:
    • ALGORITHM_FIELD_NUMBER

      public static final int ALGORITHM_FIELD_NUMBER
      See Also:
    • ATTESTATION_FIELD_NUMBER

      public static final int ATTESTATION_FIELD_NUMBER
      See Also:
    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:
    • GENERATE_TIME_FIELD_NUMBER

      public static final int GENERATE_TIME_FIELD_NUMBER
      See Also:
    • DESTROY_TIME_FIELD_NUMBER

      public static final int DESTROY_TIME_FIELD_NUMBER
      See Also:
    • DESTROY_EVENT_TIME_FIELD_NUMBER

      public static final int DESTROY_EVENT_TIME_FIELD_NUMBER
      See Also:
    • IMPORT_JOB_FIELD_NUMBER

      public static final int IMPORT_JOB_FIELD_NUMBER
      See Also:
    • IMPORT_TIME_FIELD_NUMBER

      public static final int IMPORT_TIME_FIELD_NUMBER
      See Also:
    • IMPORT_FAILURE_REASON_FIELD_NUMBER

      public static final int IMPORT_FAILURE_REASON_FIELD_NUMBER
      See Also:
    • GENERATION_FAILURE_REASON_FIELD_NUMBER

      public static final int GENERATION_FAILURE_REASON_FIELD_NUMBER
      See Also:
    • EXTERNAL_DESTRUCTION_FAILURE_REASON_FIELD_NUMBER

      public static final int EXTERNAL_DESTRUCTION_FAILURE_REASON_FIELD_NUMBER
      See Also:
    • EXTERNAL_PROTECTION_LEVEL_OPTIONS_FIELD_NUMBER

      public static final int EXTERNAL_PROTECTION_LEVEL_OPTIONS_FIELD_NUMBER
      See Also:
    • REIMPORT_ELIGIBLE_FIELD_NUMBER

      public static final int REIMPORT_ELIGIBLE_FIELD_NUMBER
      See Also:
    • TRUSTED_WRAPPING_ENABLED_FIELD_NUMBER

      public static final int TRUSTED_WRAPPING_ENABLED_FIELD_NUMBER
      See Also:
    • HSM_TRUSTED_FIELD_NUMBER

      public static final int HSM_TRUSTED_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getName

      public String getName()
       Output only. The resource name for this
       [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] in the format
       `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
       
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface CryptoKeyVersionOrBuilder
      Returns:
      The name.
    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. The resource name for this
       [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] in the format
       `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
       
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNameBytes in interface CryptoKeyVersionOrBuilder
      Returns:
      The bytes for name.
    • getStateValue

      public int getStateValue()
       The current state of the
       [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].
       
      .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState state = 3;
      Specified by:
      getStateValue in interface CryptoKeyVersionOrBuilder
      Returns:
      The enum numeric value on the wire for state.
    • getState

       The current state of the
       [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].
       
      .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState state = 3;
      Specified by:
      getState in interface CryptoKeyVersionOrBuilder
      Returns:
      The state.
    • getProtectionLevelValue

      public int getProtectionLevelValue()
       Output only. The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel]
       describing how crypto operations are performed with this
       [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].
       
      .google.cloud.kms.v1.ProtectionLevel protection_level = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getProtectionLevelValue in interface CryptoKeyVersionOrBuilder
      Returns:
      The enum numeric value on the wire for protectionLevel.
    • getProtectionLevel

      public ProtectionLevel getProtectionLevel()
       Output only. The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel]
       describing how crypto operations are performed with this
       [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].
       
      .google.cloud.kms.v1.ProtectionLevel protection_level = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getProtectionLevel in interface CryptoKeyVersionOrBuilder
      Returns:
      The protectionLevel.
    • getAlgorithmValue

      public int getAlgorithmValue()
       Output only. The
       [CryptoKeyVersionAlgorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm]
       that this [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]
       supports.
       
      .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAlgorithmValue in interface CryptoKeyVersionOrBuilder
      Returns:
      The enum numeric value on the wire for algorithm.
    • getAlgorithm

       Output only. The
       [CryptoKeyVersionAlgorithm][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm]
       that this [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]
       supports.
       
      .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAlgorithm in interface CryptoKeyVersionOrBuilder
      Returns:
      The algorithm.
    • 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][google.cloud.kms.v1.CryptoKeyVersion.protection_level]
       [HSM][google.cloud.kms.v1.ProtectionLevel.HSM].
       
      .google.cloud.kms.v1.KeyOperationAttestation attestation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasAttestation in interface CryptoKeyVersionOrBuilder
      Returns:
      Whether the attestation field is set.
    • 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][google.cloud.kms.v1.CryptoKeyVersion.protection_level]
       [HSM][google.cloud.kms.v1.ProtectionLevel.HSM].
       
      .google.cloud.kms.v1.KeyOperationAttestation attestation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAttestation in interface CryptoKeyVersionOrBuilder
      Returns:
      The attestation.
    • 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][google.cloud.kms.v1.CryptoKeyVersion.protection_level]
       [HSM][google.cloud.kms.v1.ProtectionLevel.HSM].
       
      .google.cloud.kms.v1.KeyOperationAttestation attestation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAttestationOrBuilder in interface CryptoKeyVersionOrBuilder
    • hasCreateTime

      public boolean hasCreateTime()
       Output only. The time at which this
       [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] was created.
       
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface CryptoKeyVersionOrBuilder
      Returns:
      Whether the createTime field is set.
    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The time at which this
       [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] was created.
       
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface CryptoKeyVersionOrBuilder
      Returns:
      The createTime.
    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time at which this
       [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] was created.
       
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface CryptoKeyVersionOrBuilder
    • hasGenerateTime

      public boolean hasGenerateTime()
       Output only. The time this
       [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]'s key material was
       generated.
       
      .google.protobuf.Timestamp generate_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasGenerateTime in interface CryptoKeyVersionOrBuilder
      Returns:
      Whether the generateTime field is set.
    • getGenerateTime

      public com.google.protobuf.Timestamp getGenerateTime()
       Output only. The time this
       [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]'s key material was
       generated.
       
      .google.protobuf.Timestamp generate_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGenerateTime in interface CryptoKeyVersionOrBuilder
      Returns:
      The generateTime.
    • getGenerateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getGenerateTimeOrBuilder()
       Output only. The time this
       [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]'s key material was
       generated.
       
      .google.protobuf.Timestamp generate_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGenerateTimeOrBuilder in interface CryptoKeyVersionOrBuilder
    • hasDestroyTime

      public boolean hasDestroyTime()
       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].
       
      .google.protobuf.Timestamp destroy_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasDestroyTime in interface CryptoKeyVersionOrBuilder
      Returns:
      Whether the destroyTime field is set.
    • getDestroyTime

      public com.google.protobuf.Timestamp getDestroyTime()
       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].
       
      .google.protobuf.Timestamp destroy_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDestroyTime in interface CryptoKeyVersionOrBuilder
      Returns:
      The destroyTime.
    • getDestroyTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getDestroyTimeOrBuilder()
       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].
       
      .google.protobuf.Timestamp destroy_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDestroyTimeOrBuilder in interface CryptoKeyVersionOrBuilder
    • hasDestroyEventTime

      public boolean hasDestroyEventTime()
       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].
       
      .google.protobuf.Timestamp destroy_event_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasDestroyEventTime in interface CryptoKeyVersionOrBuilder
      Returns:
      Whether the destroyEventTime field is set.
    • getDestroyEventTime

      public com.google.protobuf.Timestamp getDestroyEventTime()
       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].
       
      .google.protobuf.Timestamp destroy_event_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDestroyEventTime in interface CryptoKeyVersionOrBuilder
      Returns:
      The destroyEventTime.
    • getDestroyEventTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getDestroyEventTimeOrBuilder()
       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].
       
      .google.protobuf.Timestamp destroy_event_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDestroyEventTimeOrBuilder in interface CryptoKeyVersionOrBuilder
    • getImportJob

      public String getImportJob()
       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.
       
      string import_job = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getImportJob in interface CryptoKeyVersionOrBuilder
      Returns:
      The importJob.
    • getImportJobBytes

      public com.google.protobuf.ByteString getImportJobBytes()
       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.
       
      string import_job = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getImportJobBytes in interface CryptoKeyVersionOrBuilder
      Returns:
      The bytes for importJob.
    • hasImportTime

      public boolean hasImportTime()
       Output only. The time at which this
       [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]'s key material was
       most recently imported.
       
      .google.protobuf.Timestamp import_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasImportTime in interface CryptoKeyVersionOrBuilder
      Returns:
      Whether the importTime field is set.
    • getImportTime

      public com.google.protobuf.Timestamp getImportTime()
       Output only. The time at which this
       [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]'s key material was
       most recently imported.
       
      .google.protobuf.Timestamp import_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getImportTime in interface CryptoKeyVersionOrBuilder
      Returns:
      The importTime.
    • getImportTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getImportTimeOrBuilder()
       Output only. The time at which this
       [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]'s key material was
       most recently imported.
       
      .google.protobuf.Timestamp import_time = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getImportTimeOrBuilder in interface CryptoKeyVersionOrBuilder
    • getImportFailureReason

      public String getImportFailureReason()
       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].
       
      string import_failure_reason = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getImportFailureReason in interface CryptoKeyVersionOrBuilder
      Returns:
      The importFailureReason.
    • getImportFailureReasonBytes

      public com.google.protobuf.ByteString getImportFailureReasonBytes()
       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].
       
      string import_failure_reason = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getImportFailureReasonBytes in interface CryptoKeyVersionOrBuilder
      Returns:
      The bytes for importFailureReason.
    • getGenerationFailureReason

      public String getGenerationFailureReason()
       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].
       
      string generation_failure_reason = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGenerationFailureReason in interface CryptoKeyVersionOrBuilder
      Returns:
      The generationFailureReason.
    • getGenerationFailureReasonBytes

      public com.google.protobuf.ByteString getGenerationFailureReasonBytes()
       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].
       
      string generation_failure_reason = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGenerationFailureReasonBytes in interface CryptoKeyVersionOrBuilder
      Returns:
      The bytes for generationFailureReason.
    • getExternalDestructionFailureReason

      public String getExternalDestructionFailureReason()
       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].
       
      string external_destruction_failure_reason = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getExternalDestructionFailureReason in interface CryptoKeyVersionOrBuilder
      Returns:
      The externalDestructionFailureReason.
    • getExternalDestructionFailureReasonBytes

      public com.google.protobuf.ByteString getExternalDestructionFailureReasonBytes()
       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].
       
      string external_destruction_failure_reason = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getExternalDestructionFailureReasonBytes in interface CryptoKeyVersionOrBuilder
      Returns:
      The bytes for externalDestructionFailureReason.
    • hasExternalProtectionLevelOptions

      public boolean hasExternalProtectionLevelOptions()
       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.
       
      .google.cloud.kms.v1.ExternalProtectionLevelOptions external_protection_level_options = 17;
      Specified by:
      hasExternalProtectionLevelOptions in interface CryptoKeyVersionOrBuilder
      Returns:
      Whether the externalProtectionLevelOptions field is set.
    • getExternalProtectionLevelOptions

      public ExternalProtectionLevelOptions getExternalProtectionLevelOptions()
       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.
       
      .google.cloud.kms.v1.ExternalProtectionLevelOptions external_protection_level_options = 17;
      Specified by:
      getExternalProtectionLevelOptions in interface CryptoKeyVersionOrBuilder
      Returns:
      The externalProtectionLevelOptions.
    • getExternalProtectionLevelOptionsOrBuilder

      public ExternalProtectionLevelOptionsOrBuilder getExternalProtectionLevelOptionsOrBuilder()
       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.
       
      .google.cloud.kms.v1.ExternalProtectionLevelOptions external_protection_level_options = 17;
      Specified by:
      getExternalProtectionLevelOptionsOrBuilder in interface CryptoKeyVersionOrBuilder
    • 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][google.cloud.kms.v1.ImportCryptoKeyVersionRequest.crypto_key_version].
       
      bool reimport_eligible = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getReimportEligible in interface CryptoKeyVersionOrBuilder
      Returns:
      The reimportEligible.
    • getTrustedWrappingEnabled

      public boolean getTrustedWrappingEnabled()
       Immutable. Field indicating that the key may be wrapped by a trusted key.
       This field can be set for all key purposes except
       [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT],
       and is only valid for keys with protection level
       [HSM_SINGLE_TENANT][google.cloud.kms.v1.ProtectionLevel.HSM_SINGLE_TENANT].
       This field can only be set at creation or import time via
       [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion],
       or
       [ImportCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.ImportCryptoKeyVersion].
       
      bool trusted_wrapping_enabled = 21 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getTrustedWrappingEnabled in interface CryptoKeyVersionOrBuilder
      Returns:
      The trustedWrappingEnabled.
    • getHsmTrusted

      public boolean getHsmTrusted()
       Output only. Field indicating that the key wrapping key is trusted.
       This field is only valid for key purpose
       [AES_256_WRAPPING][CryptoKey.CryptoKeyPurpose.AES_256_WRAPPING], and
       protection level
       [HSM_SINGLE_TENANT][google.cloud.kms.v1.ProtectionLevel.HSM_SINGLE_TENANT].
       
      bool hsm_trusted = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getHsmTrusted in interface CryptoKeyVersionOrBuilder
      Returns:
      The hsmTrusted.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static CryptoKeyVersion parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static CryptoKeyVersion parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static CryptoKeyVersion parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static CryptoKeyVersion parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static CryptoKeyVersion parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static CryptoKeyVersion parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static CryptoKeyVersion parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static CryptoKeyVersion parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static CryptoKeyVersion parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static CryptoKeyVersion parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static CryptoKeyVersion parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static CryptoKeyVersion parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public CryptoKeyVersion.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static CryptoKeyVersion.Builder newBuilder()
    • newBuilder

      public static CryptoKeyVersion.Builder newBuilder(CryptoKeyVersion prototype)
    • toBuilder

      public CryptoKeyVersion.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected CryptoKeyVersion.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static CryptoKeyVersion getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<CryptoKeyVersion> parser()
    • getParserForType

      public com.google.protobuf.Parser<CryptoKeyVersion> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public CryptoKeyVersion getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder