# Cluster

**Package:** `flyteplugins.union.remote`

Represents a Union cluster.

## Parameters

```python
class Cluster(
    pb2: ClusterPb2,
)
```
| Parameter | Type | Description |
|-|-|-|
| `pb2` | `ClusterPb2` | |

## Properties

| Property | Type | Description |
|-|-|-|
| `assigned_config_id` | `str` |  |
| `bucket_name` | `str` |  |
| `bucket_region` | `str` |  |
| `capacity` | `str` | Compact capacity for table view: ``'64c/512G/8g'`` (cpu/memory/gpu).  Returns an empty string when the cluster reports no capacity (e.g. disabled or never-reported clusters) — table renderers should display that as ``—``. Memory is rounded to GiB when ≥ 1 GiB, otherwise reported in MiB. The GPU segment is omitted when the cluster has no GPUs. |
| `cloud_host_name` | `str` |  |
| `config_drift` | `bool` | True when the cluster has not yet synced to the assigned config. |
| `dataplane_ingress_enabled` | `bool` |  |
| `gcp_project_id` | `str` |  |
| `health` | `str` |  |
| `health_display` | `str` |  |
| `metadata_bucket_prefix` | `str` |  |
| `monitoring_info` | `list[dict]` |  |
| `name` | `str` |  |
| `operator_app_id` | `str` |  |
| `organization` | `str` |  |
| `queues` | `list[dict]` |  |
| `state` | `str` |  |
| `storage_type` | `str` |  |
| `synced_at` | `str` |  |
| `synced_config_id` | `str` |  |
| `tunnel_status` | `str` |  |
| `tunnel_status_display` | `str` |  |
| `tunnel_url` | `str` |  |
| `unhealthy_reasons` | `list[str]` |  |
| `user_role` | `str` |  |

## Methods

| Method | Description |
|-|-|
| [`get()`](#get) | Get a cluster by name. |
| [`listall()`](#listall) | List all clusters in the organization. |
| [`to_dict()`](#to_dict) | Convert the object to a JSON-serializable dictionary. |
| [`to_json()`](#to_json) | Convert the object to a JSON string. |

### get()

> [!NOTE] This method can be called both synchronously or asynchronously.
> Default invocation is sync and will block.
> To call it asynchronously, use the function `.aio()` on the method name itself, e.g.,:
> `result = await Cluster.get.aio()`.
```python
def get(
    cls,
    name: str,
) -> Cluster
```
Get a cluster by name.

| Parameter | Type | Description |
|-|-|-|
| `cls` |  | |
| `name` | `str` | |

### listall()

> [!NOTE] This method can be called both synchronously or asynchronously.
> Default invocation is sync and will block.
> To call it asynchronously, use the function `.aio()` on the method name itself, e.g.,:
> `result = await Cluster.listall.aio()`.
```python
def listall(
    cls,
    limit: int,
) -> AsyncIterator[Cluster]
```
List all clusters in the organization.

| Parameter | Type | Description |
|-|-|-|
| `cls` |  | |
| `limit` | `int` | Maximum number of clusters to return. |

### to_dict()

```python
def to_dict()
```
Convert the object to a JSON-serializable dictionary.

**Returns:** dict: A dictionary representation of the object.

### to_json()

```python
def to_json()
```
Convert the object to a JSON string.

**Returns:** str: A JSON string representation of the object.

---
**Source**: https://github.com/unionai/unionai-docs/blob/main/content/api-reference/integrations/union/packages/flyteplugins.union.remote/cluster.md
**HTML**: https://www.union.ai/docs/v2/union/api-reference/integrations/union/packages/flyteplugins.union.remote/cluster/