Reference documentation and code samples for the Cloud KMS V1 Client class DecryptRequest.
Request message for KeyManagementService.Decrypt.
Generated from protobuf message google.cloud.kms.v1.DecryptRequest
Namespace
Google \ Cloud \ Kms \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ name | stringRequired. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version. |
↳ ciphertext | stringRequired. The encrypted data originally returned in EncryptResponse.ciphertext. |
↳ additional_authenticated_data | stringOptional. Optional data that must match the data originally supplied in EncryptRequest.additional_authenticated_data. |
↳ ciphertext_crc32c | Google\Protobuf\Int64ValueOptional. 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. |
↳ additional_authenticated_data_crc32c | Google\Protobuf\Int64ValueOptional. 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. |
getName
Required. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getCiphertext
Required. The encrypted data originally returned in EncryptResponse.ciphertext.
| Returns | |
|---|---|
| Type | Description |
string | |
setCiphertext
Required. The encrypted data originally returned in EncryptResponse.ciphertext.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getAdditionalAuthenticatedData
Optional. Optional data that must match the data originally supplied in EncryptRequest.additional_authenticated_data.
| Returns | |
|---|---|
| Type | Description |
string | |
setAdditionalAuthenticatedData
Optional. Optional data that must match the data originally supplied in EncryptRequest.additional_authenticated_data.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Int64Value|null | |
hasCiphertextCrc32C
clearCiphertextCrc32C
getCiphertextCrc32CUnwrapped
Returns the unboxed value from 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.
| Returns | |
|---|---|
| Type | Description |
int|string|null | |
setCiphertextCrc32C
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.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Protobuf\Int64Value |
| Returns | |
|---|---|
| Type | Description |
$this | |
setCiphertextCrc32CUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
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.
| Parameter | |
|---|---|
| Name | Description |
var | int|string|null |
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Int64Value|null | |
hasAdditionalAuthenticatedDataCrc32C
clearAdditionalAuthenticatedDataCrc32C
getAdditionalAuthenticatedDataCrc32CUnwrapped
Returns the unboxed value from 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.
| Returns | |
|---|---|
| Type | Description |
int|string|null | |
setAdditionalAuthenticatedDataCrc32C
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.
| Parameter | |
|---|---|
| Name | Description |
var | Google\Protobuf\Int64Value |
| Returns | |
|---|---|
| Type | Description |
$this | |
setAdditionalAuthenticatedDataCrc32CUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
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.
| Parameter | |
|---|---|
| Name | Description |
var | int|string|null |
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameters | |
|---|---|
| Name | Description |
name | stringRequired. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version. Please see KeyManagementServiceClient::cryptoKeyName() for help formatting this field. |
ciphertext | stringRequired. The encrypted data originally returned in EncryptResponse.ciphertext. |
| Returns | |
|---|---|
| Type | Description |
DecryptRequest | |