Cluster

Package: flyteplugins.union.remote

Represents a Union cluster.

Parameters

        
    
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 a cluster by name.
`listall()`	List all clusters in the organization.
`to_dict()`	Convert the object to a JSON-serializable dictionary.
`to_json()`	Convert the object to a JSON string.

get()

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().

        
    
def get(
    cls,
    name: str,
) -> Cluster

Get a cluster by name.

Parameter	Type	Description
`cls`
`name`	`str`

listall()

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().

        
    
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()

        
    
def to_dict()

Convert the object to a JSON-serializable dictionary.

Returns: dict: A dictionary representation of the object.

to_json()

        
    
def to_json()

Convert the object to a JSON string.

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