# Cloud KMS V1 Client - Class LocationMetadata (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 LocationMetadata.

Cloud KMS metadata for the given
[google.cloud.location.Location](https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.Location.html).

Generated from protobuf message `google.cloud.kms.v1.LocationMetadata`

## Namespace

Google \\ Cloud \\ Kms \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ hsm_available` | `bool` Indicates whether [CryptoKeys](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKey) with [protection_level](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersionTemplate#_Google_Cloud_Kms_V1_CryptoKeyVersionTemplate__getProtectionLevel__) [HSM](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel#_Google_Cloud_Kms_V1_ProtectionLevel__HSM) can be created in this location. |
| `↳ ekm_available` | `bool` Indicates whether [CryptoKeys](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKey) with [protection_level](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersionTemplate#_Google_Cloud_Kms_V1_CryptoKeyVersionTemplate__getProtectionLevel__) [EXTERNAL](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel#_Google_Cloud_Kms_V1_ProtectionLevel__EXTERNAL) can be created in this location. |
| `↳ hsm_single_tenant_available` | `bool` Indicates whether [CryptoKeys](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKey) with [protection_level](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersionTemplate#_Google_Cloud_Kms_V1_CryptoKeyVersionTemplate__getProtectionLevel__) [HSM_SINGLE_TENANT](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel#_Google_Cloud_Kms_V1_ProtectionLevel__HSM_SINGLE_TENANT) can be created in this location. |

### getHsmAvailable

Indicates whether [CryptoKeys](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKey) with
[protection_level](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersionTemplate#_Google_Cloud_Kms_V1_CryptoKeyVersionTemplate__getProtectionLevel__)
[HSM](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel#_Google_Cloud_Kms_V1_ProtectionLevel__HSM) can be created in this
location.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setHsmAvailable

Indicates whether [CryptoKeys](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKey) with
[protection_level](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersionTemplate#_Google_Cloud_Kms_V1_CryptoKeyVersionTemplate__getProtectionLevel__)
[HSM](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel#_Google_Cloud_Kms_V1_ProtectionLevel__HSM) can be created in this
location.

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

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

### getEkmAvailable

Indicates whether [CryptoKeys](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKey) with
[protection_level](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersionTemplate#_Google_Cloud_Kms_V1_CryptoKeyVersionTemplate__getProtectionLevel__)
[EXTERNAL](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel#_Google_Cloud_Kms_V1_ProtectionLevel__EXTERNAL) can be created in
this location.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setEkmAvailable

Indicates whether [CryptoKeys](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKey) with
[protection_level](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersionTemplate#_Google_Cloud_Kms_V1_CryptoKeyVersionTemplate__getProtectionLevel__)
[EXTERNAL](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel#_Google_Cloud_Kms_V1_ProtectionLevel__EXTERNAL) can be created in
this location.

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

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

### getHsmSingleTenantAvailable

Indicates whether [CryptoKeys](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKey) with
[protection_level](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersionTemplate#_Google_Cloud_Kms_V1_CryptoKeyVersionTemplate__getProtectionLevel__)
[HSM_SINGLE_TENANT](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel#_Google_Cloud_Kms_V1_ProtectionLevel__HSM_SINGLE_TENANT)
can be created in this location.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setHsmSingleTenantAvailable

Indicates whether [CryptoKeys](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKey) with
[protection_level](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.CryptoKeyVersionTemplate#_Google_Cloud_Kms_V1_CryptoKeyVersionTemplate__getProtectionLevel__)
[HSM_SINGLE_TENANT](https://docs.cloud.google.com/php/docs/reference/cloud-kms/latest/V1.ProtectionLevel#_Google_Cloud_Kms_V1_ProtectionLevel__HSM_SINGLE_TENANT)
can be created in this location.

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

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