Class CryptoKeyVersionTemplate.Builder (2.49.0)

public static final class CryptoKeyVersionTemplate.Builder extends GeneratedMessageV3.Builder<CryptoKeyVersionTemplate.Builder> 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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CryptoKeyVersionTemplate.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CryptoKeyVersionTemplate.Builder
Overrides

build()

public CryptoKeyVersionTemplate build()
Returns
Type Description
CryptoKeyVersionTemplate

buildPartial()

public CryptoKeyVersionTemplate buildPartial()
Returns
Type Description
CryptoKeyVersionTemplate

clear()

public CryptoKeyVersionTemplate.Builder clear()
Returns
Type Description
CryptoKeyVersionTemplate.Builder
Overrides

clearAlgorithm()

public CryptoKeyVersionTemplate.Builder clearAlgorithm()

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
CryptoKeyVersionTemplate.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CryptoKeyVersionTemplate.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CryptoKeyVersionTemplate.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CryptoKeyVersionTemplate.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CryptoKeyVersionTemplate.Builder
Overrides

clearProtectionLevel()

public CryptoKeyVersionTemplate.Builder clearProtectionLevel()

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
CryptoKeyVersionTemplate.Builder

This builder for chaining.

clone()

public CryptoKeyVersionTemplate.Builder clone()
Returns
Type Description
CryptoKeyVersionTemplate.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CryptoKeyVersionTemplate other)

public CryptoKeyVersionTemplate.Builder mergeFrom(CryptoKeyVersionTemplate other)
Parameter
Name Description
other CryptoKeyVersionTemplate
Returns
Type Description
CryptoKeyVersionTemplate.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CryptoKeyVersionTemplate.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CryptoKeyVersionTemplate.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CryptoKeyVersionTemplate.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CryptoKeyVersionTemplate.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CryptoKeyVersionTemplate.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CryptoKeyVersionTemplate.Builder
Overrides

setAlgorithm(CryptoKeyVersion.CryptoKeyVersionAlgorithm value)

public CryptoKeyVersionTemplate.Builder setAlgorithm(CryptoKeyVersion.CryptoKeyVersionAlgorithm value)

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

Parameter
Name Description
value CryptoKeyVersion.CryptoKeyVersionAlgorithm

The algorithm to set.

Returns
Type Description
CryptoKeyVersionTemplate.Builder

This builder for chaining.

setAlgorithmValue(int value)

public CryptoKeyVersionTemplate.Builder setAlgorithmValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for algorithm to set.

Returns
Type Description
CryptoKeyVersionTemplate.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CryptoKeyVersionTemplate.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CryptoKeyVersionTemplate.Builder
Overrides

setProtectionLevel(ProtectionLevel value)

public CryptoKeyVersionTemplate.Builder setProtectionLevel(ProtectionLevel value)

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

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

Parameter
Name Description
value ProtectionLevel

The protectionLevel to set.

Returns
Type Description
CryptoKeyVersionTemplate.Builder

This builder for chaining.

setProtectionLevelValue(int value)

public CryptoKeyVersionTemplate.Builder setProtectionLevelValue(int value)

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for protectionLevel to set.

Returns
Type Description
CryptoKeyVersionTemplate.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CryptoKeyVersionTemplate.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CryptoKeyVersionTemplate.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final CryptoKeyVersionTemplate.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CryptoKeyVersionTemplate.Builder
Overrides