Ports.Binding (docker-java-api 3.2.12 API)

java.lang.Object
- com.github.dockerjava.api.model.DockerObject
- - com.github.dockerjava.api.model.Ports.Binding

All Implemented Interfaces:

Serializable

Enclosing class:

Ports
```
public static class Ports.Binding
extends DockerObject
implements Serializable
```
A Ports.Binding represents a socket on the Docker host that is used in a PortBinding. It is characterized by an IP address and a port spec. Both properties may be null in order to let Docker assign them dynamically/using defaults.

See Also:

Ports.bind(ExposedPort, Binding), ExposedPort, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Binding(String hostIp, String hostPortSpec)
Creates a Ports.Binding for the given host IP address and host port spec.

Constructors
Constructor and Description
`Binding(String hostIp, String hostPortSpec)` Creates a `Ports.Binding` for the given `host IP address` and `host port spec`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Ports.Binding`	`bindIp(String hostIp)` Creates a `Ports.Binding` for the given `IP address`, leaving the `port spec` undefined.
`static Ports.Binding`	`bindIpAndPort(String hostIp, int port)` Creates a `Ports.Binding` for the given `IP address` and port number.
`static Ports.Binding`	`bindIpAndPortRange(String hostIp, int lowPort, int highPort)` Creates a `Ports.Binding` for the given `IP address` and port range.
`static Ports.Binding`	`bindPort(int port)` Creates a `Ports.Binding` for the given port leaving the `IP address` undefined.
`static Ports.Binding`	`bindPortRange(int lowPort, int highPort)` Creates a `Ports.Binding` for the given port range, leaving the `IP address` undefined.
`static Ports.Binding`	`bindPortSpec(String portSpec)` Creates a `Ports.Binding` for the given `port spec`, leaving the `IP address` undefined.
`static Ports.Binding`	`empty()` Creates an empty `Ports.Binding`.
`String`	`getHostIp()`
`String`	`getHostPortSpec()`
`static Ports.Binding`	`parse(String serialized)` Parses a textual host and port specification (as used by the Docker CLI) to a `Ports.Binding`.
`String`	`toString()` Returns a string representation of this `Ports.Binding` suitable for inclusion in a JSON message.

Methods inherited from class com.github.dockerjava.api.model.DockerObject
getRawValues

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

- Constructor Detail
  - Binding
```
public Binding(String hostIp,
               String hostPortSpec)
```
    Creates a Ports.Binding for the given host IP address and host port spec.
    
    See Also:
    
    Ports.bind(ExposedPort, Binding), ExposedPort
- Method Detail
  - bindPortSpec
```
public static Ports.Binding bindPortSpec(String portSpec)
```
    Creates a Ports.Binding for the given port spec, leaving the IP address undefined.
    
    See Also:
    
    Ports.bind(ExposedPort, Binding), ExposedPort
  - bindIp
```
public static Ports.Binding bindIp(String hostIp)
```
    Creates a Ports.Binding for the given IP address, leaving the port spec undefined.
  - bindIpAndPort
```
public static Ports.Binding bindIpAndPort(String hostIp,
                                          int port)
```
    Creates a Ports.Binding for the given IP address and port number.
  - bindIpAndPortRange
```
public static Ports.Binding bindIpAndPortRange(String hostIp,
                                               int lowPort,
                                               int highPort)
```
    Creates a Ports.Binding for the given IP address and port range.
  - bindPortRange
```
public static Ports.Binding bindPortRange(int lowPort,
                                          int highPort)
```
    Creates a Ports.Binding for the given port range, leaving the IP address undefined.
  - bindPort
```
public static Ports.Binding bindPort(int port)
```
    Creates a Ports.Binding for the given port leaving the IP address undefined.
  - empty
```
public static Ports.Binding empty()
```
    Creates an empty Ports.Binding.
  - getHostIp
```
public String getHostIp()
```
    Returns:
    
    the IP address on the Docker host. May be null, in which case Docker will bind the port to all interfaces ( 0.0.0.0).
  - getHostPortSpec
```
public String getHostPortSpec()
```
    Returns:
    
    the port spec for the binding on the Docker host. May reference a single port ("1234"), a port range ("1234-2345") or null, in which case Docker will dynamically assign a port.
  - parse
```
public static Ports.Binding parse(String serialized)
                           throws IllegalArgumentException
```
    Parses a textual host and port specification (as used by the Docker CLI) to a Ports.Binding.
    Legal syntax: IP|IP:portSpec|portSpec where portSpec is either a single port or a port range
    
    Parameters:
    
    serialized - serialized the specification, e.g. 127.0.0.1:80
    
    Returns:
    
    a Ports.Binding matching the specification
    
    Throws:
    
    IllegalArgumentException - if the specification cannot be parsed
  - toString
```
public String toString()
```
    Returns a string representation of this Ports.Binding suitable for inclusion in a JSON message. The format is [IP:]Port, like the argument in parse(String).
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of this Ports.Binding

Class Ports.Binding

Constructor Summary

Method Summary

Methods inherited from class com.github.dockerjava.api.model.DockerObject

Methods inherited from class java.lang.Object

Constructor Detail

Binding

Method Detail

bindPortSpec

bindIp

bindIpAndPort

bindIpAndPortRange

bindPortRange

bindPort

empty

getHostIp

getHostPortSpec

parse

toString