Class PublicKey.Builder (2.49.0) 

public static final class PublicKey.Builder extends GeneratedMessageV3.Builder<PublicKey.Builder> implements PublicKeyOrBuilder

The public keys for a given CryptoKeyVersion. Obtained via GetPublicKey.

Protobuf type google.cloud.kms.v1.PublicKey

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PublicKey.Builder

Implements

PublicKeyOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public PublicKey build()
Returns
Type Description
PublicKey

buildPartial()

public PublicKey buildPartial()
Returns
Type Description
PublicKey

clear()

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

clearAlgorithm()

public PublicKey.Builder clearAlgorithm()

The Algorithm associated with this key.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 2;

Returns
Type Description
PublicKey.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearName()

public PublicKey.Builder clearName()

The name of the CryptoKeyVersion public key. Provided here for verification.

NOTE: This field is in Beta.

string name = 4;

Returns
Type Description
PublicKey.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPem()

public PublicKey.Builder clearPem()

The public key, encoded in PEM format. For more information, see the RFC 7468 sections for General Considerations and Textual Encoding of Subject Public Key Info.

string pem = 1;

Returns
Type Description
PublicKey.Builder

This builder for chaining.

clearPemCrc32C()

public PublicKey.Builder clearPemCrc32C()

Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

NOTE: This field is in Beta.

.google.protobuf.Int64Value pem_crc32c = 3;

Returns
Type Description
PublicKey.Builder

clearProtectionLevel()

public PublicKey.Builder clearProtectionLevel()

The ProtectionLevel of the CryptoKeyVersion public key.

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

Returns
Type Description
PublicKey.Builder

This builder for chaining.

clone()

public PublicKey.Builder clone()
Returns
Type Description
PublicKey.Builder
Overrides

getAlgorithm()

public CryptoKeyVersion.CryptoKeyVersionAlgorithm getAlgorithm()

The Algorithm associated with this key.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 2;

Returns
Type Description
CryptoKeyVersion.CryptoKeyVersionAlgorithm

The algorithm.

getAlgorithmValue()

public int getAlgorithmValue()

The Algorithm associated with this key.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 2;

Returns
Type Description
int

The enum numeric value on the wire for algorithm.

getDefaultInstanceForType()

public PublicKey getDefaultInstanceForType()
Returns
Type Description
PublicKey

getDescriptorForType()

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

getName()

public String getName()

The name of the CryptoKeyVersion public key. Provided here for verification.

NOTE: This field is in Beta.

string name = 4;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the CryptoKeyVersion public key. Provided here for verification.

NOTE: This field is in Beta.

string name = 4;

Returns
Type Description
ByteString

The bytes for name.

getPem()

public String getPem()

The public key, encoded in PEM format. For more information, see the RFC 7468 sections for General Considerations and Textual Encoding of Subject Public Key Info.

string pem = 1;

Returns
Type Description
String

The pem.

getPemBytes()

public ByteString getPemBytes()

The public key, encoded in PEM format. For more information, see the RFC 7468 sections for General Considerations and Textual Encoding of Subject Public Key Info.

string pem = 1;

Returns
Type Description
ByteString

The bytes for pem.

getPemCrc32C()

public Int64Value getPemCrc32C()

Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

NOTE: This field is in Beta.

.google.protobuf.Int64Value pem_crc32c = 3;

Returns
Type Description
Int64Value

The pemCrc32c.

getPemCrc32CBuilder()

public Int64Value.Builder getPemCrc32CBuilder()

Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

NOTE: This field is in Beta.

.google.protobuf.Int64Value pem_crc32c = 3;

Returns
Type Description
Builder

getPemCrc32COrBuilder()

public Int64ValueOrBuilder getPemCrc32COrBuilder()

Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

NOTE: This field is in Beta.

.google.protobuf.Int64Value pem_crc32c = 3;

Returns
Type Description
Int64ValueOrBuilder

getProtectionLevel()

public ProtectionLevel getProtectionLevel()

The ProtectionLevel of the CryptoKeyVersion public key.

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

Returns
Type Description
ProtectionLevel

The protectionLevel.

getProtectionLevelValue()

public int getProtectionLevelValue()

The ProtectionLevel of the CryptoKeyVersion public key.

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

Returns
Type Description
int

The enum numeric value on the wire for protectionLevel.

hasPemCrc32C()

public boolean hasPemCrc32C()

Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

NOTE: This field is in Beta.

.google.protobuf.Int64Value pem_crc32c = 3;

Returns
Type Description
boolean

Whether the pemCrc32c field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PublicKey other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergePemCrc32C(Int64Value value)

public PublicKey.Builder mergePemCrc32C(Int64Value value)

Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

NOTE: This field is in Beta.

.google.protobuf.Int64Value pem_crc32c = 3;

Parameter
Name Description
value Int64Value
Returns
Type Description
PublicKey.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAlgorithm(CryptoKeyVersion.CryptoKeyVersionAlgorithm value)

public PublicKey.Builder setAlgorithm(CryptoKeyVersion.CryptoKeyVersionAlgorithm value)

The Algorithm associated with this key.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 2;

Parameter
Name Description
value CryptoKeyVersion.CryptoKeyVersionAlgorithm

The algorithm to set.
Returns
Type Description
PublicKey.Builder

This builder for chaining.

setAlgorithmValue(int value)

public PublicKey.Builder setAlgorithmValue(int value)

The Algorithm associated with this key.

.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionAlgorithm algorithm = 2;

Parameter
Name Description
value int

The enum numeric value on the wire for algorithm to set.
Returns
Type Description
PublicKey.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public PublicKey.Builder setName(String value)

The name of the CryptoKeyVersion public key. Provided here for verification.

NOTE: This field is in Beta.

string name = 4;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
PublicKey.Builder

This builder for chaining.

setNameBytes(ByteString value)

public PublicKey.Builder setNameBytes(ByteString value)

The name of the CryptoKeyVersion public key. Provided here for verification.

NOTE: This field is in Beta.

string name = 4;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
PublicKey.Builder

This builder for chaining.

setPem(String value)

public PublicKey.Builder setPem(String value)

The public key, encoded in PEM format. For more information, see the RFC 7468 sections for General Considerations and Textual Encoding of Subject Public Key Info.

string pem = 1;

Parameter
Name Description
value String

The pem to set.
Returns
Type Description
PublicKey.Builder

This builder for chaining.

setPemBytes(ByteString value)

public PublicKey.Builder setPemBytes(ByteString value)

The public key, encoded in PEM format. For more information, see the RFC 7468 sections for General Considerations and Textual Encoding of Subject Public Key Info.

string pem = 1;

Parameter
Name Description
value ByteString

The bytes for pem to set.
Returns
Type Description
PublicKey.Builder

This builder for chaining.

setPemCrc32C(Int64Value value)

public PublicKey.Builder setPemCrc32C(Int64Value value)

Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

NOTE: This field is in Beta.

.google.protobuf.Int64Value pem_crc32c = 3;

Parameter
Name Description
value Int64Value
Returns
Type Description
PublicKey.Builder

setPemCrc32C(Int64Value.Builder builderForValue)

public PublicKey.Builder setPemCrc32C(Int64Value.Builder builderForValue)

Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

NOTE: This field is in Beta.

.google.protobuf.Int64Value pem_crc32c = 3;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PublicKey.Builder

setProtectionLevel(ProtectionLevel value)

public PublicKey.Builder setProtectionLevel(ProtectionLevel value)

The ProtectionLevel of the CryptoKeyVersion public key.

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

Parameter
Name Description
value ProtectionLevel

The protectionLevel to set.
Returns
Type Description
PublicKey.Builder

This builder for chaining.

setProtectionLevelValue(int value)

public PublicKey.Builder setProtectionLevelValue(int value)

The ProtectionLevel of the CryptoKeyVersion public key.

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

Parameter
Name Description
value int

The enum numeric value on the wire for protectionLevel to set.
Returns
Type Description
PublicKey.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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