Cloud KMS V1 Client - Class EkmConnection (2.11.0)

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

An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC, as well as performing cryptographic operations using keys created within the EkmConnection.

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

Namespace

Google \ Cloud \ Kms \ V1

Methods

__construct

Constructor.

Parameter
Name Description
data mixed

getName

Output only. The resource name for the EkmConnection in the format projects/*/locations/*/ekmConnections/*.

Returns
Type Description
string

setName

Output only. The resource name for the EkmConnection in the format projects/*/locations/*/ekmConnections/*.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The time at which the EkmConnection was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time at which the EkmConnection was created.

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

getServiceResolvers

Optional. A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

Returns
Type Description
Google\Protobuf\RepeatedField<EkmConnection\ServiceResolver>

setServiceResolvers

Optional. A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported.

Parameter
Name Description
var array<EkmConnection\ServiceResolver>
Returns
Type Description
$this

getEtag

Optional. Etag of the currently stored EkmConnection.

Returns
Type Description
string

setEtag

Optional. Etag of the currently stored EkmConnection.

Parameter
Name Description
var string
Returns
Type Description
$this

getKeyManagementMode

Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.

Returns
Type Description
int Enum of type KeyManagementMode.

setKeyManagementMode

Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.

Parameter
Name Description
var int

Enum of type KeyManagementMode.

Returns
Type Description
$this

getCryptoSpacePath

Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.

Returns
Type Description
string

setCryptoSpacePath

Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS.

Parameter
Name Description
var string
Returns
Type Description
$this