Cloud KMS V1 Client - Class GetImportJobRequest (2.11.0)

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

Request message for KeyManagementService.GetImportJob.

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

Namespace

Google \ Cloud \ Kms \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The name of the ImportJob to get.
↳ public_key_format int

Optional. Specifies the WrappingPublicKey format. If not specified: * * For RSA-based import methods, the wrapping key will be returned in PEM format * * For pure ML-KEM-based import methods, the wrapping key will be returned in the raw bytes format specified in FIPS-203 * * For X-Wing-based import methods, the wrapping key will be returned in the raw bytes format specified in https://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem.

getName

Required. The name of the ImportJob to get.

Returns
Type Description
string

setName

Required. The name of the ImportJob to get.

Parameter
Name Description
var string
Returns
Type Description
$this

getPublicKeyFormat

Optional. Specifies the WrappingPublicKey format.

If not specified:

  • For RSA-based import methods, the wrapping key will be returned in PEM format
  • For pure ML-KEM-based import methods, the wrapping key will be returned in the raw bytes format specified in FIPS-203
  • For X-Wing-based import methods, the wrapping key will be returned in the raw bytes format specified in https://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem.
Returns
Type Description
int Enum of type PublicKeyFormat.

setPublicKeyFormat

Optional. Specifies the WrappingPublicKey format.

If not specified:

  • For RSA-based import methods, the wrapping key will be returned in PEM format
  • For pure ML-KEM-based import methods, the wrapping key will be returned in the raw bytes format specified in FIPS-203
  • For X-Wing-based import methods, the wrapping key will be returned in the raw bytes format specified in https://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem.
Parameter
Name Description
var int

Enum of type PublicKeyFormat.

Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the ImportJob to get. Please see KeyManagementServiceClient::importJobName() for help formatting this field.
Returns
Type Description
GetImportJobRequest