Class RawEncryptResponse (2.52.0)

public final class RawEncryptResponse extends GeneratedMessageV3 implements RawEncryptResponseOrBuilder

Response message for KeyManagementService.RawEncrypt.

Protobuf type google.cloud.kms.v1.RawEncryptResponse

Static Fields

CIPHERTEXT_CRC32C_FIELD_NUMBER

public static final int CIPHERTEXT_CRC32C_FIELD_NUMBER
Field Value
Type Description
int

CIPHERTEXT_FIELD_NUMBER

public static final int CIPHERTEXT_FIELD_NUMBER
Field Value
Type Description
int

INITIALIZATION_VECTOR_CRC32C_FIELD_NUMBER

public static final int INITIALIZATION_VECTOR_CRC32C_FIELD_NUMBER
Field Value
Type Description
int

INITIALIZATION_VECTOR_FIELD_NUMBER

public static final int INITIALIZATION_VECTOR_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PROTECTION_LEVEL_FIELD_NUMBER

public static final int PROTECTION_LEVEL_FIELD_NUMBER
Field Value
Type Description
int

TAG_LENGTH_FIELD_NUMBER

public static final int TAG_LENGTH_FIELD_NUMBER
Field Value
Type Description
int

VERIFIED_ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER

public static final int VERIFIED_ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER
Field Value
Type Description
int

VERIFIED_INITIALIZATION_VECTOR_CRC32C_FIELD_NUMBER

public static final int VERIFIED_INITIALIZATION_VECTOR_CRC32C_FIELD_NUMBER
Field Value
Type Description
int

VERIFIED_PLAINTEXT_CRC32C_FIELD_NUMBER

public static final int VERIFIED_PLAINTEXT_CRC32C_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RawEncryptResponse getDefaultInstance()
Returns
Type Description
RawEncryptResponse

getDescriptor()

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

newBuilder()

public static RawEncryptResponse.Builder newBuilder()
Returns
Type Description
RawEncryptResponse.Builder

newBuilder(RawEncryptResponse prototype)

public static RawEncryptResponse.Builder newBuilder(RawEncryptResponse prototype)
Parameter
Name Description
prototype RawEncryptResponse
Returns
Type Description
RawEncryptResponse.Builder

parseDelimitedFrom(InputStream input)

public static RawEncryptResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RawEncryptResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RawEncryptResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RawEncryptResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RawEncryptResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RawEncryptResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RawEncryptResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RawEncryptResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RawEncryptResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RawEncryptResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RawEncryptResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RawEncryptResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RawEncryptResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RawEncryptResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RawEncryptResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RawEncryptResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RawEncryptResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RawEncryptResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RawEncryptResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RawEncryptResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RawEncryptResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RawEncryptResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RawEncryptResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RawEncryptResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RawEncryptResponse> parser()
Returns
Type Description
Parser<RawEncryptResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCiphertext()

public ByteString getCiphertext()

The encrypted data. In the case of AES-GCM, the authentication tag is the tag_length bytes at the end of this field.

bytes ciphertext = 1;

Returns
Type Description
ByteString

The ciphertext.

getCiphertextCrc32C()

public Int64Value getCiphertextCrc32C()

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

getCiphertextCrc32COrBuilder()

public Int64ValueOrBuilder getCiphertextCrc32COrBuilder()

Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.ciphertext. An integrity check of ciphertext can be performed by computing the CRC32C checksum of 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 RawEncryptResponse getDefaultInstanceForType()
Returns
Type Description
RawEncryptResponse

getInitializationVector()

public ByteString getInitializationVector()

The initialization vector (IV) generated by the service during encryption. This value must be stored and provided in RawDecryptRequest.initialization_vector at decryption time.

bytes initialization_vector = 2;

Returns
Type Description
ByteString

The initializationVector.

getInitializationVectorCrc32C()

public Int64Value getInitializationVectorCrc32C()

Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.initialization_vector. An integrity check of initialization_vector can be performed by computing the CRC32C checksum of initialization_vector 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 initialization_vector_crc32c = 5;

Returns
Type Description
Int64Value

The initializationVectorCrc32c.

getInitializationVectorCrc32COrBuilder()

public Int64ValueOrBuilder getInitializationVectorCrc32COrBuilder()

Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.initialization_vector. An integrity check of initialization_vector can be performed by computing the CRC32C checksum of initialization_vector 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 initialization_vector_crc32c = 5;

Returns
Type Description
Int64ValueOrBuilder

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 = 8;

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 = 8;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<RawEncryptResponse> getParserForType()
Returns
Type Description
Parser<RawEncryptResponse>
Overrides

getProtectionLevel()

public ProtectionLevel getProtectionLevel()

The ProtectionLevel of the CryptoKeyVersion used in encryption.

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

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 = 9;

Returns
Type Description
int

The enum numeric value on the wire for protectionLevel.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTagLength()

public int getTagLength()

The length of the authentication tag that is appended to the end of the ciphertext.

int32 tag_length = 3;

Returns
Type Description
int

The tagLength.

getVerifiedAdditionalAuthenticatedDataCrc32C()

public boolean getVerifiedAdditionalAuthenticatedDataCrc32C()

Integrity verification field. A flag indicating whether RawEncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of additional_authenticated_data. A false value of this field indicates either that // RawEncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.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 = 7;

Returns
Type Description
boolean

The verifiedAdditionalAuthenticatedDataCrc32c.

getVerifiedInitializationVectorCrc32C()

public boolean getVerifiedInitializationVectorCrc32C()

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

bool verified_initialization_vector_crc32c = 10;

Returns
Type Description
boolean

The verifiedInitializationVectorCrc32c.

getVerifiedPlaintextCrc32C()

public boolean getVerifiedPlaintextCrc32C()

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

bool verified_plaintext_crc32c = 6;

Returns
Type Description
boolean

The verifiedPlaintextCrc32c.

hasCiphertextCrc32C()

public boolean hasCiphertextCrc32C()

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

hasInitializationVectorCrc32C()

public boolean hasInitializationVectorCrc32C()

Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.initialization_vector. An integrity check of initialization_vector can be performed by computing the CRC32C checksum of initialization_vector 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 initialization_vector_crc32c = 5;

Returns
Type Description
boolean

Whether the initializationVectorCrc32c field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RawEncryptResponse.Builder newBuilderForType()
Returns
Type Description
RawEncryptResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RawEncryptResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RawEncryptResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RawEncryptResponse.Builder toBuilder()
Returns
Type Description
RawEncryptResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException