Reference documentation and code samples for the Cloud KMS V1 Client class GetPublicKeyRequest.
Request message for KeyManagementService.GetPublicKey.
Generated from protobuf message google.cloud.kms.v1.GetPublicKeyRequest
Namespace
Google \ Cloud \ Kms \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ name | stringRequired. The name of the CryptoKeyVersion public key to get. |
↳ public_key_format | intOptional. The PublicKey format specified by the user. This field is required for PQC algorithms. If specified, the public key will be exported through the public_key field in the requested format. Otherwise, the pem field will be populated for non-PQC algorithms, and an error will be returned for PQC algorithms. |
getName
Required. The name of the CryptoKeyVersion public key to get.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. The name of the CryptoKeyVersion public key to get.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getPublicKeyFormat
Optional. The PublicKey format specified by the user. This field is required for PQC algorithms. If specified, the public key will be exported through the public_key field in the requested format. Otherwise, the pem field will be populated for non-PQC algorithms, and an error will be returned for PQC algorithms.
| Returns | |
|---|---|
| Type | Description |
int | |
setPublicKeyFormat
Optional. The PublicKey format specified by the user. This field is required for PQC algorithms. If specified, the public key will be exported through the public_key field in the requested format. Otherwise, the pem field will be populated for non-PQC algorithms, and an error will be returned for PQC algorithms.
| Parameter | |
|---|---|
| Name | Description |
var | int |
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
name | stringRequired. The name of the CryptoKeyVersion public key to get. Please see KeyManagementServiceClient::cryptoKeyVersionName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
GetPublicKeyRequest | |