Google Cloud Key Management Service v1 API - Class EncryptResponse (3.10.0)

public sealed class EncryptResponse : IMessage<EncryptResponse>, IEquatable<EncryptResponse>, IDeepCloneable<EncryptResponse>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Key Management Service v1 API class EncryptResponse.

Response message for [KeyManagementService.Encrypt][google.cloud.kms.v1.KeyManagementService.Encrypt].

Inheritance

object > EncryptResponse

Implements

IMessage EncryptResponse, IEquatable EncryptResponse, IDeepCloneable EncryptResponse, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Constructors

EncryptResponse()

public EncryptResponse()

EncryptResponse(EncryptResponse)

public EncryptResponse(EncryptResponse other)

Parameter
Name	Description
`other`	`EncryptResponse`

Properties

Ciphertext

public ByteString Ciphertext { get; set; }

The encrypted data.

Property Value
Type	Description
`ByteString`

CiphertextCrc32C

public long? CiphertextCrc32C { get; set; }

Integrity verification field. A CRC32C checksum of the returned [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext]. An integrity check of [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext] can be performed by computing the CRC32C checksum of [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.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.

Property Value
Type	Description
`long`

Name

public string Name { get; set; }

The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in encryption. Check this field to verify that the intended resource was used for encryption.

Property Value
Type	Description
`string`

ProtectionLevel

public ProtectionLevel ProtectionLevel { get; set; }

The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in encryption.

Property Value
Type	Description
`ProtectionLevel`

VerifiedAdditionalAuthenticatedDataCrc32C

public bool VerifiedAdditionalAuthenticatedDataCrc32C { get; set; }

Integrity verification field. A flag indicating whether [EncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data_crc32c] was received by [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used for the integrity verification of the [AAD][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data]. A false value of this field indicates either that [EncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data_crc32c] was left unset or that it was not delivered to [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've set [EncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data_crc32c] but this field is still false, discard the response and perform a limited number of retries.

Property Value
Type	Description
`bool`

VerifiedPlaintextCrc32C

public bool VerifiedPlaintextCrc32C { get; set; }

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

Property Value
Type	Description
`bool`