Class DecryptRequest.Builder (2.33.0)

public static final class DecryptRequest.Builder extends GeneratedMessageV3.Builder<DecryptRequest.Builder> implements DecryptRequestOrBuilder

Request message for KeyManagementService.Decrypt.

Protobuf type google.cloud.kms.v1.DecryptRequest

Inheritance

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

Implements

DecryptRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DecryptRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DecryptRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public DecryptRequest build()

Returns
Type	Description
`DecryptRequest`

buildPartial()

public DecryptRequest buildPartial()

Returns
Type	Description
`DecryptRequest`

clear()

public DecryptRequest.Builder clear()

Returns
Type	Description
`DecryptRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAdditionalAuthenticatedData()

public DecryptRequest.Builder clearAdditionalAuthenticatedData()

Optional. Optional data that must match the data originally supplied in EncryptRequest.additional_authenticated_data.

bytes additional_authenticated_data = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`DecryptRequest.Builder`	This builder for chaining.

clearAdditionalAuthenticatedDataCrc32C()

public DecryptRequest.Builder clearAdditionalAuthenticatedDataCrc32C()

Optional. An optional CRC32C checksum of the DecryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received DecryptRequest.additional_authenticated_data 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(DecryptRequest.additional_authenticated_data) is equal to DecryptRequest.additional_authenticated_data_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 additional_authenticated_data_crc32c = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`DecryptRequest.Builder`

clearCiphertext()

public DecryptRequest.Builder clearCiphertext()

Required. The encrypted data originally returned in EncryptResponse.ciphertext.

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

Returns
Type	Description
`DecryptRequest.Builder`	This builder for chaining.

clearCiphertextCrc32C()

public DecryptRequest.Builder clearCiphertextCrc32C()

Optional. An optional CRC32C checksum of the DecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecryptRequest.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(DecryptRequest.ciphertext) is equal to DecryptRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`DecryptRequest.Builder`

clearField(Descriptors.FieldDescriptor field)

public DecryptRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`DecryptRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearName()

public DecryptRequest.Builder clearName()

Required. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version.

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

Returns
Type	Description
`DecryptRequest.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DecryptRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`DecryptRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public DecryptRequest.Builder clone()

Returns
Type	Description
`DecryptRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAdditionalAuthenticatedData()

public ByteString getAdditionalAuthenticatedData()

Optional. Optional data that must match the data originally supplied in EncryptRequest.additional_authenticated_data.

bytes additional_authenticated_data = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The additionalAuthenticatedData.

getAdditionalAuthenticatedDataCrc32C()

public Int64Value getAdditionalAuthenticatedDataCrc32C()

.google.protobuf.Int64Value additional_authenticated_data_crc32c = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Int64Value`	The additionalAuthenticatedDataCrc32c.

getAdditionalAuthenticatedDataCrc32CBuilder()

public Int64Value.Builder getAdditionalAuthenticatedDataCrc32CBuilder()

.google.protobuf.Int64Value additional_authenticated_data_crc32c = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Builder`

getAdditionalAuthenticatedDataCrc32COrBuilder()

public Int64ValueOrBuilder getAdditionalAuthenticatedDataCrc32COrBuilder()

.google.protobuf.Int64Value additional_authenticated_data_crc32c = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Int64ValueOrBuilder`

getCiphertext()

public ByteString getCiphertext()

Required. The encrypted data originally returned in EncryptResponse.ciphertext.

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

Returns
Type	Description
`ByteString`	The ciphertext.

getCiphertextCrc32C()

public Int64Value getCiphertextCrc32C()

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

Returns
Type	Description
`Int64Value`	The ciphertextCrc32c.

getCiphertextCrc32CBuilder()

public Int64Value.Builder getCiphertextCrc32CBuilder()

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

Returns
Type	Description
`Builder`

getCiphertextCrc32COrBuilder()

public Int64ValueOrBuilder getCiphertextCrc32COrBuilder()

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

Returns
Type	Description
`Int64ValueOrBuilder`

getDefaultInstanceForType()

public DecryptRequest getDefaultInstanceForType()

Returns
Type	Description
`DecryptRequest`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getName()

public String getName()

Required. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version.

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 CryptoKey to use for decryption. The server will choose the appropriate version.

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

Returns
Type	Description
`ByteString`	The bytes for name.

hasAdditionalAuthenticatedDataCrc32C()

public boolean hasAdditionalAuthenticatedDataCrc32C()

.google.protobuf.Int64Value additional_authenticated_data_crc32c = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the additionalAuthenticatedDataCrc32c field is set.

hasCiphertextCrc32C()

public boolean hasCiphertextCrc32C()

.google.protobuf.Int64Value ciphertext_crc32c = 5 [(.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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeAdditionalAuthenticatedDataCrc32C(Int64Value value)

public DecryptRequest.Builder mergeAdditionalAuthenticatedDataCrc32C(Int64Value value)

.google.protobuf.Int64Value additional_authenticated_data_crc32c = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Int64Value`

Returns
Type	Description
`DecryptRequest.Builder`

mergeCiphertextCrc32C(Int64Value value)

public DecryptRequest.Builder mergeCiphertextCrc32C(Int64Value value)

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

Parameter
Name	Description
`value`	`Int64Value`

Returns
Type	Description
`DecryptRequest.Builder`

mergeFrom(DecryptRequest other)

public DecryptRequest.Builder mergeFrom(DecryptRequest other)

Parameter
Name	Description
`other`	`DecryptRequest`

Returns
Type	Description
`DecryptRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DecryptRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DecryptRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public DecryptRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`DecryptRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DecryptRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DecryptRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAdditionalAuthenticatedData(ByteString value)

public DecryptRequest.Builder setAdditionalAuthenticatedData(ByteString value)

Optional. Optional data that must match the data originally supplied in EncryptRequest.additional_authenticated_data.

bytes additional_authenticated_data = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ByteString` The additionalAuthenticatedData to set.

Returns
Type	Description
`DecryptRequest.Builder`	This builder for chaining.

setAdditionalAuthenticatedDataCrc32C(Int64Value value)

public DecryptRequest.Builder setAdditionalAuthenticatedDataCrc32C(Int64Value value)

.google.protobuf.Int64Value additional_authenticated_data_crc32c = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Int64Value`

Returns
Type	Description
`DecryptRequest.Builder`

setAdditionalAuthenticatedDataCrc32C(Int64Value.Builder builderForValue)

public DecryptRequest.Builder setAdditionalAuthenticatedDataCrc32C(Int64Value.Builder builderForValue)

.google.protobuf.Int64Value additional_authenticated_data_crc32c = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`DecryptRequest.Builder`

setCiphertext(ByteString value)

public DecryptRequest.Builder setCiphertext(ByteString value)

Required. The encrypted data originally returned in EncryptResponse.ciphertext.

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

Parameter
Name	Description
`value`	`ByteString` The ciphertext to set.

Returns
Type	Description
`DecryptRequest.Builder`	This builder for chaining.

setCiphertextCrc32C(Int64Value value)

public DecryptRequest.Builder setCiphertextCrc32C(Int64Value value)

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

Parameter
Name	Description
`value`	`Int64Value`

Returns
Type	Description
`DecryptRequest.Builder`

setCiphertextCrc32C(Int64Value.Builder builderForValue)

public DecryptRequest.Builder setCiphertextCrc32C(Int64Value.Builder builderForValue)

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

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`DecryptRequest.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public DecryptRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DecryptRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setName(String value)

public DecryptRequest.Builder setName(String value)

Required. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version.

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

Parameter
Name	Description
`value`	`String` The name to set.

Returns
Type	Description
`DecryptRequest.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public DecryptRequest.Builder setNameBytes(ByteString value)

Required. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version.

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
`DecryptRequest.Builder`	This builder for chaining.

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`DecryptRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final DecryptRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DecryptRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)