public sealed class DecapsulateRequest : IMessage<DecapsulateRequest>, IEquatable<DecapsulateRequest>, IDeepCloneable<DecapsulateRequest>, IBufferMessage, IMessageReference documentation and code samples for the Google Cloud Key Management Service v1 API class DecapsulateRequest.
Request message for [KeyManagementService.Decapsulate][google.cloud.kms.v1.KeyManagementService.Decapsulate].
Implements
IMessageDecapsulateRequest, IEquatableDecapsulateRequest, IDeepCloneableDecapsulateRequest, IBufferMessage, IMessageNamespace
Google.Cloud.Kms.V1Assembly
Google.Cloud.Kms.V1.dll
Constructors
DecapsulateRequest()
public DecapsulateRequest()DecapsulateRequest(DecapsulateRequest)
public DecapsulateRequest(DecapsulateRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
DecapsulateRequest |
Properties
Ciphertext
public ByteString Ciphertext { get; set; }Required. The ciphertext produced from encapsulation with the named [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] public key(s).
| Property Value | |
|---|---|
| Type | Description |
ByteString |
|
CiphertextCrc32C
public long? CiphertextCrc32C { get; set; }Optional. A CRC32C checksum of the [DecapsulateRequest.ciphertext][google.cloud.kms.v1.DecapsulateRequest.ciphertext]. If specified, [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will verify the integrity of the received [DecapsulateRequest.ciphertext][google.cloud.kms.v1.DecapsulateRequest.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([DecapsulateRequest.ciphertext][google.cloud.kms.v1.DecapsulateRequest.ciphertext]) is equal to [DecapsulateRequest.ciphertext_crc32c][google.cloud.kms.v1.DecapsulateRequest.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 |
long |
|
CryptoKeyVersionName
public CryptoKeyVersionName CryptoKeyVersionName { get; set; }CryptoKeyVersionName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
CryptoKeyVersionName |
|
Name
public string Name { get; set; }Required. The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for decapsulation.
| Property Value | |
|---|---|
| Type | Description |
string |
|