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 RawEncryptRequest : IMessage<RawEncryptRequest>, IEquatable<RawEncryptRequest>, IDeepCloneable<RawEncryptRequest>, IBufferMessage, IMessage

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

Request message for
\[KeyManagementService.RawEncrypt\]\[google.cloud.kms.v1.KeyManagementService.RawEncrypt\].

## Inheritance

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

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[RawEncryptRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.RawEncryptRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[RawEncryptRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.RawEncryptRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[RawEncryptRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.RawEncryptRequest), [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

### RawEncryptRequest()

    public RawEncryptRequest()

### RawEncryptRequest(RawEncryptRequest)

    public RawEncryptRequest(RawEncryptRequest other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.RawEncryptRequest` |

## Properties

### AdditionalAuthenticatedData

    public ByteString AdditionalAuthenticatedData { get; set; }

Optional. Optional data that, if specified, must also be provided during
decryption through
\[RawDecryptRequest.additional_authenticated_data\]\[google.cloud.kms.v1.RawDecryptRequest.additional_authenticated_data\].

This field may only be used in conjunction with an
\[algorithm\]\[google.cloud.kms.v1.CryptoKeyVersion.algorithm\] that accepts
additional authenticated data (for example, AES-GCM).

The maximum size depends on the key version's
\[protection_level\]\[google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level\].
For \[SOFTWARE\]\[google.cloud.kms.v1.ProtectionLevel.SOFTWARE\] keys, the
plaintext must be no larger than 64KiB. For
\[HSM\]\[google.cloud.kms.v1.ProtectionLevel.HSM\] keys, the combined length of
the plaintext and additional_authenticated_data fields must be no larger
than 8KiB.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.ByteString.html` |   |

### AdditionalAuthenticatedDataCrc32C

    public long? AdditionalAuthenticatedDataCrc32C { get; set; }

Optional. An optional CRC32C checksum of the
\[RawEncryptRequest.additional_authenticated_data\]\[google.cloud.kms.v1.RawEncryptRequest.additional_authenticated_data\].
If specified,
\[KeyManagementService\]\[google.cloud.kms.v1.KeyManagementService\] will
verify the integrity of the received 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(additional_authenticated_data) is equal to
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** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### InitializationVector

    public ByteString InitializationVector { get; set; }

Optional. A customer-supplied initialization vector that will be used for
encryption. If it is not provided for AES-CBC and AES-CTR, one will be
generated. It will be returned in
\[RawEncryptResponse.initialization_vector\]\[google.cloud.kms.v1.RawEncryptResponse.initialization_vector\].

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.ByteString.html` |   |

### InitializationVectorCrc32C

    public long? InitializationVectorCrc32C { get; set; }

Optional. An optional CRC32C checksum of the
\[RawEncryptRequest.initialization_vector\]\[google.cloud.kms.v1.RawEncryptRequest.initialization_vector\].
If specified,
\[KeyManagementService\]\[google.cloud.kms.v1.KeyManagementService\] will
verify the integrity of the received initialization_vector 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(initialization_vector) is equal to
initialization_vector_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` |   |

### Name

    public string Name { get; set; }

Required. The resource name of the
\[CryptoKeyVersion\]\[google.cloud.kms.v1.CryptoKeyVersion\] to use for
encryption.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Plaintext

    public ByteString Plaintext { get; set; }

Required. The data to encrypt. Must be no larger than 64KiB.

The maximum size depends on the key version's
\[protection_level\]\[google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level\].
For \[SOFTWARE\]\[google.cloud.kms.v1.ProtectionLevel.SOFTWARE\] keys, the
plaintext must be no larger than 64KiB. For
\[HSM\]\[google.cloud.kms.v1.ProtectionLevel.HSM\] keys, the combined length of
the plaintext and additional_authenticated_data fields must be no larger
than 8KiB.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.ByteString.html` |   |

### PlaintextCrc32C

    public long? PlaintextCrc32C { get; set; }

Optional. An optional CRC32C checksum of the
\[RawEncryptRequest.plaintext\]\[google.cloud.kms.v1.RawEncryptRequest.plaintext\].
If specified,
\[KeyManagementService\]\[google.cloud.kms.v1.KeyManagementService\] will
verify the integrity of the received plaintext 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(plaintext) is equal
to plaintext_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` |   |