Class EncryptResponse.Builder (2.56.0) 

public static final class EncryptResponse.Builder extends GeneratedMessageV3.Builder<EncryptResponse.Builder> implements EncryptResponseOrBuilder

Response message for KeyManagementService.Encrypt.

Protobuf type google.cloud.kms.v1.EncryptResponse

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public EncryptResponse build()
Returns
Type Description
EncryptResponse

buildPartial()

public EncryptResponse buildPartial()
Returns
Type Description
EncryptResponse

clear()

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

clearCiphertext()

public EncryptResponse.Builder clearCiphertext()

The encrypted data.

bytes ciphertext = 2;

Returns
Type Description
EncryptResponse.Builder

This builder for chaining.

clearCiphertextCrc32C()

public EncryptResponse.Builder clearCiphertextCrc32C()

Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext. An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext 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.

.google.protobuf.Int64Value ciphertext_crc32c = 4;

Returns
Type Description
EncryptResponse.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearName()

public EncryptResponse.Builder clearName()

The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.

string name = 1;

Returns
Type Description
EncryptResponse.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearProtectionLevel()

public EncryptResponse.Builder clearProtectionLevel()

The ProtectionLevel of the CryptoKeyVersion used in encryption.

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

Returns
Type Description
EncryptResponse.Builder

This builder for chaining.

clearVerifiedAdditionalAuthenticatedDataCrc32C()

public EncryptResponse.Builder clearVerifiedAdditionalAuthenticatedDataCrc32C()

Integrity verification field. A flag indicating whether EncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of the AAD. A false value of this field indicates either that EncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set EncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.

bool verified_additional_authenticated_data_crc32c = 6;

Returns
Type Description
EncryptResponse.Builder

This builder for chaining.

clearVerifiedPlaintextCrc32C()

public EncryptResponse.Builder clearVerifiedPlaintextCrc32C()

Integrity verification field. A flag indicating whether EncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the plaintext. A false value of this field indicates either that EncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set EncryptRequest.plaintext_crc32c but this field is still false, discard the response and perform a limited number of retries.

bool verified_plaintext_crc32c = 5;

Returns
Type Description
EncryptResponse.Builder

This builder for chaining.

clone()

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

getCiphertext()

public ByteString getCiphertext()

The encrypted data.

bytes ciphertext = 2;

Returns
Type Description
ByteString

The ciphertext.

getCiphertextCrc32C()

public Int64Value getCiphertextCrc32C()

Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext. An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext 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.

.google.protobuf.Int64Value ciphertext_crc32c = 4;

Returns
Type Description
Int64Value

The ciphertextCrc32c.

getCiphertextCrc32CBuilder()

public Int64Value.Builder getCiphertextCrc32CBuilder()

Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext. An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext 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.

.google.protobuf.Int64Value ciphertext_crc32c = 4;

Returns
Type Description
Builder

getCiphertextCrc32COrBuilder()

public Int64ValueOrBuilder getCiphertextCrc32COrBuilder()

Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext. An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext 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.

.google.protobuf.Int64Value ciphertext_crc32c = 4;

Returns
Type Description
Int64ValueOrBuilder

getDefaultInstanceForType()

public EncryptResponse getDefaultInstanceForType()
Returns
Type Description
EncryptResponse

getDescriptorForType()

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

getName()

public String getName()

The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getProtectionLevel()

public ProtectionLevel getProtectionLevel()

The ProtectionLevel of the CryptoKeyVersion used in encryption.

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

Returns
Type Description
ProtectionLevel

The protectionLevel.

getProtectionLevelValue()

public int getProtectionLevelValue()

The ProtectionLevel of the CryptoKeyVersion used in encryption.

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

Returns
Type Description
int

The enum numeric value on the wire for protectionLevel.

getVerifiedAdditionalAuthenticatedDataCrc32C()

public boolean getVerifiedAdditionalAuthenticatedDataCrc32C()

Integrity verification field. A flag indicating whether EncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of the AAD. A false value of this field indicates either that EncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set EncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.

bool verified_additional_authenticated_data_crc32c = 6;

Returns
Type Description
boolean

The verifiedAdditionalAuthenticatedDataCrc32c.

getVerifiedPlaintextCrc32C()

public boolean getVerifiedPlaintextCrc32C()

Integrity verification field. A flag indicating whether EncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the plaintext. A false value of this field indicates either that EncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set EncryptRequest.plaintext_crc32c but this field is still false, discard the response and perform a limited number of retries.

bool verified_plaintext_crc32c = 5;

Returns
Type Description
boolean

The verifiedPlaintextCrc32c.

hasCiphertextCrc32C()

public boolean hasCiphertextCrc32C()

Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext. An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext 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.

.google.protobuf.Int64Value ciphertext_crc32c = 4;

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 EncryptResponse.Builder mergeCiphertextCrc32C(Int64Value value)

Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext. An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext 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.

.google.protobuf.Int64Value ciphertext_crc32c = 4;

Parameter
Name Description
value Int64Value
Returns
Type Description
EncryptResponse.Builder

mergeFrom(EncryptResponse other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setCiphertext(ByteString value)

public EncryptResponse.Builder setCiphertext(ByteString value)

The encrypted data.

bytes ciphertext = 2;

Parameter
Name Description
value ByteString

The ciphertext to set.
Returns
Type Description
EncryptResponse.Builder

This builder for chaining.

setCiphertextCrc32C(Int64Value value)

public EncryptResponse.Builder setCiphertextCrc32C(Int64Value value)

Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext. An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext 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.

.google.protobuf.Int64Value ciphertext_crc32c = 4;

Parameter
Name Description
value Int64Value
Returns
Type Description
EncryptResponse.Builder

setCiphertextCrc32C(Int64Value.Builder builderForValue)

public EncryptResponse.Builder setCiphertextCrc32C(Int64Value.Builder builderForValue)

Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext. An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext 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.

.google.protobuf.Int64Value ciphertext_crc32c = 4;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
EncryptResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public EncryptResponse.Builder setName(String value)

The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.

string name = 1;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
EncryptResponse.Builder

This builder for chaining.

setNameBytes(ByteString value)

public EncryptResponse.Builder setNameBytes(ByteString value)

The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.

string name = 1;

Parameter
Name Description
value ByteString

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

This builder for chaining.

setProtectionLevel(ProtectionLevel value)

public EncryptResponse.Builder setProtectionLevel(ProtectionLevel value)

The ProtectionLevel of the CryptoKeyVersion used in encryption.

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

Parameter
Name Description
value ProtectionLevel

The protectionLevel to set.
Returns
Type Description
EncryptResponse.Builder

This builder for chaining.

setProtectionLevelValue(int value)

public EncryptResponse.Builder setProtectionLevelValue(int value)

The ProtectionLevel of the CryptoKeyVersion used in encryption.

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

Parameter
Name Description
value int

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

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setVerifiedAdditionalAuthenticatedDataCrc32C(boolean value)

public EncryptResponse.Builder setVerifiedAdditionalAuthenticatedDataCrc32C(boolean value)

Integrity verification field. A flag indicating whether EncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of the AAD. A false value of this field indicates either that EncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set EncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.

bool verified_additional_authenticated_data_crc32c = 6;

Parameter
Name Description
value boolean

The verifiedAdditionalAuthenticatedDataCrc32c to set.
Returns
Type Description
EncryptResponse.Builder

This builder for chaining.

setVerifiedPlaintextCrc32C(boolean value)

public EncryptResponse.Builder setVerifiedPlaintextCrc32C(boolean value)

Integrity verification field. A flag indicating whether EncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the plaintext. A false value of this field indicates either that EncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set EncryptRequest.plaintext_crc32c but this field is still false, discard the response and perform a limited number of retries.

bool verified_plaintext_crc32c = 5;

Parameter
Name Description
value boolean

The verifiedPlaintextCrc32c to set.
Returns
Type Description
EncryptResponse.Builder

This builder for chaining.