Reference documentation and code samples for the Cloud KMS V1 Client class AsymmetricSignRequest.
Request message for KeyManagementService.AsymmetricSign .
Generated from protobuf message google.cloud.kms.v1.AsymmetricSignRequest
Namespace
Google \ Cloud \ Kms \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
↳ digest
Google\Cloud\Kms\V1\Digest
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 . This field may not be supplied if AsymmetricSignRequest.data is supplied.
↳ digest_crc32c
Google\Protobuf\Int64Value
Optional. An optional CRC32C checksum of the AsymmetricSignRequest.digest . If specified, KeyManagementService will verify the integrity of the received AsymmetricSignRequest.digest 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( AsymmetricSignRequest.digest ) is equal to 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.
↳ data
string
Optional. The data to sign. It can't be supplied if AsymmetricSignRequest.digest is supplied.
↳ data_crc32c
Google\Protobuf\Int64Value
Optional. An optional CRC32C checksum of the AsymmetricSignRequest.data . If specified, KeyManagementService will verify the integrity of the received AsymmetricSignRequest.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( AsymmetricSignRequest.data ) is equal to 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.
getName
Required. The resource name of the CryptoKeyVersion to use for signing.
string
setName
Required. The resource name of the CryptoKeyVersion to use for signing.
var
string
$this
getDigest
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 .
This field may not be supplied if AsymmetricSignRequest.data is supplied.
hasDigest
clearDigest
setDigest
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 .
This field may not be supplied if AsymmetricSignRequest.data is supplied.
$this
getDigestCrc32C
Optional. An optional CRC32C checksum of the AsymmetricSignRequest.digest .
If specified, KeyManagementService will verify the integrity of the received AsymmetricSignRequest.digest 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( AsymmetricSignRequest.digest ) is equal to 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.
hasDigestCrc32C
clearDigestCrc32C
getDigestCrc32CValue
Returns the unboxed value from getDigestCrc32C()
Optional. An optional CRC32C checksum of the AsymmetricSignRequest.digest . If specified, KeyManagementService will verify the integrity of the received AsymmetricSignRequest.digest 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( AsymmetricSignRequest.digest ) is equal to 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.
int|string|null
setDigestCrc32C
Optional. An optional CRC32C checksum of the AsymmetricSignRequest.digest .
If specified, KeyManagementService will verify the integrity of the received AsymmetricSignRequest.digest 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( AsymmetricSignRequest.digest ) is equal to 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.
$this
setDigestCrc32CValue
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
Optional. An optional CRC32C checksum of the AsymmetricSignRequest.digest . If specified, KeyManagementService will verify the integrity of the received AsymmetricSignRequest.digest 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( AsymmetricSignRequest.digest ) is equal to 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.
var
int|string|null
$this
getData
Optional. The data to sign.
It can't be supplied if AsymmetricSignRequest.digest is supplied.
string
setData
Optional. The data to sign.
It can't be supplied if AsymmetricSignRequest.digest is supplied.
var
string
$this
getDataCrc32C
Optional. An optional CRC32C checksum of the AsymmetricSignRequest.data .
If specified, KeyManagementService will verify the integrity of the received AsymmetricSignRequest.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( AsymmetricSignRequest.data ) is equal to 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.
hasDataCrc32C
clearDataCrc32C
getDataCrc32CValue
Returns the unboxed value from getDataCrc32C()
Optional. An optional CRC32C checksum of the AsymmetricSignRequest.data . If specified, KeyManagementService will verify the integrity of the received AsymmetricSignRequest.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( AsymmetricSignRequest.data ) is equal to 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.
int|string|null
setDataCrc32C
Optional. An optional CRC32C checksum of the AsymmetricSignRequest.data .
If specified, KeyManagementService will verify the integrity of the received AsymmetricSignRequest.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( AsymmetricSignRequest.data ) is equal to 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.
$this
setDataCrc32CValue
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
Optional. An optional CRC32C checksum of the AsymmetricSignRequest.data . If specified, KeyManagementService will verify the integrity of the received AsymmetricSignRequest.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( AsymmetricSignRequest.data ) is equal to 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.
var
int|string|null
$this
static::build
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.
digest
Google\Cloud\Kms\V1\Digest
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 .
This field may not be supplied if AsymmetricSignRequest.data is supplied.
