Class DecapsulateRequest.Builder (2.77.0)

public static final class DecapsulateRequest.Builder extends GeneratedMessageV3.Builder<DecapsulateRequest.Builder> implements DecapsulateRequestOrBuilder

Request message for KeyManagementService.Decapsulate.

Protobuf type google.cloud.kms.v1.DecapsulateRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public DecapsulateRequest build()
Returns
Type Description
DecapsulateRequest

buildPartial()

public DecapsulateRequest buildPartial()
Returns
Type Description
DecapsulateRequest

clear()

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

clearCiphertext()

public DecapsulateRequest.Builder clearCiphertext()

Required. The ciphertext produced from encapsulation with the named CryptoKeyVersion public key(s).

bytes ciphertext = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DecapsulateRequest.Builder

This builder for chaining.

clearCiphertextCrc32C()

public DecapsulateRequest.Builder clearCiphertextCrc32C()

Optional. A CRC32C checksum of the DecapsulateRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecapsulateRequest.ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(DecapsulateRequest.ciphertext) is equal to DecapsulateRequest.ciphertext_crc32c, and if so, 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.

.google.protobuf.Int64Value ciphertext_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DecapsulateRequest.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearName()

public DecapsulateRequest.Builder clearName()

Required. The resource name of the CryptoKeyVersion to use for decapsulation.

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

Returns
Type Description
DecapsulateRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

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

getCiphertext()

public ByteString getCiphertext()

Required. The ciphertext produced from encapsulation with the named CryptoKeyVersion public key(s).

bytes ciphertext = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The ciphertext.

getCiphertextCrc32C()

public Int64Value getCiphertextCrc32C()

Optional. A CRC32C checksum of the DecapsulateRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecapsulateRequest.ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(DecapsulateRequest.ciphertext) is equal to DecapsulateRequest.ciphertext_crc32c, and if so, 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.

.google.protobuf.Int64Value ciphertext_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Int64Value

The ciphertextCrc32c.

getCiphertextCrc32CBuilder()

public Int64Value.Builder getCiphertextCrc32CBuilder()

Optional. A CRC32C checksum of the DecapsulateRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecapsulateRequest.ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(DecapsulateRequest.ciphertext) is equal to DecapsulateRequest.ciphertext_crc32c, and if so, 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.

.google.protobuf.Int64Value ciphertext_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getCiphertextCrc32COrBuilder()

public Int64ValueOrBuilder getCiphertextCrc32COrBuilder()

Optional. A CRC32C checksum of the DecapsulateRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecapsulateRequest.ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(DecapsulateRequest.ciphertext) is equal to DecapsulateRequest.ciphertext_crc32c, and if so, 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.

.google.protobuf.Int64Value ciphertext_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Int64ValueOrBuilder

getDefaultInstanceForType()

public DecapsulateRequest getDefaultInstanceForType()
Returns
Type Description
DecapsulateRequest

getDescriptorForType()

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

getName()

public String getName()

Required. The resource name of the CryptoKeyVersion to use for decapsulation.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The resource name of the CryptoKeyVersion to use for decapsulation.

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

Returns
Type Description
ByteString

The bytes for name.

hasCiphertextCrc32C()

public boolean hasCiphertextCrc32C()

Optional. A CRC32C checksum of the DecapsulateRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecapsulateRequest.ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(DecapsulateRequest.ciphertext) is equal to DecapsulateRequest.ciphertext_crc32c, and if so, 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.

.google.protobuf.Int64Value ciphertext_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ciphertextCrc32c field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCiphertextCrc32C(Int64Value value)

public DecapsulateRequest.Builder mergeCiphertextCrc32C(Int64Value value)

Optional. A CRC32C checksum of the DecapsulateRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecapsulateRequest.ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(DecapsulateRequest.ciphertext) is equal to DecapsulateRequest.ciphertext_crc32c, and if so, 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.

.google.protobuf.Int64Value ciphertext_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Int64Value
Returns
Type Description
DecapsulateRequest.Builder

mergeFrom(DecapsulateRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setCiphertext(ByteString value)

public DecapsulateRequest.Builder setCiphertext(ByteString value)

Required. The ciphertext produced from encapsulation with the named CryptoKeyVersion public key(s).

bytes ciphertext = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The ciphertext to set.

Returns
Type Description
DecapsulateRequest.Builder

This builder for chaining.

setCiphertextCrc32C(Int64Value value)

public DecapsulateRequest.Builder setCiphertextCrc32C(Int64Value value)

Optional. A CRC32C checksum of the DecapsulateRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecapsulateRequest.ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(DecapsulateRequest.ciphertext) is equal to DecapsulateRequest.ciphertext_crc32c, and if so, 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.

.google.protobuf.Int64Value ciphertext_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Int64Value
Returns
Type Description
DecapsulateRequest.Builder

setCiphertextCrc32C(Int64Value.Builder builderForValue)

public DecapsulateRequest.Builder setCiphertextCrc32C(Int64Value.Builder builderForValue)

Optional. A CRC32C checksum of the DecapsulateRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecapsulateRequest.ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(DecapsulateRequest.ciphertext) is equal to DecapsulateRequest.ciphertext_crc32c, and if so, 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.

.google.protobuf.Int64Value ciphertext_crc32c = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DecapsulateRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public DecapsulateRequest.Builder setName(String value)

Required. The resource name of the CryptoKeyVersion to use for decapsulation.

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
DecapsulateRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DecapsulateRequest.Builder setNameBytes(ByteString value)

Required. The resource name of the CryptoKeyVersion to use for decapsulation.

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

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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