Cloud KMS V1 Client - Class AsymmetricSignRequest (2.0.0)

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 \ 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.
↳ 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.

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

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.

Returns
Type Description
Google\Cloud\Kms\V1\Digest|null

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.

Parameter
Name Description
var Google\Cloud\Kms\V1\Digest
Returns
Type Description
$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.

Returns
Type Description
Google\Protobuf\Int64Value|null

hasDigestCrc32C

clearDigestCrc32C

getDigestCrc32CUnwrapped

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.

Returns
Type Description
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.

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

setDigestCrc32CUnwrapped

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.

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

getData

Optional. The data to sign.

It can't be supplied if AsymmetricSignRequest.digest is supplied.

Returns
Type Description
string

setData

Optional. The data to sign.

It can't be supplied if AsymmetricSignRequest.digest is supplied.

Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
Google\Protobuf\Int64Value|null

hasDataCrc32C

clearDataCrc32C

getDataCrc32CUnwrapped

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.

Returns
Type Description
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.

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

setDataCrc32CUnwrapped

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.

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.
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.
Returns
Type Description
Google\Cloud\Kms\V1\AsymmetricSignRequest