Cloud KMS V1 Client - Class MacSignRequest (1.22.1)

Reference documentation and code samples for the Cloud KMS V1 Client class MacSignRequest.

Request message for KeyManagementService.MacSign.

Generated from protobuf message google.cloud.kms.v1.MacSignRequest

Namespace

Google \ Cloud \ Kms \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The resource name of the CryptoKeyVersion to use for signing.
↳ data string

Required. The data to sign. The MAC tag is computed over this data field based on the specific algorithm.
↳ data_crc32c Google\Protobuf\Int64Value

Optional. An optional CRC32C checksum of the MacSignRequest.data. If specified, KeyManagementService will verify the integrity of the received MacSignRequest.data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(MacSignRequest.data) is equal to 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.

getName

Required. The resource name of the CryptoKeyVersion to use for signing.

Returns
Type Description
string

setName

Required. The resource name of the CryptoKeyVersion to use for signing.

Parameter
Name Description
var string
Returns
Type Description
$this

getData

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

Returns
Type Description
string

setData

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

Parameter
Name Description
var string
Returns
Type Description
$this

getDataCrc32C

Optional. An optional CRC32C checksum of the MacSignRequest.data. If specified, KeyManagementService will verify the integrity of the received MacSignRequest.data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(MacSignRequest.data) is equal to 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.

Returns
Type Description
Google\Protobuf\Int64Value|null

hasDataCrc32C

clearDataCrc32C

getDataCrc32CValue

Returns the unboxed value from getDataCrc32C()

Optional. An optional CRC32C checksum of the MacSignRequest.data. If specified, KeyManagementService will verify the integrity of the received MacSignRequest.data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(MacSignRequest.data) is equal to 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.

Returns
Type Description
int|string|null

setDataCrc32C

Optional. An optional CRC32C checksum of the MacSignRequest.data. If specified, KeyManagementService will verify the integrity of the received MacSignRequest.data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(MacSignRequest.data) is equal to 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.

Parameter
Name Description
var Google\Protobuf\Int64Value
Returns
Type Description
$this

setDataCrc32CValue

Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.

Optional. An optional CRC32C checksum of the MacSignRequest.data. If specified, KeyManagementService will verify the integrity of the received MacSignRequest.data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(MacSignRequest.data) is equal to 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.

Parameter
Name Description
var int|string|null
Returns
Type Description
$this

static::build

Parameters
Name Description
name string

Required. The resource name of the CryptoKeyVersion to use for signing. Please see Google\Cloud\Kms\V1\KeyManagementServiceClient::cryptoKeyVersionName() for help formatting this field.
data string

Required. The data to sign. The MAC tag is computed over this data field based on the specific algorithm.
Returns
Type Description
Google\Cloud\Kms\V1\MacSignRequest