Cluster

cluster

ClusterNodeId

Bases: str

Unique ID of a cluster node.

GetClusterDetailsAction

Bases: BaseModel

Get information about the cluster.

include_terminated class-attribute instance-attribute

include_terminated = Field(
    default=None,
    description="Include terminated nodes in the response.",
    validation_alias="includeTerminated",
    serialization_alias="includeTerminated",
)

GetClusterDetailsOutput

Bases: BaseModel

Information about the cluster.

nodes class-attribute instance-attribute

nodes = Field(description='Nodes of the cluster.')

ClusterNode

Bases: BaseModel

Cluster node.

node_id class-attribute instance-attribute

node_id = Field(
    description="ID of the cluster node.",
    validation_alias="nodeId",
    serialization_alias="nodeId",
)

name class-attribute instance-attribute

name = Field(
    default=None, description="Name of the cluster node."
)

status class-attribute instance-attribute

status = Field(description='Status of the cluster node.')

joined_at class-attribute instance-attribute

joined_at = Field(
    description="Timestamp when the node joined the cluster.",
    validation_alias="joinedAt",
    serialization_alias="joinedAt",
)

uptime_secs class-attribute instance-attribute

uptime_secs = Field(
    description="Uptime of the node in seconds.",
    validation_alias="uptimeSecs",
    serialization_alias="uptimeSecs",
)

last_heartbeat class-attribute instance-attribute

last_heartbeat = Field(
    description="Timestamp when the node last reported a heartbeat.",
    validation_alias="lastHeartbeat",
    serialization_alias="lastHeartbeat",
)

terminated_at class-attribute instance-attribute

terminated_at = Field(
    default=None,
    description="Timestamp when the node was terminated.",
    validation_alias="terminatedAt",
    serialization_alias="terminatedAt",
)

termination_reason class-attribute instance-attribute

termination_reason = Field(
    default=None,
    description="Reason why the node was terminated.",
    validation_alias="terminationReason",
    serialization_alias="terminationReason",
)

RegisterClusterNodeAction

Bases: BaseModel

Register a new cluster node.

name class-attribute instance-attribute

name = Field(
    default=None, description="Name of the cluster node."
)

RegisterClusterNodeOutput

Bases: BaseModel

Output of registering a new cluster node.

node_id class-attribute instance-attribute

node_id = Field(
    description="ID of the cluster node.",
    validation_alias="nodeId",
    serialization_alias="nodeId",
)

ReportClusterNodeHeartbeatAction

Bases: BaseModel

Report the heartbeat of a cluster node.

CleanupInactiveClusterNodesAction

Bases: BaseModel

Cleanup inactive cluster nodes.

ClusterNodeStatus_Active

Bases: RootModel[Literal['Active']]

ClusterNodeStatus_Terminated

Bases: RootModel[Literal['Terminated']]

ClusterNodeStatus

ClusterNodeStatus = (
    ClusterNodeStatus_Active | ClusterNodeStatus_Terminated
)

ClusterNodeTerminationReason_Unknown

Bases: RootModel[Literal['Unknown']]

ClusterNodeTerminationReason_HeartbeatTimeout

Bases: RootModel[Literal['HeartbeatTimeout']]

ClusterNodeTerminationReason_Shutdown

Bases: RootModel[Literal['Shutdown']]

ClusterNodeTerminationReason

ClusterNodeTerminationReason = (
    ClusterNodeTerminationReason_Unknown
    | ClusterNodeTerminationReason_HeartbeatTimeout
    | ClusterNodeTerminationReason_Shutdown
)