Package com.google.cloud.kms.v1

Interface CryptoKeyVersionOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    CryptoKeyVersion, CryptoKeyVersion.Builder
    public interface CryptoKeyVersionOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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];
        Returns:
        The name.

      • getNameBytes

        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];
        Returns:
        The bytes for name.

      • getStateValue

        int getStateValue()
         The current state of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].
        .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState state = 3;
        Returns:
        The enum numeric value on the wire for state.

      • getState

        CryptoKeyVersion.CryptoKeyVersionState getState()
         The current state of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].
        .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState state = 3;
        Returns:
        The state.

      • getProtectionLevelValue

        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];
        Returns:
        The enum numeric value on the wire for protectionLevel.

      • getProtectionLevel

        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];
        Returns:
        The protectionLevel.

      • getAlgorithmValue

        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];
        Returns:
        The enum numeric value on the wire for algorithm.

      • getAlgorithm

        CryptoKeyVersion.CryptoKeyVersionAlgorithm 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];
        Returns:
        The algorithm.

      • hasAttestation

        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];
        Returns:
        Whether the attestation field is set.

      • getAttestation

        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];
        Returns:
        The attestation.

      • getAttestationOrBuilder

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

      • hasCreateTime

        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];
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        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];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

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

      • hasGenerateTime

        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];
        Returns:
        Whether the generateTime field is set.

      • getGenerateTime

        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];
        Returns:
        The generateTime.

      • getGenerateTimeOrBuilder

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

      • hasDestroyTime

        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];
        Returns:
        Whether the destroyTime field is set.

      • getDestroyTime

        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];
        Returns:
        The destroyTime.

      • getDestroyTimeOrBuilder

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

      • hasDestroyEventTime

        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];
        Returns:
        Whether the destroyEventTime field is set.

      • getDestroyEventTime

        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];
        Returns:
        The destroyEventTime.

      • getDestroyEventTimeOrBuilder

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

      • getImportJob

        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];
        Returns:
        The importJob.

      • getImportJobBytes

        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];
        Returns:
        The bytes for importJob.

      • hasImportTime

        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];
        Returns:
        Whether the importTime field is set.

      • getImportTime

        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];
        Returns:
        The importTime.

      • getImportTimeOrBuilder

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

      • getImportFailureReason

        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];
        Returns:
        The importFailureReason.

      • getImportFailureReasonBytes

        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];
        Returns:
        The bytes for importFailureReason.

      • getGenerationFailureReason

        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];
        Returns:
        The generationFailureReason.

      • getGenerationFailureReasonBytes

        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];
        Returns:
        The bytes for generationFailureReason.

      • getExternalDestructionFailureReason

        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];
        Returns:
        The externalDestructionFailureReason.

      • getExternalDestructionFailureReasonBytes

        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];
        Returns:
        The bytes for externalDestructionFailureReason.

      • hasExternalProtectionLevelOptions

        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;
        Returns:
        Whether the externalProtectionLevelOptions field is set.

      • getExternalProtectionLevelOptions

        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;
        Returns:
        The externalProtectionLevelOptions.

      • getExternalProtectionLevelOptionsOrBuilder

        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;

      • getReimportEligible

        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];
        Returns:
        The reimportEligible.