Cloud KMS V1 Client - Class MacSignResponse (1.17.0)

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

Response message for KeyManagementService.MacSign.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

The resource name of the CryptoKeyVersion used for signing. Check this field to verify that the intended resource was used for signing.

↳ mac string

The created signature.

↳ mac_crc32c Google\Protobuf\Int64Value

Integrity verification field. A CRC32C checksum of the returned MacSignResponse.mac. An integrity check of MacSignResponse.mac can be performed by computing the CRC32C checksum of MacSignResponse.mac and comparing your results to this field. Discard the response in case of non-matching checksum values, and 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.

↳ verified_data_crc32c bool

Integrity verification field. A flag indicating whether MacSignRequest.data_crc32c was received by KeyManagementService and used for the integrity verification of the data. A false value of this field indicates either that MacSignRequest.data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set MacSignRequest.data_crc32c but this field is still false, discard the response and perform a limited number of retries.

↳ protection_level int

The ProtectionLevel of the CryptoKeyVersion used for signing.

getName

The resource name of the CryptoKeyVersion used for signing.

Check this field to verify that the intended resource was used for signing.

Returns
TypeDescription
string

setName

The resource name of the CryptoKeyVersion used for signing.

Check this field to verify that the intended resource was used for signing.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMac

The created signature.

Returns
TypeDescription
string

setMac

The created signature.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMacCrc32C

Integrity verification field. A CRC32C checksum of the returned MacSignResponse.mac. An integrity check of MacSignResponse.mac can be performed by computing the CRC32C checksum of MacSignResponse.mac and comparing your results to this field. Discard the response in case of non-matching checksum values, and 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
TypeDescription
Google\Protobuf\Int64Value|null

hasMacCrc32C

clearMacCrc32C

getMacCrc32CValue

Returns the unboxed value from getMacCrc32C()

Integrity verification field. A CRC32C checksum of the returned MacSignResponse.mac. An integrity check of MacSignResponse.mac can be performed by computing the CRC32C checksum of MacSignResponse.mac and comparing your results to this field. Discard the response in case of non-matching checksum values, and 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
TypeDescription
int|string|null

setMacCrc32C

Integrity verification field. A CRC32C checksum of the returned MacSignResponse.mac. An integrity check of MacSignResponse.mac can be performed by computing the CRC32C checksum of MacSignResponse.mac and comparing your results to this field. Discard the response in case of non-matching checksum values, and 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
NameDescription
var Google\Protobuf\Int64Value
Returns
TypeDescription
$this

setMacCrc32CValue

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

Integrity verification field. A CRC32C checksum of the returned MacSignResponse.mac. An integrity check of MacSignResponse.mac can be performed by computing the CRC32C checksum of MacSignResponse.mac and comparing your results to this field. Discard the response in case of non-matching checksum values, and 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
NameDescription
var int|string|null
Returns
TypeDescription
$this

getVerifiedDataCrc32C

Integrity verification field. A flag indicating whether MacSignRequest.data_crc32c was received by KeyManagementService and used for the integrity verification of the data. A false value of this field indicates either that MacSignRequest.data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set MacSignRequest.data_crc32c but this field is still false, discard the response and perform a limited number of retries.

Returns
TypeDescription
bool

setVerifiedDataCrc32C

Integrity verification field. A flag indicating whether MacSignRequest.data_crc32c was received by KeyManagementService and used for the integrity verification of the data. A false value of this field indicates either that MacSignRequest.data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set MacSignRequest.data_crc32c but this field is still false, discard the response and perform a limited number of retries.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getProtectionLevel

The ProtectionLevel of the CryptoKeyVersion used for signing.

Returns
TypeDescription
int

setProtectionLevel

The ProtectionLevel of the CryptoKeyVersion used for signing.

Parameter
NameDescription
var int
Returns
TypeDescription
$this