Interface WorkerPool

All Superinterfaces:
Identified, Named, Serializable
All Known Implementing Classes:
ConfiguredWorkerPool, ProvisionedWorkerPool
public interface WorkerPool extends Identified, Named, Serializable
A pool of workers that are managed together.

  • Method Details

    • getId

      String getId()
      Description copied from interface: Identified
      Returns the ID
      Specified by:
      getId in interface Identified
      Returns:
      the ID

    • getName

      String getName()
      The name used to uniquely identify this worker pool.
      Specified by:
      getName in interface Named
      Returns:
      the worker pool name

    • getNamespace

      String getNamespace()
      The namespace that this worker pool is constrained to.
      Returns:
      the namespace that the worker pool is constrained to

    • getCreatedTime

      Instant getCreatedTime()
      The date and time when the worker pool was created.
      Returns:
      the date and time when the worker pool was created

    • getStatus

      WorkerPoolStatus getStatus()
      The worker pool status.
      Returns:
      the worker pool status

    • getStatusChangedTime

      Instant getStatusChangedTime()
      The date and time when the status last changed.
      Returns:
      the date and time when the status last changed

    • getExpectedNodeCount

      int getExpectedNodeCount()
      The expected number of nodes.
      Returns:
      the expected number of nodes

    • isAwaitingNodes

      boolean isAwaitingNodes()
      Indicates if the worker pool is awaiting the registration of nodes.
      Returns:
      true, if the worker pool is awaiting the registration of nodes; otherwise, false

    • getWorkerSummary

      WorkerSummary getWorkerSummary()
      The summary of the workers in this worker pool.
      Returns:
      the summary of the workers

    • getNodeSummary

      NodeSummary getNodeSummary()
      The summary of the nodes in this worker pool.
      Returns:
      the summary of the nodes

    • getProperties

      WorkerPoolProperties getProperties()
      The properties of this worker pool.
      Returns:
      the properties of this worker pool