Class RawDecryptRequest (2.50.0)

public final class RawDecryptRequest extends GeneratedMessageV3 implements RawDecryptRequestOrBuilder

Request message for KeyManagementService.RawDecrypt.

Protobuf type google.cloud.kms.v1.RawDecryptRequest

Static Fields

ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER

public static final int ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER
Field Value
Type Description
int

ADDITIONAL_AUTHENTICATED_DATA_FIELD_NUMBER

public static final int ADDITIONAL_AUTHENTICATED_DATA_FIELD_NUMBER
Field Value
Type Description
int

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

TAG_LENGTH_FIELD_NUMBER

public static final int TAG_LENGTH_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RawDecryptRequest getDefaultInstance()
Returns
Type Description
RawDecryptRequest

getDescriptor()

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

newBuilder()

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

newBuilder(RawDecryptRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAdditionalAuthenticatedData()

public ByteString getAdditionalAuthenticatedData()

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

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

Returns
Type Description
ByteString

The additionalAuthenticatedData.

getAdditionalAuthenticatedDataCrc32C()

public Int64Value getAdditionalAuthenticatedDataCrc32C()

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

Returns
Type Description
Int64Value

The additionalAuthenticatedDataCrc32c.

getAdditionalAuthenticatedDataCrc32COrBuilder()

public Int64ValueOrBuilder getAdditionalAuthenticatedDataCrc32COrBuilder()

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

Returns
Type Description
Int64ValueOrBuilder

getCiphertext()

public ByteString getCiphertext()

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

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

Returns
Type Description
ByteString

The ciphertext.

getCiphertextCrc32C()

public Int64Value getCiphertextCrc32C()

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

Returns
Type Description
Int64Value

The ciphertextCrc32c.

getCiphertextCrc32COrBuilder()

public Int64ValueOrBuilder getCiphertextCrc32COrBuilder()

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

Returns
Type Description
Int64ValueOrBuilder

getDefaultInstanceForType()

public RawDecryptRequest getDefaultInstanceForType()
Returns
Type Description
RawDecryptRequest

getInitializationVector()

public ByteString getInitializationVector()

Required. The initialization vector (IV) used during encryption, which must match the data originally provided in RawEncryptResponse.initialization_vector.

bytes initialization_vector = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The initializationVector.

getInitializationVectorCrc32C()

public Int64Value getInitializationVectorCrc32C()

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

Returns
Type Description
Int64Value

The initializationVectorCrc32c.

getInitializationVectorCrc32COrBuilder()

public Int64ValueOrBuilder getInitializationVectorCrc32COrBuilder()

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

Returns
Type Description
Int64ValueOrBuilder

getName()

public String getName()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

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. If unspecified (0), the default value for the key's algorithm will be used (for AES-GCM, the default value is 16).

int32 tag_length = 5;

Returns
Type Description
int

The tagLength.

hasAdditionalAuthenticatedDataCrc32C()

public boolean hasAdditionalAuthenticatedDataCrc32C()

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

Returns
Type Description
boolean

Whether the additionalAuthenticatedDataCrc32c field is set.

hasCiphertextCrc32C()

public boolean hasCiphertextCrc32C()

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

Returns
Type Description
boolean

Whether the ciphertextCrc32c field is set.

hasInitializationVectorCrc32C()

public boolean hasInitializationVectorCrc32C()

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

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 RawDecryptRequest.Builder newBuilderForType()
Returns
Type Description
RawDecryptRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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