Class Swarm

java.lang.Object
com.github.cowwoc.docker.resource.Swarm
public class Swarm extends Object
A docker swarm (cluster).

  • Method Details

    • getId

      public String getId()
      Returns the ID of the swarm.
      Returns:
      the ID of the swarm

    • getManagers

      public List<Node> getManagers() throws IOException, TimeoutException, InterruptedException
      Returns the manager nodes in the swarm.
      Returns:
      the manager nodes in the swarm
      Throws:
      IOException - if an I/O error occurs. These errors are typically transient, and retrying the request may resolve the issue.
      TimeoutException - if the request times out before receiving a response. This might indicate network latency or server overload.
      InterruptedException - if the thread is interrupted while waiting for a response. This can happen due to shutdown signals.

    • getWorkers

      public List<Node> getWorkers() throws IOException, TimeoutException, InterruptedException
      Returns the worker nodes in the swarm.
      Returns:
      the worker nodes in the swarm
      Throws:
      IOException - if an I/O error occurs. These errors are typically transient, and retrying the request may resolve the issue.
      TimeoutException - if the request times out before receiving a response. This might indicate network latency or server overload.
      InterruptedException - if the thread is interrupted while waiting for a response. This can happen due to shutdown signals.

    • getNodes

      public List<Node> getNodes() throws IOException, TimeoutException, InterruptedException
      Returns the nodes in the swarm.
      Returns:
      the nodes in the swarm
      Throws:
      IOException - if an I/O error occurs. These errors are typically transient, and retrying the request may resolve the issue.
      TimeoutException - if the request times out before receiving a response. This might indicate network latency or server overload.
      InterruptedException - if the thread is interrupted while waiting for a response. This can happen due to shutdown signals.

    • getManagerToken

      public String getManagerToken()
      Returns the secret value needed to join the swarm as a manager.
      Returns:
      the secret value needed to join the swarm as a manager

    • getWorkerToken

      public String getWorkerToken()
      Returns the secret value needed to join the swarm as a worker.
      Returns:
      the secret value needed to join the swarm as a worker

    • getReadyManagers

      public List<Node> getReadyManagers() throws IOException, TimeoutException, InterruptedException
      Returns the manager nodes with a READY status.
      Returns:
      the manager nodes with a READY status
      Throws:
      IOException - if an I/O error occurs. These errors are typically transient, and retrying the request may resolve the issue.
      TimeoutException - if the request times out before receiving a response. This might indicate network latency or server overload.
      InterruptedException - if the thread is interrupted while waiting for a response. This can happen due to shutdown signals.

    • getReadyWorkers

      public List<Node> getReadyWorkers() throws IOException, TimeoutException, InterruptedException
      Returns the worker nodes with a READY status.
      Returns:
      the worker nodes with a READY status
      Throws:
      IOException - if an I/O error occurs. These errors are typically transient, and retrying the request may resolve the issue.
      TimeoutException - if the request times out before receiving a response. This might indicate network latency or server overload.
      InterruptedException - if the thread is interrupted while waiting for a response. This can happen due to shutdown signals.

    • removeNode

      public void removeNode(Node node) throws IOException, TimeoutException, InterruptedException
      Removes a node from the swarm.
      Parameters:
      node - the node
      Throws:
      NullPointerException - if node is null
      IllegalStateException - if the client is closed
      IOException - if an I/O error occurs. These errors are typically transient, and retrying the request may resolve the issue.
      TimeoutException - if the request times out before receiving a response. This might indicate network latency or server overload.
      InterruptedException - if the thread is interrupted while waiting for a response. This can happen due to shutdown signals.

    • toString

      public String toString()
      Overrides:
      toString in class Object