Class Node

java.lang.Object
com.github.cowwoc.docker.resource.Node
public final class Node extends Object
A docker node.

  • Method Details

    • getById

      public static Node getById(DockerClient client, String id) throws IOException, TimeoutException, InterruptedException
      Looks up a node by its name or ID.
      Parameters:
      client - the client configuration
      id - the node's name or ID
      Returns:
      null if no match is found
      Throws:
      NullPointerException - if any of the arguments are null
      IllegalArgumentException - if id contains leading or trailing whitespace or is empty
      IllegalStateException - if:
      • the client is closed.
      • the server is not part of a swarm.
      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.

    • getId

      public String getId()
      Returns the node's id.
      Returns:
      the node's id

    • getName

      public String getName()
      Returns the node's name.
      Returns:
      the node's name

    • getHostname

      public String getHostname()
      Returns the node's hostname.
      Returns:
      the hostname

    • getRole

      public Node.SwarmRole getRole()
      Returns the role of the node within the swarm.
      Returns:
      null if the node is not part of a swarm

    • isLeader

      public boolean isLeader()
      Indicates if the node is a swarm leader.
      Returns:
      true if the node is a swarm leader

    • getStatus

      public Node.Status getStatus()
      Returns the overall health of the node.
      Returns:
      the overall health of the node

    • getReachability

      public Node.Reachability getReachability()
      Indicates whether it is possible to communicate with the node.
      Returns:
      UNKNOWN for worker nodes

    • getAvailability

      public Node.Availability getAvailability()
      Indicates if the node is available to run tasks.
      Returns:
      true if the node is available to run tasks

    • getManagerAddress

      public String getManagerAddress()
      Returns the node's address for manager communication.
      Returns:
      an empty string for worker nodes

    • getAddress

      public String getAddress()
      Returns the node's address.
      Returns:
      the node's address

    • getLabels

      public List<String> getLabels()
      Returns values that are used to constrain task scheduling to specific nodes.
      Returns:
      values that are used to constrain task scheduling to specific nodes

    • reload

      public Node reload() throws IOException, TimeoutException, InterruptedException
      Reloads the node's state.
      Returns:
      the updated state
      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.

    • drain

      public Node drain() throws IOException, TimeoutException, InterruptedException
      Begins gracefully removing tasks from this node and redistribute them to other active nodes.
      Returns:
      the updated node
      Throws:
      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.

    • getTasks

      public List<Task> getTasks() throws IOException, TimeoutException, InterruptedException
      Returns the tasks that are running on the node.
      Returns:
      the tasks that are running on the node.
      Throws:
      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.

    • setRole

      public Node setRole(Node.SwarmRole role) throws IOException, TimeoutException, InterruptedException
      Changes the role of the node.
      Parameters:
      role - the new role
      Returns:
      the updated node
      Throws:
      NullPointerException - if role 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.

    • destroy

      public void destroy() throws IOException, TimeoutException, InterruptedException
      Destroys the node.
      Throws:
      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.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object