core.cluster

Cluster objects define where a user wants their tasks run. e.g. UGE, Azure, Seq.

Attributes

logger

Classes

Cluster

Cluster objects define where a user wants their tasks run. e.g. UGE, Azure, Seq.

Module Contents

core.cluster.logger[source]
class core.cluster.Cluster(cluster_name: str, requester: jobmon.core.requester.Requester | None = None)[source]

Cluster objects define where a user wants their tasks run. e.g. UGE, Azure, Seq.

cluster_name[source]
requester = None[source]
queues: Dict[str, jobmon.core.cluster_protocol.ClusterQueue][source]
classmethod get_cluster(cluster_name: str, requester: jobmon.core.requester.Requester | None = None) → Cluster[source]

Get a bound instance of a Cluster.

Parameters:

  • cluster_name – the name of the cluster

  • requester (Requester) – requester object to connect to FastApi service.

bind() → None[source]

Bind Cluster to the database, getting an id back.

property connection_parameters: Dict[source]

The connection parameters.

property is_bound: bool[source]

If the Cluster has been bound to the database.

property id: int[source]

Unique id from database if Cluster has been bound.

get_worker_node() → jobmon.core.cluster_protocol.ClusterWorkerNode[source]

Get the cluster specific worker_node interface.

get_distributor() → jobmon.core.cluster_protocol.ClusterDistributor[source]

Get the cluster specific distributor interface.

get_queue(queue_name: str) → jobmon.core.cluster_protocol.ClusterQueue[source]

Get the ClusterQueue object associated with a given queue_name.

Checks if queue object is in the cache, if it’s not it will query the database and add the queue object to the cache.

Parameters:

queue_name – name of the queue you want.