/*
* 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 CryptoKeyOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.kms.v1.CryptoKey)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Output only. The resource name for this
* [CryptoKey][google.cloud.kms.v1.CryptoKey] in the format
* `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Output only. The resource name for this
* [CryptoKey][google.cloud.kms.v1.CryptoKey] in the format
* `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Output only. A copy of the "primary"
* [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] that will be used
* by [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] when this
* [CryptoKey][google.cloud.kms.v1.CryptoKey] is given in
* [EncryptRequest.name][google.cloud.kms.v1.EncryptRequest.name].
* The [CryptoKey][google.cloud.kms.v1.CryptoKey]'s primary version can be
* updated via
* [UpdateCryptoKeyPrimaryVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersion].
* Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose]
* [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT]
* may have a primary. For other keys, this field will be omitted.
*
*
*
* .google.cloud.kms.v1.CryptoKeyVersion primary = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the primary field is set.
*/
boolean hasPrimary();
/**
*
*
*
* Output only. A copy of the "primary"
* [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] that will be used
* by [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] when this
* [CryptoKey][google.cloud.kms.v1.CryptoKey] is given in
* [EncryptRequest.name][google.cloud.kms.v1.EncryptRequest.name].
* The [CryptoKey][google.cloud.kms.v1.CryptoKey]'s primary version can be
* updated via
* [UpdateCryptoKeyPrimaryVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersion].
* Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose]
* [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT]
* may have a primary. For other keys, this field will be omitted.
*
*
*
* .google.cloud.kms.v1.CryptoKeyVersion primary = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The primary.
*/
com.google.cloud.kms.v1.CryptoKeyVersion getPrimary();
/**
*
*
*
* Output only. A copy of the "primary"
* [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] that will be used
* by [Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt] when this
* [CryptoKey][google.cloud.kms.v1.CryptoKey] is given in
* [EncryptRequest.name][google.cloud.kms.v1.EncryptRequest.name].
* The [CryptoKey][google.cloud.kms.v1.CryptoKey]'s primary version can be
* updated via
* [UpdateCryptoKeyPrimaryVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersion].
* Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose]
* [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT]
* may have a primary. For other keys, this field will be omitted.
*
*
*
* .google.cloud.kms.v1.CryptoKeyVersion primary = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.kms.v1.CryptoKeyVersionOrBuilder getPrimaryOrBuilder();
/**
*
*
*
* Immutable. The immutable purpose of this
* [CryptoKey][google.cloud.kms.v1.CryptoKey].
*
*
*
* .google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose purpose = 3 [(.google.api.field_behavior) = IMMUTABLE];
*
*
* @return The enum numeric value on the wire for purpose.
*/
int getPurposeValue();
/**
*
*
*
* Immutable. The immutable purpose of this
* [CryptoKey][google.cloud.kms.v1.CryptoKey].
*
*
*
* .google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose purpose = 3 [(.google.api.field_behavior) = IMMUTABLE];
*
*
* @return The purpose.
*/
com.google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose getPurpose();
/**
*
*
*
* Output only. The time at which this
* [CryptoKey][google.cloud.kms.v1.CryptoKey] was created.
*
*
* .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The time at which this
* [CryptoKey][google.cloud.kms.v1.CryptoKey] was created.
*
*
* .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. The time at which this
* [CryptoKey][google.cloud.kms.v1.CryptoKey] was created.
*
*
* .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* At [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time],
* the Key Management Service will automatically:
* 1. Create a new version of this [CryptoKey][google.cloud.kms.v1.CryptoKey].
* 2. Mark the new version as primary.
* Key rotations performed manually via
* [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion]
* and
* [UpdateCryptoKeyPrimaryVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersion]
* do not affect
* [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time].
* Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose]
* [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT]
* support automatic rotation. For other keys, this field must be omitted.
*
*
* .google.protobuf.Timestamp next_rotation_time = 7;
*
* @return Whether the nextRotationTime field is set.
*/
boolean hasNextRotationTime();
/**
*
*
*
* At [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time],
* the Key Management Service will automatically:
* 1. Create a new version of this [CryptoKey][google.cloud.kms.v1.CryptoKey].
* 2. Mark the new version as primary.
* Key rotations performed manually via
* [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion]
* and
* [UpdateCryptoKeyPrimaryVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersion]
* do not affect
* [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time].
* Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose]
* [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT]
* support automatic rotation. For other keys, this field must be omitted.
*
*
* .google.protobuf.Timestamp next_rotation_time = 7;
*
* @return The nextRotationTime.
*/
com.google.protobuf.Timestamp getNextRotationTime();
/**
*
*
*
* At [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time],
* the Key Management Service will automatically:
* 1. Create a new version of this [CryptoKey][google.cloud.kms.v1.CryptoKey].
* 2. Mark the new version as primary.
* Key rotations performed manually via
* [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion]
* and
* [UpdateCryptoKeyPrimaryVersion][google.cloud.kms.v1.KeyManagementService.UpdateCryptoKeyPrimaryVersion]
* do not affect
* [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time].
* Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose]
* [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT]
* support automatic rotation. For other keys, this field must be omitted.
*
*
* .google.protobuf.Timestamp next_rotation_time = 7;
*/
com.google.protobuf.TimestampOrBuilder getNextRotationTimeOrBuilder();
/**
*
*
*
* [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time]
* will be advanced by this period when the service automatically rotates a
* key. Must be at least 24 hours and at most 876,000 hours.
* If [rotation_period][google.cloud.kms.v1.CryptoKey.rotation_period] is
* set,
* [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time]
* must also be set.
* Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose]
* [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT]
* support automatic rotation. For other keys, this field must be omitted.
*
*
* .google.protobuf.Duration rotation_period = 8;
*
* @return Whether the rotationPeriod field is set.
*/
boolean hasRotationPeriod();
/**
*
*
*
* [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time]
* will be advanced by this period when the service automatically rotates a
* key. Must be at least 24 hours and at most 876,000 hours.
* If [rotation_period][google.cloud.kms.v1.CryptoKey.rotation_period] is
* set,
* [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time]
* must also be set.
* Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose]
* [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT]
* support automatic rotation. For other keys, this field must be omitted.
*
*
* .google.protobuf.Duration rotation_period = 8;
*
* @return The rotationPeriod.
*/
com.google.protobuf.Duration getRotationPeriod();
/**
*
*
*
* [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time]
* will be advanced by this period when the service automatically rotates a
* key. Must be at least 24 hours and at most 876,000 hours.
* If [rotation_period][google.cloud.kms.v1.CryptoKey.rotation_period] is
* set,
* [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time]
* must also be set.
* Keys with [purpose][google.cloud.kms.v1.CryptoKey.purpose]
* [ENCRYPT_DECRYPT][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose.ENCRYPT_DECRYPT]
* support automatic rotation. For other keys, this field must be omitted.
*
*
* .google.protobuf.Duration rotation_period = 8;
*/
com.google.protobuf.DurationOrBuilder getRotationPeriodOrBuilder();
/**
*
*
*
* A template describing settings for new
* [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] instances. The
* properties of new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]
* instances created by either
* [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion]
* or auto-rotation are controlled by this template.
*
*
* .google.cloud.kms.v1.CryptoKeyVersionTemplate version_template = 11;
*
* @return Whether the versionTemplate field is set.
*/
boolean hasVersionTemplate();
/**
*
*
*
* A template describing settings for new
* [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] instances. The
* properties of new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]
* instances created by either
* [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion]
* or auto-rotation are controlled by this template.
*
*
* .google.cloud.kms.v1.CryptoKeyVersionTemplate version_template = 11;
*
* @return The versionTemplate.
*/
com.google.cloud.kms.v1.CryptoKeyVersionTemplate getVersionTemplate();
/**
*
*
*
* A template describing settings for new
* [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] instances. The
* properties of new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]
* instances created by either
* [CreateCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion]
* or auto-rotation are controlled by this template.
*
*
* .google.cloud.kms.v1.CryptoKeyVersionTemplate version_template = 11;
*/
com.google.cloud.kms.v1.CryptoKeyVersionTemplateOrBuilder getVersionTemplateOrBuilder();
/**
*
*
*
* Labels with user-defined metadata. For more information, see
* [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
*
*
* map<string, string> labels = 10;
*/
int getLabelsCount();
/**
*
*
*
* Labels with user-defined metadata. For more information, see
* [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
*
*
* map<string, string> labels = 10;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Labels with user-defined metadata. For more information, see
* [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
*
*
* map<string, string> labels = 10;
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Labels with user-defined metadata. For more information, see
* [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
*
*
* map<string, string> labels = 10;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Labels with user-defined metadata. For more information, see
* [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
*
*
* map<string, string> labels = 10;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Immutable. Whether this key may contain imported versions only.
*
*
* bool import_only = 13 [(.google.api.field_behavior) = IMMUTABLE];
*
* @return The importOnly.
*/
boolean getImportOnly();
/**
*
*
*
* Immutable. The period of time that versions of this key spend in the
* [DESTROY_SCHEDULED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROY_SCHEDULED]
* state before transitioning to
* [DESTROYED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROYED].
* If not specified at creation time, the default duration is 24 hours.
*
*
*
* .google.protobuf.Duration destroy_scheduled_duration = 14 [(.google.api.field_behavior) = IMMUTABLE];
*
*
* @return Whether the destroyScheduledDuration field is set.
*/
boolean hasDestroyScheduledDuration();
/**
*
*
*
* Immutable. The period of time that versions of this key spend in the
* [DESTROY_SCHEDULED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROY_SCHEDULED]
* state before transitioning to
* [DESTROYED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROYED].
* If not specified at creation time, the default duration is 24 hours.
*
*
*
* .google.protobuf.Duration destroy_scheduled_duration = 14 [(.google.api.field_behavior) = IMMUTABLE];
*
*
* @return The destroyScheduledDuration.
*/
com.google.protobuf.Duration getDestroyScheduledDuration();
/**
*
*
*
* Immutable. The period of time that versions of this key spend in the
* [DESTROY_SCHEDULED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROY_SCHEDULED]
* state before transitioning to
* [DESTROYED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROYED].
* If not specified at creation time, the default duration is 24 hours.
*
*
*
* .google.protobuf.Duration destroy_scheduled_duration = 14 [(.google.api.field_behavior) = IMMUTABLE];
*
*/
com.google.protobuf.DurationOrBuilder getDestroyScheduledDurationOrBuilder();
/**
*
*
*
* Immutable. The resource name of the backend environment where the key
* material for all [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion]
* associated with this [CryptoKey][google.cloud.kms.v1.CryptoKey] reside and
* where all related cryptographic operations are performed. Only applicable
* if [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] have a
* [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of
* [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], with the
* resource name in the format `projects/*/locations/*/ekmConnections/*`.
* Note, this list is non-exhaustive and may apply to additional
* [ProtectionLevels][google.cloud.kms.v1.ProtectionLevel] in the future.
*
*
*
* string crypto_key_backend = 15 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
*
*
* @return The cryptoKeyBackend.
*/
java.lang.String getCryptoKeyBackend();
/**
*
*
*
* Immutable. The resource name of the backend environment where the key
* material for all [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion]
* associated with this [CryptoKey][google.cloud.kms.v1.CryptoKey] reside and
* where all related cryptographic operations are performed. Only applicable
* if [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] have a
* [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of
* [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], with the
* resource name in the format `projects/*/locations/*/ekmConnections/*`.
* Note, this list is non-exhaustive and may apply to additional
* [ProtectionLevels][google.cloud.kms.v1.ProtectionLevel] in the future.
*
*
*
* string crypto_key_backend = 15 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
*
*
* @return The bytes for cryptoKeyBackend.
*/
com.google.protobuf.ByteString getCryptoKeyBackendBytes();
public com.google.cloud.kms.v1.CryptoKey.RotationScheduleCase getRotationScheduleCase();
}