DockerHost (docker-client 5.0.2 API)

java.lang.Object
- com.spotify.docker.client.DockerHost

```
public class DockerHost
extends Object
```
Represents a dockerd endpoint. A codified DOCKER_HOST.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) static interface DockerHost.SystemDelegate
An interface to be mocked during testing.

Nested Classes
Modifier and Type	Class and Description
`(package private) static interface`	`DockerHost.SystemDelegate` An interface to be mocked during testing.

Field Summary

Fields
Modifier and Type	Field and Description
`private String`	`address`
`private URI`	`bindURI`
`private String`	`certPath`
`private static String`	`DEFAULT_ADDRESS`
`private static int`	`DEFAULT_PORT`
`private static String`	`DEFAULT_UNIX_ENDPOINT`
`private String`	`host`
`private int`	`port`
`private static DockerHost.SystemDelegate`	`systemDelegate`
`private URI`	`uri`

Constructor Summary

Constructors
Modifier Constructor and Description

private DockerHost(String endpoint, String certPath)

Constructors
Modifier	Constructor and Description
`private`	`DockerHost(String endpoint, String certPath)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`address()` Get the Docker ip address or hostname.
`URI`	`bindURI()` Get the Docker rest bind uri.
`(package private) static String`	`certPathFromEnv()`
`static String`	`defaultAddress()`
`(package private) static String`	`defaultCertPath()`
`(package private) static String`	`defaultDockerEndpoint()`
`static int`	`defaultPort()`
`static String`	`defaultUnixEndpoint()`
`String`	`dockerCertPath()` Get the path to certificate and key for connecting to Docker via HTTPS.
`(package private) static String`	`endpointFromEnv()`
`boolean`	`equals(Object o)`
`static DockerHost`	`from(String endpoint, String certPath)` Create a `DockerHost` from an explicit address or uri.
`static DockerHost`	`fromEnv()` Create a `DockerHost` from DOCKER_HOST and DOCKER_PORT env vars.
`int`	`hashCode()`
`String`	`host()` Get a Docker endpoint usable for instantiating a new DockerHost with DockerHost.from(endpoint).
`int`	`port()` Get the Docker endpoint port.
`(package private) static int`	`portFromEnv()`
`(package private) static void`	`setSystemDelegate(DockerHost.SystemDelegate delegate)`
`String`	`toString()`
`URI`	`uri()` Get the Docker rest uri.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - systemDelegate
```
private static DockerHost.SystemDelegate systemDelegate
```
  - DEFAULT_UNIX_ENDPOINT
```
private static final String DEFAULT_UNIX_ENDPOINT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ADDRESS
```
private static final String DEFAULT_ADDRESS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PORT
```
private static final int DEFAULT_PORT
```
    See Also:
    
    Constant Field Values
  - host
```
private final String host
```
  - uri
```
private final URI uri
```
  - bindURI
```
private final URI bindURI
```
  - address
```
private final String address
```
  - port
```
private final int port
```
  - certPath
```
private final String certPath
```
- Constructor Detail
  - DockerHost
```
private DockerHost(String endpoint,
                   String certPath)
```
- Method Detail
  - host
```
public String host()
```
    Get a Docker endpoint usable for instantiating a new DockerHost with DockerHost.from(endpoint).
    
    Returns:
    
    A unix socket path or, in the case of a TCP socket, the hostname and port which represents a Docker endpoint.
  - uri
```
public URI uri()
```
    Get the Docker rest uri.
    
    Returns:
    
    The uri of the Docker endpoint.
  - bindURI
```
public URI bindURI()
```
    Get the Docker rest bind uri.
    
    Returns:
    
    The uri of the host for binding ports (or setting $DOCKER_HOST).
  - port
```
public int port()
```
    Get the Docker endpoint port.
    
    Returns:
    
    The port.
  - address
```
public String address()
```
    Get the Docker ip address or hostname.
    
    Returns:
    
    The ip address or hostname.
  - dockerCertPath
```
public String dockerCertPath()
```
    Get the path to certificate and key for connecting to Docker via HTTPS.
    
    Returns:
    
    The path to the certificate.
  - setSystemDelegate
```
static void setSystemDelegate(DockerHost.SystemDelegate delegate)
```
  - fromEnv
```
public static DockerHost fromEnv()
```
    Create a DockerHost from DOCKER_HOST and DOCKER_PORT env vars.
    
    Returns:
    
    The DockerHost object.
  - from
```
public static DockerHost from(String endpoint,
                              String certPath)
```
    Create a DockerHost from an explicit address or uri.
    
    Parameters:
    
    endpoint - The Docker endpoint.
    
    certPath - The certificate path.
    
    Returns:
    
    The DockerHost object.
  - defaultDockerEndpoint
```
static String defaultDockerEndpoint()
```
  - endpointFromEnv
```
static String endpointFromEnv()
```
  - defaultUnixEndpoint
```
public static String defaultUnixEndpoint()
```
  - defaultAddress
```
public static String defaultAddress()
```
  - defaultPort
```
public static int defaultPort()
```
  - portFromEnv
```
static int portFromEnv()
```
  - defaultCertPath
```
static String defaultCertPath()
```
  - certPathFromEnv
```
static String certPathFromEnv()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class DockerHost

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

systemDelegate

DEFAULT_UNIX_ENDPOINT

DEFAULT_ADDRESS

DEFAULT_PORT

host

uri

bindURI

address

port

certPath

Constructor Detail

DockerHost

Method Detail

host

uri

bindURI

port

address

dockerCertPath

setSystemDelegate

fromEnv

from

defaultDockerEndpoint

endpointFromEnv

defaultUnixEndpoint

defaultAddress

defaultPort

portFromEnv

defaultCertPath

certPathFromEnv

toString

equals

hashCode