/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/kms/v1/resources.proto
package com.google.cloud.kms.v1;
public interface CryptoKeyVersionOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.kms.v1.CryptoKeyVersion)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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];
*
* @return The name.
*/
java.lang.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];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* The current state of the
* [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].
*
*
* .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState state = 3;
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* The current state of the
* [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion].
*
*
* .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState state = 3;
*
* @return The state.
*/
com.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState getState();
/**
*
*
*
* 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];
*
*
* @return The enum numeric value on the wire for protectionLevel.
*/
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];
*
*
* @return The protectionLevel.
*/
com.google.cloud.kms.v1.ProtectionLevel getProtectionLevel();
/**
*
*
*
* 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];
*
*
* @return The enum numeric value on the wire for algorithm.
*/
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];
*
*
* @return The algorithm.
*/
com.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm getAlgorithm();
/**
*
*
*
* 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];
*
*
* @return Whether the attestation field is set.
*/
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];
*
*
* @return The attestation.
*/
com.google.cloud.kms.v1.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];
*
*/
com.google.cloud.kms.v1.KeyOperationAttestationOrBuilder getAttestationOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the createTime field is set.
*/
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];
*
*
* @return The createTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the generateTime field is set.
*/
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];
*
*
* @return The generateTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getGenerateTimeOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the destroyTime field is set.
*/
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];
*
*
* @return The destroyTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getDestroyTimeOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the destroyEventTime field is set.
*/
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];
*
*
* @return The destroyEventTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getDestroyEventTimeOrBuilder();
/**
*
*
*
* 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];
*
* @return The importJob.
*/
java.lang.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];
*
* @return The bytes for importJob.
*/
com.google.protobuf.ByteString getImportJobBytes();
/**
*
*
*
* 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];
*
*
* @return Whether the importTime field is set.
*/
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];
*
*
* @return The importTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getImportTimeOrBuilder();
/**
*
*
*
* 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];
*
* @return The importFailureReason.
*/
java.lang.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];
*
* @return The bytes for importFailureReason.
*/
com.google.protobuf.ByteString getImportFailureReasonBytes();
/**
*
*
*
* 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];
*
*
* @return The generationFailureReason.
*/
java.lang.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];
*
*
* @return The bytes for generationFailureReason.
*/
com.google.protobuf.ByteString getGenerationFailureReasonBytes();
/**
*
*
*
* 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];
*
*
* @return The externalDestructionFailureReason.
*/
java.lang.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];
*
*
* @return The bytes for externalDestructionFailureReason.
*/
com.google.protobuf.ByteString getExternalDestructionFailureReasonBytes();
/**
*
*
*
* 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;
*
*
* @return Whether the externalProtectionLevelOptions field is set.
*/
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;
*
*
* @return The externalProtectionLevelOptions.
*/
com.google.cloud.kms.v1.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;
*
*/
com.google.cloud.kms.v1.ExternalProtectionLevelOptionsOrBuilder
getExternalProtectionLevelOptionsOrBuilder();
/**
*
*
*
* 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];
*
* @return The reimportEligible.
*/
boolean getReimportEligible();
}