public sealed class DecryptRequest : IMessage<DecryptRequest>, IEquatable<DecryptRequest>, IDeepCloneable<DecryptRequest>, IBufferMessage, IMessageReference documentation and code samples for the Google Cloud Key Management Service v1 API class DecryptRequest.
Request message for [KeyManagementService.Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt].
Implements
IMessageDecryptRequest, IEquatableDecryptRequest, IDeepCloneableDecryptRequest, IBufferMessage, IMessageNamespace
Google.Cloud.Kms.V1Assembly
Google.Cloud.Kms.V1.dll
Constructors
DecryptRequest()
public DecryptRequest()DecryptRequest(DecryptRequest)
public DecryptRequest(DecryptRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
DecryptRequest |
Properties
AdditionalAuthenticatedData
public ByteString AdditionalAuthenticatedData { get; set; }Optional. Optional data that must match the data originally supplied in [EncryptRequest.additional_authenticated_data][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data].
| Property Value | |
|---|---|
| Type | Description |
ByteString |
|
AdditionalAuthenticatedDataCrc32C
public long? AdditionalAuthenticatedDataCrc32C { get; set; }Optional. An optional CRC32C checksum of the [DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data]. If specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will verify the integrity of the received [DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data] using this checksum. [KeyManagementService][google.cloud.kms.v1.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][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data]) is equal to [DecryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.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.
| Property Value | |
|---|---|
| Type | Description |
System.Int64 |
|
Ciphertext
public ByteString Ciphertext { get; set; }Required. The encrypted data originally returned in [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext].
| Property Value | |
|---|---|
| Type | Description |
ByteString |
|
CiphertextCrc32C
public long? CiphertextCrc32C { get; set; }Optional. An optional CRC32C checksum of the [DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.ciphertext]. If specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will verify the integrity of the received [DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.ciphertext] using this checksum. [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C([DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.ciphertext]) is equal to [DecryptRequest.ciphertext_crc32c][google.cloud.kms.v1.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.
| Property Value | |
|---|---|
| Type | Description |
System.Int64 |
|
CryptoKeyName
public CryptoKeyName CryptoKeyName { get; set; }CryptoKeyName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
CryptoKeyName |
|
Name
public string Name { get; set; }Required. The resource name of the [CryptoKey][google.cloud.kms.v1.CryptoKey] to use for decryption. The server will choose the appropriate version.
| Property Value | |
|---|---|
| Type | Description |
string |
|