Class ImagePuller

java.lang.Object
com.github.cowwoc.docker.resource.ImagePuller
public final class ImagePuller extends Object
Pulls an image from a remote repository.

  • Method Details

    • platform

      public ImagePuller platform(String platform)
      Sets the platform to pull.
      Parameters:
      platform - the platform of the image
      Returns:
      this
      Throws:
      NullPointerException - if platform is null
      IllegalArgumentException - if platform contains leading or trailing whitespace or is empty

    • credentials

      public ImagePuller credentials(String username, String password)
      Sets the registry credentials.
      Parameters:
      username - the user's name
      password - the user's password
      Returns:
      this
      Throws:
      NullPointerException - if any of the arguments are null
      IllegalArgumentException - if any of the arguments contain leading or trailing whitespace or are empty

    • credentials

      public ImagePuller credentials(String username, String password, String email, String serverAddress)
      Sets the registry credentials.
      Parameters:
      username - the user's name
      password - the user's password
      email - (optional) the user's email address, or an empty string if absent
      serverAddress - (optional) the name of the registry server, or an empty string if absent
      Returns:
      this
      Throws:
      NullPointerException - if any of the mandatory parameters are null
      IllegalArgumentException - if any of the arguments contain leading or trailing whitespace or are empty
      IllegalStateException - if the client is closed

    • pull

      public Image pull() throws IOException, TimeoutException, InterruptedException
      Pulls the image from the remote repository.
      Returns:
      null if the repository does not exist or may require docker login
      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.

    • toString

      public String toString()
      Overrides:
      toString in class Object