Class GetPublicKeyRequest.Builder (2.73.0) 

public static final class GetPublicKeyRequest.Builder extends GeneratedMessageV3.Builder<GetPublicKeyRequest.Builder> implements GetPublicKeyRequestOrBuilder

Request message for KeyManagementService.GetPublicKey.

Protobuf type google.cloud.kms.v1.GetPublicKeyRequest

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public GetPublicKeyRequest build()
Returns
Type Description
GetPublicKeyRequest

buildPartial()

public GetPublicKeyRequest buildPartial()
Returns
Type Description
GetPublicKeyRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearName()

public GetPublicKeyRequest.Builder clearName()

Required. The name of the CryptoKeyVersion public key to get.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
GetPublicKeyRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPublicKeyFormat()

public GetPublicKeyRequest.Builder clearPublicKeyFormat()

Optional. The PublicKey format specified by the user. This field is required for PQC algorithms. If specified, the public key will be exported through the public_key field in the requested format. Otherwise, the pem field will be populated for non-PQC algorithms, and an error will be returned for PQC algorithms.

.google.cloud.kms.v1.PublicKey.PublicKeyFormat public_key_format = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GetPublicKeyRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public GetPublicKeyRequest getDefaultInstanceForType()
Returns
Type Description
GetPublicKeyRequest

getDescriptorForType()

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

getName()

public String getName()

Required. The name of the CryptoKeyVersion public key to get.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the CryptoKeyVersion public key to get.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getPublicKeyFormat()

public PublicKey.PublicKeyFormat getPublicKeyFormat()

Optional. The PublicKey format specified by the user. This field is required for PQC algorithms. If specified, the public key will be exported through the public_key field in the requested format. Otherwise, the pem field will be populated for non-PQC algorithms, and an error will be returned for PQC algorithms.

.google.cloud.kms.v1.PublicKey.PublicKeyFormat public_key_format = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PublicKey.PublicKeyFormat

The publicKeyFormat.

getPublicKeyFormatValue()

public int getPublicKeyFormatValue()

Optional. The PublicKey format specified by the user. This field is required for PQC algorithms. If specified, the public key will be exported through the public_key field in the requested format. Otherwise, the pem field will be populated for non-PQC algorithms, and an error will be returned for PQC algorithms.

.google.cloud.kms.v1.PublicKey.PublicKeyFormat public_key_format = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for publicKeyFormat.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(GetPublicKeyRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public GetPublicKeyRequest.Builder setName(String value)

Required. The name of the CryptoKeyVersion public key to get.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The name to set.
Returns
Type Description
GetPublicKeyRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public GetPublicKeyRequest.Builder setNameBytes(ByteString value)

Required. The name of the CryptoKeyVersion public key to get.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

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

This builder for chaining.

setPublicKeyFormat(PublicKey.PublicKeyFormat value)

public GetPublicKeyRequest.Builder setPublicKeyFormat(PublicKey.PublicKeyFormat value)

Optional. The PublicKey format specified by the user. This field is required for PQC algorithms. If specified, the public key will be exported through the public_key field in the requested format. Otherwise, the pem field will be populated for non-PQC algorithms, and an error will be returned for PQC algorithms.

.google.cloud.kms.v1.PublicKey.PublicKeyFormat public_key_format = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value PublicKey.PublicKeyFormat

The publicKeyFormat to set.
Returns
Type Description
GetPublicKeyRequest.Builder

This builder for chaining.

setPublicKeyFormatValue(int value)

public GetPublicKeyRequest.Builder setPublicKeyFormatValue(int value)

Optional. The PublicKey format specified by the user. This field is required for PQC algorithms. If specified, the public key will be exported through the public_key field in the requested format. Otherwise, the pem field will be populated for non-PQC algorithms, and an error will be returned for PQC algorithms.

.google.cloud.kms.v1.PublicKey.PublicKeyFormat public_key_format = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for publicKeyFormat to set.
Returns
Type Description
GetPublicKeyRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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