Google Certificate Authority Service V1 Client - Class KeyVersionSpec (1.5.0)

Reference documentation and code samples for the Google Certificate Authority Service V1 Client class KeyVersionSpec.

A Cloud KMS key configuration that a CertificateAuthority will use.

Generated from protobuf message google.cloud.security.privateca.v1.CertificateAuthority.KeyVersionSpec

Namespace

Google \ Cloud \ Security \ PrivateCA \ V1 \ CertificateAuthority

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ cloud_kms_key_version`	`string` The resource name for an existing Cloud KMS CryptoKeyVersion in the format `projects//locations//keyRings//cryptoKeys//cryptoKeyVersions/*`. This option enables full flexibility in the key's capabilities and properties.
`↳ algorithm`	`int` The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their ProtectionLevel as `HSM`.

getCloudKmsKeyVersion

The resource name for an existing Cloud KMS CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.

This option enables full flexibility in the key's capabilities and properties.

Returns
Type	Description
`string`

hasCloudKmsKeyVersion

setCloudKmsKeyVersion

The resource name for an existing Cloud KMS CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.

This option enables full flexibility in the key's capabilities and properties.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAlgorithm

The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their ProtectionLevel as HSM.

Returns
Type	Description
`int`

hasAlgorithm

setAlgorithm

The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience. All managed keys will be have their ProtectionLevel as HSM.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getKeyVersion

Returns
Type	Description
`string`