Class CryptoKeyVersionTemplate (2.56.0) 

public final class CryptoKeyVersionTemplate extends GeneratedMessageV3 implements CryptoKeyVersionTemplateOrBuilder

A CryptoKeyVersionTemplate specifies the properties to use when creating a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or automatically as a result of auto-rotation.

Protobuf type google.cloud.kms.v1.CryptoKeyVersionTemplate

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CryptoKeyVersionTemplate

Static Fields

ALGORITHM_FIELD_NUMBER

public static final int ALGORITHM_FIELD_NUMBER
Field Value
Type Description
int

PROTECTION_LEVEL_FIELD_NUMBER

public static final int PROTECTION_LEVEL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CryptoKeyVersionTemplate getDefaultInstance()
Returns
Type Description
CryptoKeyVersionTemplate

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CryptoKeyVersionTemplate.Builder newBuilder()
Returns
Type Description
CryptoKeyVersionTemplate.Builder

newBuilder(CryptoKeyVersionTemplate prototype)

public static CryptoKeyVersionTemplate.Builder newBuilder(CryptoKeyVersionTemplate prototype)
Parameter
Name Description
prototype CryptoKeyVersionTemplate
Returns
Type Description
CryptoKeyVersionTemplate.Builder

parseDelimitedFrom(InputStream input)

public static CryptoKeyVersionTemplate parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CryptoKeyVersionTemplate
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CryptoKeyVersionTemplate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CryptoKeyVersionTemplate
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CryptoKeyVersionTemplate parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CryptoKeyVersionTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CryptoKeyVersionTemplate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CryptoKeyVersionTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CryptoKeyVersionTemplate parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CryptoKeyVersionTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CryptoKeyVersionTemplate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CryptoKeyVersionTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CryptoKeyVersionTemplate parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CryptoKeyVersionTemplate
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CryptoKeyVersionTemplate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CryptoKeyVersionTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CryptoKeyVersionTemplate parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CryptoKeyVersionTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CryptoKeyVersionTemplate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CryptoKeyVersionTemplate
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CryptoKeyVersionTemplate parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CryptoKeyVersionTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CryptoKeyVersionTemplate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CryptoKeyVersionTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CryptoKeyVersionTemplate> parser()
Returns
Type Description
Parser<CryptoKeyVersionTemplate>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAlgorithm()

public CryptoKeyVersion.CryptoKeyVersionAlgorithm getAlgorithm()

Required. Algorithm to use when creating a CryptoKeyVersion based on this template.

For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted and CryptoKey.purpose is ENCRYPT_DECRYPT.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CryptoKeyVersion.CryptoKeyVersionAlgorithm

The algorithm.

getAlgorithmValue()

public int getAlgorithmValue()

Required. Algorithm to use when creating a CryptoKeyVersion based on this template.

For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted and CryptoKey.purpose is ENCRYPT_DECRYPT.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for algorithm.

getDefaultInstanceForType()

public CryptoKeyVersionTemplate getDefaultInstanceForType()
Returns
Type Description
CryptoKeyVersionTemplate

getParserForType()

public Parser<CryptoKeyVersionTemplate> getParserForType()
Returns
Type Description
Parser<CryptoKeyVersionTemplate>
Overrides

getProtectionLevel()

public ProtectionLevel getProtectionLevel()

ProtectionLevel to use when creating a CryptoKeyVersion based on this template. Immutable. Defaults to SOFTWARE.

.google.cloud.kms.v1.ProtectionLevel protection_level = 1;

Returns
Type Description
ProtectionLevel

The protectionLevel.

getProtectionLevelValue()

public int getProtectionLevelValue()

ProtectionLevel to use when creating a CryptoKeyVersion based on this template. Immutable. Defaults to SOFTWARE.

.google.cloud.kms.v1.ProtectionLevel protection_level = 1;

Returns
Type Description
int

The enum numeric value on the wire for protectionLevel.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CryptoKeyVersionTemplate.Builder newBuilderForType()
Returns
Type Description
CryptoKeyVersionTemplate.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CryptoKeyVersionTemplate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CryptoKeyVersionTemplate.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CryptoKeyVersionTemplate.Builder toBuilder()
Returns
Type Description
CryptoKeyVersionTemplate.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException