Google Cloud Key Management Service v1 API - Class MacSignRequest (3.1.0)

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

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

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

Inheritance

Object > MacSignRequest

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Constructors

MacSignRequest()

public MacSignRequest()

MacSignRequest(MacSignRequest)

public MacSignRequest(MacSignRequest other)
Parameter
NameDescription
otherMacSignRequest

Properties

CryptoKeyVersionName

public CryptoKeyVersionName CryptoKeyVersionName { get; set; }

CryptoKeyVersionName-typed view over the Name resource name property.

Property Value
TypeDescription
CryptoKeyVersionName

Data

public ByteString Data { get; set; }

Required. The data to sign. The MAC tag is computed over this data field based on the specific algorithm.

Property Value
TypeDescription
ByteString

DataCrc32C

public long? DataCrc32C { get; set; }

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

Name

public string Name { get; set; }

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

Property Value
TypeDescription
String