Google Cloud Key Management Service v1 API - Class AsymmetricSignRequest (3.9.0)

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

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

Request message for [KeyManagementService.AsymmetricSign][google.cloud.kms.v1.KeyManagementService.AsymmetricSign].

Inheritance

object > AsymmetricSignRequest

Implements

IMessage AsymmetricSignRequest, IEquatable AsymmetricSignRequest, IDeepCloneable AsymmetricSignRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Constructors

AsymmetricSignRequest()

public AsymmetricSignRequest()

AsymmetricSignRequest(AsymmetricSignRequest)

public AsymmetricSignRequest(AsymmetricSignRequest other)

Parameter
Name	Description
`other`	`AsymmetricSignRequest`

Properties

CryptoKeyVersionName

public CryptoKeyVersionName CryptoKeyVersionName { get; set; }

CryptoKeyVersionName-typed view over the Name resource name property.

Property Value
Type	Description
`CryptoKeyVersionName`

Data

public ByteString Data { get; set; }

Optional. The data to sign. It can't be supplied if [AsymmetricSignRequest.digest][google.cloud.kms.v1.AsymmetricSignRequest.digest] is supplied.

Property Value
Type	Description
`ByteString`

DataCrc32C

public long? DataCrc32C { get; set; }

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

Digest

public Digest Digest { get; set; }

Optional. The digest of the data to sign. The digest must be produced with the same digest algorithm as specified by the key version's [algorithm][google.cloud.kms.v1.CryptoKeyVersion.algorithm].

This field may not be supplied if [AsymmetricSignRequest.data][google.cloud.kms.v1.AsymmetricSignRequest.data] is supplied.

Property Value
Type	Description
`Digest`

DigestCrc32C

public long? DigestCrc32C { get; set; }

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

Name

public string Name { get; set; }

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

Property Value
Type	Description
`string`