com.google.cloud.kms.v1

Class CryptoKey

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.kms.v1.CryptoKey

All Implemented Interfaces:

CryptoKeyOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class CryptoKey
extends GeneratedMessageV3
implements CryptoKeyOrBuilder

 A [CryptoKey][google.cloud.kms.v1.CryptoKey] represents a logical key that
 can be used for cryptographic operations.
 A [CryptoKey][google.cloud.kms.v1.CryptoKey] is made up of zero or more
 [versions][google.cloud.kms.v1.CryptoKeyVersion], which represent the actual
 key material used in cryptographic operations.
 

Protobuf type google.cloud.kms.v1.CryptoKey

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CryptoKey.Builder A [CryptoKey][google.cloud.kms.v1.CryptoKey] represents a logical key that can be used for cryptographic operations.
static class	CryptoKey.CryptoKeyPurpose [CryptoKeyPurpose][google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose] describes the cryptographic capabilities of a [CryptoKey][google.cloud.kms.v1.CryptoKey].
static class	CryptoKey.RotationScheduleCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CREATE_TIME_FIELD_NUMBER
static int	CRYPTO_KEY_BACKEND_FIELD_NUMBER
static int	DESTROY_SCHEDULED_DURATION_FIELD_NUMBER
static int	IMPORT_ONLY_FIELD_NUMBER
static int	LABELS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	NEXT_ROTATION_TIME_FIELD_NUMBER
static int	PRIMARY_FIELD_NUMBER
static int	PURPOSE_FIELD_NUMBER
static int	ROTATION_PERIOD_FIELD_NUMBER
static int	VERSION_TEMPLATE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Labels with user-defined metadata.
boolean	equals(Object obj)
Timestamp	getCreateTime() Output only.
TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getCryptoKeyBackend() Immutable.
ByteString	getCryptoKeyBackendBytes() Immutable.
static CryptoKey	getDefaultInstance()
CryptoKey	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Duration	getDestroyScheduledDuration() Immutable.
DurationOrBuilder	getDestroyScheduledDurationOrBuilder() Immutable.
boolean	getImportOnly() Immutable.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Labels with user-defined metadata.
Map<String,String>	getLabelsMap() Labels with user-defined metadata.
String	getLabelsOrDefault(String key, String defaultValue) Labels with user-defined metadata.
String	getLabelsOrThrow(String key) Labels with user-defined metadata.
String	getName() Output only.
ByteString	getNameBytes() Output only.
Timestamp	getNextRotationTime() At [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time], the Key Management Service will automatically: 1.
TimestampOrBuilder	getNextRotationTimeOrBuilder() At [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time], the Key Management Service will automatically: 1.
Parser<CryptoKey>	getParserForType()
CryptoKeyVersion	getPrimary() Output only.
CryptoKeyVersionOrBuilder	getPrimaryOrBuilder() Output only.
CryptoKey.CryptoKeyPurpose	getPurpose() Immutable.
int	getPurposeValue() Immutable.
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.
DurationOrBuilder	getRotationPeriodOrBuilder() [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time] will be advanced by this period when the service automatically rotates a key.
CryptoKey.RotationScheduleCase	getRotationScheduleCase()
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
CryptoKeyVersionTemplate	getVersionTemplate() A template describing settings for new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] instances.
CryptoKeyVersionTemplateOrBuilder	getVersionTemplateOrBuilder() A template describing settings for new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] instances.
boolean	hasCreateTime() Output only.
boolean	hasDestroyScheduledDuration() Immutable.
int	hashCode()
boolean	hasNextRotationTime() At [next_rotation_time][google.cloud.kms.v1.CryptoKey.next_rotation_time], the Key Management Service will automatically: 1.
boolean	hasPrimary() Output only.
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.
boolean	hasVersionTemplate() A template describing settings for new [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] instances.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected MapField	internalGetMapField(int number)
boolean	isInitialized()
static CryptoKey.Builder	newBuilder()
static CryptoKey.Builder	newBuilder(CryptoKey prototype)
CryptoKey.Builder	newBuilderForType()
protected CryptoKey.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static CryptoKey	parseDelimitedFrom(InputStream input)
static CryptoKey	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static CryptoKey	parseFrom(byte[] data)
static CryptoKey	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static CryptoKey	parseFrom(ByteBuffer data)
static CryptoKey	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static CryptoKey	parseFrom(ByteString data)
static CryptoKey	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static CryptoKey	parseFrom(CodedInputStream input)
static CryptoKey	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static CryptoKey	parseFrom(InputStream input)
static CryptoKey	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<CryptoKey>	parser()
CryptoKey.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

PRIMARY_FIELD_NUMBER

public static final int PRIMARY_FIELD_NUMBER

See Also:

Constant Field Values

PURPOSE_FIELD_NUMBER

public static final int PURPOSE_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

NEXT_ROTATION_TIME_FIELD_NUMBER

public static final int NEXT_ROTATION_TIME_FIELD_NUMBER

See Also:

Constant Field Values

ROTATION_PERIOD_FIELD_NUMBER

public static final int ROTATION_PERIOD_FIELD_NUMBER

See Also:

Constant Field Values

VERSION_TEMPLATE_FIELD_NUMBER

public static final int VERSION_TEMPLATE_FIELD_NUMBER

See Also:

Constant Field Values

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

See Also:

Constant Field Values

IMPORT_ONLY_FIELD_NUMBER

public static final int IMPORT_ONLY_FIELD_NUMBER

See Also:

Constant Field Values

DESTROY_SCHEDULED_DURATION_FIELD_NUMBER

public static final int DESTROY_SCHEDULED_DURATION_FIELD_NUMBER

See Also:

Constant Field Values

CRYPTO_KEY_BACKEND_FIELD_NUMBER

public static final int CRYPTO_KEY_BACKEND_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapField

protected MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class GeneratedMessageV3

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getRotationScheduleCase

public CryptoKey.RotationScheduleCase getRotationScheduleCase()

Specified by:

getRotationScheduleCase in interface CryptoKeyOrBuilder

getName

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

Specified by:

getName in interface CryptoKeyOrBuilder

Returns:

The name.

getNameBytes

public ByteString getNameBytes()

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

Specified by:

getNameBytes in interface CryptoKeyOrBuilder

Returns:

The bytes for name.

hasPrimary

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

Specified by:

hasPrimary in interface CryptoKeyOrBuilder

Returns:

Whether the primary field is set.

getPrimary

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

Specified by:

getPrimary in interface CryptoKeyOrBuilder

Returns:

The primary.

getPrimaryOrBuilder

public CryptoKeyVersionOrBuilder getPrimaryOrBuilder()

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

Specified by:

getPrimaryOrBuilder in interface CryptoKeyOrBuilder

getPurposeValue

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

Specified by:

getPurposeValue in interface CryptoKeyOrBuilder

Returns:

The enum numeric value on the wire for purpose.

getPurpose

public CryptoKey.CryptoKeyPurpose getPurpose()

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

Specified by:

getPurpose in interface CryptoKeyOrBuilder

Returns:

The purpose.

hasCreateTime

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

Specified by:

hasCreateTime in interface CryptoKeyOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

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

Specified by:

getCreateTime in interface CryptoKeyOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public TimestampOrBuilder getCreateTimeOrBuilder()

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

Specified by:

getCreateTimeOrBuilder in interface CryptoKeyOrBuilder

hasNextRotationTime

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

Specified by:

hasNextRotationTime in interface CryptoKeyOrBuilder

Returns:

Whether the nextRotationTime field is set.

getNextRotationTime

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

Specified by:

getNextRotationTime in interface CryptoKeyOrBuilder

Returns:

The nextRotationTime.

getNextRotationTimeOrBuilder

public TimestampOrBuilder getNextRotationTimeOrBuilder()

 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;

Specified by:

getNextRotationTimeOrBuilder in interface CryptoKeyOrBuilder

hasRotationPeriod

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

Specified by:

hasRotationPeriod in interface CryptoKeyOrBuilder

Returns:

Whether the rotationPeriod field is set.

getRotationPeriod

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

Specified by:

getRotationPeriod in interface CryptoKeyOrBuilder

Returns:

The rotationPeriod.

getRotationPeriodOrBuilder

public DurationOrBuilder getRotationPeriodOrBuilder()

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

Specified by:

getRotationPeriodOrBuilder in interface CryptoKeyOrBuilder

hasVersionTemplate

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

Specified by:

hasVersionTemplate in interface CryptoKeyOrBuilder

Returns:

Whether the versionTemplate field is set.

getVersionTemplate

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

Specified by:

getVersionTemplate in interface CryptoKeyOrBuilder

Returns:

The versionTemplate.

getVersionTemplateOrBuilder

public CryptoKeyVersionTemplateOrBuilder getVersionTemplateOrBuilder()

 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;

Specified by:

getVersionTemplateOrBuilder in interface CryptoKeyOrBuilder

getLabelsCount

public int getLabelsCount()

Description copied from interface: CryptoKeyOrBuilder

 Labels with user-defined metadata. For more information, see
 [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
 

map<string, string> labels = 10;

Specified by:

getLabelsCount in interface CryptoKeyOrBuilder

containsLabels

public boolean containsLabels(String key)

 Labels with user-defined metadata. For more information, see
 [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
 

map<string, string> labels = 10;

Specified by:

containsLabels in interface CryptoKeyOrBuilder

getLabels

@Deprecated
public Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels in interface CryptoKeyOrBuilder

getLabelsMap

public Map<String,String> 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;

Specified by:

getLabelsMap in interface CryptoKeyOrBuilder

getLabelsOrDefault

public String getLabelsOrDefault(String key,
                                 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;

Specified by:

getLabelsOrDefault in interface CryptoKeyOrBuilder

getLabelsOrThrow

public String getLabelsOrThrow(String key)

 Labels with user-defined metadata. For more information, see
 [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys).
 

map<string, string> labels = 10;

Specified by:

getLabelsOrThrow in interface CryptoKeyOrBuilder

getImportOnly

public boolean getImportOnly()

 Immutable. Whether this key may contain imported versions only.
 

bool import_only = 13 [(.google.api.field_behavior) = IMMUTABLE];

Specified by:

getImportOnly in interface CryptoKeyOrBuilder

Returns:

The importOnly.

hasDestroyScheduledDuration

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

Specified by:

hasDestroyScheduledDuration in interface CryptoKeyOrBuilder

Returns:

Whether the destroyScheduledDuration field is set.

getDestroyScheduledDuration

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

Specified by:

getDestroyScheduledDuration in interface CryptoKeyOrBuilder

Returns:

The destroyScheduledDuration.

getDestroyScheduledDurationOrBuilder

public DurationOrBuilder getDestroyScheduledDurationOrBuilder()

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

Specified by:

getDestroyScheduledDurationOrBuilder in interface CryptoKeyOrBuilder

getCryptoKeyBackend

public 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) = { ... }

Specified by:

getCryptoKeyBackend in interface CryptoKeyOrBuilder

Returns:

The cryptoKeyBackend.

getCryptoKeyBackendBytes

public ByteString getCryptoKeyBackendBytes()

 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) = { ... }

Specified by:

getCryptoKeyBackendBytes in interface CryptoKeyOrBuilder

Returns:

The bytes for cryptoKeyBackend.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static CryptoKey parseFrom(ByteBuffer data)
                           throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static CryptoKey parseFrom(ByteBuffer data,
                                  ExtensionRegistryLite extensionRegistry)
                           throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static CryptoKey parseFrom(ByteString data)
                           throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static CryptoKey parseFrom(ByteString data,
                                  ExtensionRegistryLite extensionRegistry)
                           throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static CryptoKey parseFrom(byte[] data)
                           throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static CryptoKey parseFrom(byte[] data,
                                  ExtensionRegistryLite extensionRegistry)
                           throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static CryptoKey parseFrom(InputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static CryptoKey parseFrom(InputStream input,
                                  ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static CryptoKey parseDelimitedFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static CryptoKey parseDelimitedFrom(InputStream input,
                                           ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseFrom

public static CryptoKey parseFrom(CodedInputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static CryptoKey parseFrom(CodedInputStream input,
                                  ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

newBuilderForType

public CryptoKey.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static CryptoKey.Builder newBuilder()

newBuilder

public static CryptoKey.Builder newBuilder(CryptoKey prototype)

toBuilder

public CryptoKey.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected CryptoKey.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static CryptoKey getDefaultInstance()

parser

public static Parser<CryptoKey> parser()

getParserForType

public Parser<CryptoKey> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public CryptoKey getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder