com.spotify.helios.common.descriptors

Class PortMapping

java.lang.Object

com.spotify.helios.common.descriptors.Descriptor

com.spotify.helios.common.descriptors.PortMapping

public class PortMapping
extends Descriptor

Represents a mapping from a port inside the container to be exposed on the agent.

A typical JSON representation might be:

 {
   "ip": "0.0.0.0",
   "externalPort" : 8061,
   "internalPort" : 8081,
   "protocol" : "tcp"
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PortMapping.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	TCP
static String	UDP

Constructor Summary

Constructors

Constructor and Description
PortMapping(int internalPort)
PortMapping(int internalPort, Integer externalPort)
PortMapping(String ip, int internalPort, Integer externalPort, String protocol)

Method Summary

Modifier and Type	Method and Description
static PortMapping.Builder	builder()
boolean	equals(Object obj)
Integer	getExternalPort()
int	getInternalPort()
String	getIp()
String	getProtocol()
boolean	hasExternalPort()
int	hashCode()
static PortMapping	of(int internalPort)
static PortMapping	of(int internalPort, Integer externalPort)
static PortMapping	of(int internalPort, Integer externalPort, String protocol)
static PortMapping	of(int internalPort, String protocol)
String	toString()
PortMapping	withExternalPort(Integer externalPort)

Methods inherited from class com.spotify.helios.common.descriptors.Descriptor

parse, parse, toJsonBytes, toJsonString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TCP

public static final String TCP

See Also:

Constant Field Values

UDP

public static final String UDP

See Also:

Constant Field Values

Constructor Detail

PortMapping

public PortMapping(@Nullable
                   String ip,
                   int internalPort,
                   @Nullable
                   Integer externalPort,
                   @Nullable
                   String protocol)

PortMapping

public PortMapping(int internalPort,
                   Integer externalPort)

PortMapping

public PortMapping(int internalPort)

Method Detail

getIp

@Nullable
public String getIp()

getInternalPort

public int getInternalPort()

hasExternalPort

public boolean hasExternalPort()

getExternalPort

@Nullable
public Integer getExternalPort()

getProtocol

public String getProtocol()

withExternalPort

public PortMapping withExternalPort(Integer externalPort)

of

public static PortMapping of(int internalPort)

of

public static PortMapping of(int internalPort,
                             Integer externalPort)

of

public static PortMapping of(int internalPort,
                             Integer externalPort,
                             String protocol)

of

public static PortMapping of(int internalPort,
                             String protocol)

builder

public static PortMapping.Builder builder()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object