Class CertificateAuthority.KeyVersionSpec.Builder (2.54.0)

public static final class CertificateAuthority.KeyVersionSpec.Builder extends GeneratedMessageV3.Builder<CertificateAuthority.KeyVersionSpec.Builder> implements CertificateAuthority.KeyVersionSpecOrBuilder

A Cloud KMS key configuration that a CertificateAuthority will use.

Protobuf type google.cloud.security.privateca.v1beta1.CertificateAuthority.KeyVersionSpec

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public CertificateAuthority.KeyVersionSpec build()
Returns
Type Description
CertificateAuthority.KeyVersionSpec

buildPartial()

public CertificateAuthority.KeyVersionSpec buildPartial()
Returns
Type Description
CertificateAuthority.KeyVersionSpec

clear()

public CertificateAuthority.KeyVersionSpec.Builder clear()
Returns
Type Description
CertificateAuthority.KeyVersionSpec.Builder
Overrides

clearAlgorithm()

public CertificateAuthority.KeyVersionSpec.Builder clearAlgorithm()

Required. The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their ProtectionLevel as HSM.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.SignHashAlgorithm algorithm = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CertificateAuthority.KeyVersionSpec.Builder

This builder for chaining.

clearCloudKmsKeyVersion()

public CertificateAuthority.KeyVersionSpec.Builder clearCloudKmsKeyVersion()

Required. The resource name for an existing Cloud KMS CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*. This option enables full flexibility in the key's capabilities and properties.

string cloud_kms_key_version = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CertificateAuthority.KeyVersionSpec.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearKeyVersion()

public CertificateAuthority.KeyVersionSpec.Builder clearKeyVersion()
Returns
Type Description
CertificateAuthority.KeyVersionSpec.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

public CertificateAuthority.KeyVersionSpec.Builder clone()
Returns
Type Description
CertificateAuthority.KeyVersionSpec.Builder
Overrides

getAlgorithm()

public CertificateAuthority.SignHashAlgorithm getAlgorithm()

Required. The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their ProtectionLevel as HSM.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.SignHashAlgorithm algorithm = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CertificateAuthority.SignHashAlgorithm

The algorithm.

getAlgorithmValue()

public int getAlgorithmValue()

Required. The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their ProtectionLevel as HSM.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.SignHashAlgorithm algorithm = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for algorithm.

getCloudKmsKeyVersion()

public String getCloudKmsKeyVersion()

Required. The resource name for an existing Cloud KMS CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*. This option enables full flexibility in the key's capabilities and properties.

string cloud_kms_key_version = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The cloudKmsKeyVersion.

getCloudKmsKeyVersionBytes()

public ByteString getCloudKmsKeyVersionBytes()

Required. The resource name for an existing Cloud KMS CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*. This option enables full flexibility in the key's capabilities and properties.

string cloud_kms_key_version = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for cloudKmsKeyVersion.

getDefaultInstanceForType()

public CertificateAuthority.KeyVersionSpec getDefaultInstanceForType()
Returns
Type Description
CertificateAuthority.KeyVersionSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getKeyVersionCase()

public CertificateAuthority.KeyVersionSpec.KeyVersionCase getKeyVersionCase()
Returns
Type Description
CertificateAuthority.KeyVersionSpec.KeyVersionCase

hasAlgorithm()

public boolean hasAlgorithm()

Required. The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their ProtectionLevel as HSM.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.SignHashAlgorithm algorithm = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the algorithm field is set.

hasCloudKmsKeyVersion()

public boolean hasCloudKmsKeyVersion()

Required. The resource name for an existing Cloud KMS CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*. This option enables full flexibility in the key's capabilities and properties.

string cloud_kms_key_version = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the cloudKmsKeyVersion field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CertificateAuthority.KeyVersionSpec other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAlgorithm(CertificateAuthority.SignHashAlgorithm value)

public CertificateAuthority.KeyVersionSpec.Builder setAlgorithm(CertificateAuthority.SignHashAlgorithm value)

Required. The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their ProtectionLevel as HSM.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.SignHashAlgorithm algorithm = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value CertificateAuthority.SignHashAlgorithm

The algorithm to set.

Returns
Type Description
CertificateAuthority.KeyVersionSpec.Builder

This builder for chaining.

setAlgorithmValue(int value)

public CertificateAuthority.KeyVersionSpec.Builder setAlgorithmValue(int value)

Required. The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their ProtectionLevel as HSM.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.SignHashAlgorithm algorithm = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

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

Returns
Type Description
CertificateAuthority.KeyVersionSpec.Builder

This builder for chaining.

setCloudKmsKeyVersion(String value)

public CertificateAuthority.KeyVersionSpec.Builder setCloudKmsKeyVersion(String value)

Required. The resource name for an existing Cloud KMS CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*. This option enables full flexibility in the key's capabilities and properties.

string cloud_kms_key_version = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The cloudKmsKeyVersion to set.

Returns
Type Description
CertificateAuthority.KeyVersionSpec.Builder

This builder for chaining.

setCloudKmsKeyVersionBytes(ByteString value)

public CertificateAuthority.KeyVersionSpec.Builder setCloudKmsKeyVersionBytes(ByteString value)

Required. The resource name for an existing Cloud KMS CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*. This option enables full flexibility in the key's capabilities and properties.

string cloud_kms_key_version = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for cloudKmsKeyVersion to set.

Returns
Type Description
CertificateAuthority.KeyVersionSpec.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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