3.27.0 (latest) 3.26.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0

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

Reference 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\].

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> DecapsulateRequest

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[DecapsulateRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.DecapsulateRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[DecapsulateRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.DecapsulateRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[DecapsulateRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.DecapsulateRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.Kms.V1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1)

## Assembly

Google.Cloud.Kms.V1.dll

## Constructors

### DecapsulateRequest()

    public DecapsulateRequest()

### DecapsulateRequest(DecapsulateRequest)

    public DecapsulateRequest(DecapsulateRequest other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.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** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.ByteString.html` |   |

### 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** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### CryptoKeyVersionName

    public CryptoKeyVersionName CryptoKeyVersionName { get; set; }

[CryptoKeyVersionName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.CryptoKeyVersionName)-typed view over the [Name](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.DecapsulateRequest#Google_Cloud_Kms_V1_DecapsulateRequest_Name) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.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** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |