# Cloud KMS V1 Client - Class EkmConnection (2.9.0)

2.9.0 (latest) 2.8.0 2.7.0 2.6.0 2.5.2 2.4.0 2.3.1 2.2.0 2.1.6 2.0.0 1.23.0 1.22.1 1.21.4 1.20.3 1.19.0 1.18.1 1.17.0 1.16.4 1.15.3 Reference documentation and code samples for the Cloud KMS V1 Client class EkmConnection.

An [EkmConnection](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection) represents an
individual EKM connection. It can be used for creating
[CryptoKeys](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKey) and
[CryptoKeyVersions](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersion) with a
[ProtectionLevel](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel) of
[EXTERNAL_VPC](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel#_Google_Cloud_Kms_V1_ProtectionLevel__EXTERNAL_VPC), as well as
performing cryptographic operations using keys created within the
[EkmConnection](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.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](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection) in the format
`projects/*/locations/*/ekmConnections/*`.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setName

Output only. The resource name for the
[EkmConnection](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.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](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection) was created.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasCreateTime

### clearCreateTime

### setCreateTime

Output only. The time at which the
[EkmConnection](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection) was created.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getServiceResolvers

Optional. A list of
[ServiceResolvers](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection.ServiceResolver) where
the EKM can be reached. There should be one ServiceResolver per EKM
replica. Currently, only a single
[ServiceResolver](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection.ServiceResolver) is
supported.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection.ServiceResolver>` |   |

### setServiceResolvers

Optional. A list of
[ServiceResolvers](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection.ServiceResolver) where
the EKM can be reached. There should be one ServiceResolver per EKM
replica. Currently, only a single
[ServiceResolver](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection.ServiceResolver) is
supported.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection.ServiceResolver>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getEtag

Optional. Etag of the currently stored
[EkmConnection](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setEtag

Optional. Etag of the currently stored
[EkmConnection](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.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](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection.KeyManagementMode#_Google_Cloud_Kms_V1_EkmConnection_KeyManagementMode__MANUAL).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [KeyManagementMode](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection.KeyManagementMode). |

### setKeyManagementMode

Optional. Describes who can perform control plane operations on the EKM. If
unset, this defaults to
[MANUAL](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection.KeyManagementMode#_Google_Cloud_Kms_V1_EkmConnection_KeyManagementMode__MANUAL).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [KeyManagementMode](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection.KeyManagementMode). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCryptoSpacePath

Optional. Identifies the EKM Crypto Space that this
[EkmConnection](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection) maps to. Note: This
field is required if
[KeyManagementMode](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection.KeyManagementMode) is
[CLOUD_KMS](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection.KeyManagementMode#_Google_Cloud_Kms_V1_EkmConnection_KeyManagementMode__CLOUD_KMS).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setCryptoSpacePath

Optional. Identifies the EKM Crypto Space that this
[EkmConnection](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection) maps to. Note: This
field is required if
[KeyManagementMode](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection.KeyManagementMode) is
[CLOUD_KMS](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.EkmConnection.KeyManagementMode#_Google_Cloud_Kms_V1_EkmConnection_KeyManagementMode__CLOUD_KMS).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |