# Google Cloud Managed Kafka V1 Client - Class Cluster (0.8.0)

0.8.0 (latest) 0.7.2 0.6.1 0.5.0 0.4.1 0.3.1 0.2.3 0.1.3 Reference documentation and code samples for the Google Cloud Managed Kafka V1 Client class Cluster.

An Apache Kafka cluster deployed in a location.

Generated from protobuf message `google.cloud.managedkafka.v1.Cluster`

## Namespace

Google \\ Cloud \\ ManagedKafka \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ gcp_config` | `https://docs.cloud.google.com/php/docs/reference/cloud-managedkafka/latest/V1.GcpConfig` Required. Configuration properties for a Kafka cluster deployed to Google Cloud Platform. |
| `↳ name` | `string` Identifier. The name of the cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id} |
| `↳ create_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Output only. The time when the cluster was created. |
| `↳ update_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Output only. The time when the cluster was last updated. |
| `↳ labels` | `array|https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` Optional. Labels as key value pairs. |
| `↳ capacity_config` | `https://docs.cloud.google.com/php/docs/reference/cloud-managedkafka/latest/V1.CapacityConfig` Required. Capacity configuration for the Kafka cluster. |
| `↳ rebalance_config` | `https://docs.cloud.google.com/php/docs/reference/cloud-managedkafka/latest/V1.RebalanceConfig` Optional. Rebalance configuration for the Kafka cluster. |
| `↳ state` | `int` Output only. The current state of the cluster. |
| `↳ satisfies_pzi` | `bool` Output only. Reserved for future use. |
| `↳ satisfies_pzs` | `bool` Output only. Reserved for future use. |
| `↳ tls_config` | `https://docs.cloud.google.com/php/docs/reference/cloud-managedkafka/latest/V1.TlsConfig` Optional. TLS configuration for the Kafka cluster. |

### getGcpConfig

Required. Configuration properties for a Kafka cluster deployed to Google
Cloud Platform.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-managedkafka/latest/V1.GcpConfig|null` |   |

### hasGcpConfig

### setGcpConfig

Required. Configuration properties for a Kafka cluster deployed to Google
Cloud Platform.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-managedkafka/latest/V1.GcpConfig` |

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

### getName

Identifier. The name of the cluster. Structured like:
projects/{project_number}/locations/{location}/clusters/{cluster_id}

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

### setName

Identifier. The name of the cluster. Structured like:
projects/{project_number}/locations/{location}/clusters/{cluster_id}

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

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

### getCreateTime

Output only. The time when the cluster was created.

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

### hasCreateTime

### clearCreateTime

### setCreateTime

Output only. The time when the cluster was created.

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

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

### getUpdateTime

Output only. The time when the cluster was last updated.

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

### hasUpdateTime

### clearUpdateTime

### setUpdateTime

Output only. The time when the cluster was last updated.

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

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

### getLabels

Optional. Labels as key value pairs.

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

### setLabels

Optional. Labels as key value pairs.

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

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

### getCapacityConfig

Required. Capacity configuration for the Kafka cluster.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-managedkafka/latest/V1.CapacityConfig|null` |   |

### hasCapacityConfig

### clearCapacityConfig

### setCapacityConfig

Required. Capacity configuration for the Kafka cluster.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-managedkafka/latest/V1.CapacityConfig` |

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

### getRebalanceConfig

Optional. Rebalance configuration for the Kafka cluster.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-managedkafka/latest/V1.RebalanceConfig|null` |   |

### hasRebalanceConfig

### clearRebalanceConfig

### setRebalanceConfig

Optional. Rebalance configuration for the Kafka cluster.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-managedkafka/latest/V1.RebalanceConfig` |

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

### getState

Output only. The current state of the cluster.

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

### setState

Output only. The current state of the cluster.

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

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

### getSatisfiesPzi

Output only. Reserved for future use.

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

### hasSatisfiesPzi

### clearSatisfiesPzi

### setSatisfiesPzi

Output only. Reserved for future use.

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

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

### getSatisfiesPzs

Output only. Reserved for future use.

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

### hasSatisfiesPzs

### clearSatisfiesPzs

### setSatisfiesPzs

Output only. Reserved for future use.

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

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

### getTlsConfig

Optional. TLS configuration for the Kafka cluster.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-managedkafka/latest/V1.TlsConfig|null` |   |

### hasTlsConfig

### clearTlsConfig

### setTlsConfig

Optional. TLS configuration for the Kafka cluster.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-managedkafka/latest/V1.TlsConfig` |

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

### getPlatformConfig

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