core.cluster
============

.. py:module:: core.cluster

.. autoapi-nested-parse::

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



Attributes
----------

.. autoapisummary::

   core.cluster.logger


Classes
-------

.. autoapisummary::

   core.cluster.Cluster


Module Contents
---------------

.. py:data:: logger

.. py:class:: Cluster(cluster_name: str, requester: Optional[jobmon.core.requester.Requester] = None)

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

   Initialization of Cluster.


   .. py:attribute:: cluster_name


   .. py:attribute:: requester
      :value: None



   .. py:attribute:: queues
      :type:  Dict[str, jobmon.core.cluster_protocol.ClusterQueue]


   .. py:method:: get_cluster(cluster_name: str, requester: Optional[jobmon.core.requester.Requester] = None) -> Cluster
      :classmethod:


      Get a bound instance of a Cluster.

      :param cluster_name: the name of the cluster
      :param requester: requester object to connect to FastApi service.
      :type requester: Requester



   .. py:method:: bind() -> None

      Bind Cluster to the database, getting an id back.



   .. py:property:: connection_parameters
      :type: Dict


      The connection parameters.


   .. py:property:: is_bound
      :type: bool


      If the Cluster has been bound to the database.


   .. py:property:: id
      :type: int


      Unique id from database if Cluster has been bound.


   .. py:method:: get_worker_node() -> jobmon.core.cluster_protocol.ClusterWorkerNode

      Get the cluster specific worker_node interface.



   .. py:method:: get_distributor() -> jobmon.core.cluster_protocol.ClusterDistributor

      Get the cluster specific distributor interface.



   .. py:method:: get_queue(queue_name: str) -> jobmon.core.cluster_protocol.ClusterQueue

      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.

      :param queue_name: name of the queue you want.