public final class DecryptRequest extends GeneratedMessageV3 implements DecryptRequestOrBuilder
Request message for KeyManagementService.Decrypt.
Protobuf type google.cloud.kms.v1.DecryptRequest
Fields
ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER
public static final int ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER
Field Value
ADDITIONAL_AUTHENTICATED_DATA_FIELD_NUMBER
public static final int ADDITIONAL_AUTHENTICATED_DATA_FIELD_NUMBER
Field Value
CIPHERTEXT_CRC32C_FIELD_NUMBER
public static final int CIPHERTEXT_CRC32C_FIELD_NUMBER
Field Value
CIPHERTEXT_FIELD_NUMBER
public static final int CIPHERTEXT_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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];
| Type | Description |
| ByteString | The additionalAuthenticatedData.
|
getAdditionalAuthenticatedDataCrc32C()
public Int64Value getAdditionalAuthenticatedDataCrc32C()
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];
| Type | Description |
| Int64Value | The additionalAuthenticatedDataCrc32c.
|
getAdditionalAuthenticatedDataCrc32COrBuilder()
public Int64ValueOrBuilder getAdditionalAuthenticatedDataCrc32COrBuilder()
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];
getCiphertext()
public ByteString getCiphertext()
Required. The encrypted data originally returned in
EncryptResponse.ciphertext.
bytes ciphertext = 2 [(.google.api.field_behavior) = REQUIRED];
getCiphertextCrc32C()
public Int64Value getCiphertextCrc32C()
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];
getCiphertextCrc32COrBuilder()
public Int64ValueOrBuilder getCiphertextCrc32COrBuilder()
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];
getDefaultInstance()
public static DecryptRequest getDefaultInstance()
Returns
getDefaultInstanceForType()
public DecryptRequest getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
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) = { ... }
| 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) = { ... }
getParserForType()
public Parser<DecryptRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasAdditionalAuthenticatedDataCrc32C()
public boolean hasAdditionalAuthenticatedDataCrc32C()
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];
| Type | Description |
| boolean | Whether the additionalAuthenticatedDataCrc32c field is set.
|
hasCiphertextCrc32C()
public boolean hasCiphertextCrc32C()
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];
| Type | Description |
| boolean | Whether the ciphertextCrc32c field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static DecryptRequest.Builder newBuilder()
Returns
newBuilder(DecryptRequest prototype)
public static DecryptRequest.Builder newBuilder(DecryptRequest prototype)
Parameter
Returns
newBuilderForType()
public DecryptRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DecryptRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static DecryptRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static DecryptRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static DecryptRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DecryptRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static DecryptRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DecryptRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DecryptRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static DecryptRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DecryptRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static DecryptRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static DecryptRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DecryptRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<DecryptRequest> parser()
Returns
toBuilder()
public DecryptRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
