com.github.dockerjava.api.model.ContainerSpec Maven / Gradle / Ivy
package com.github.dockerjava.api.model;
import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.EqualsAndHashCode;
import lombok.ToString;
import javax.annotation.CheckForNull;
import java.io.Serializable;
import java.util.List;
import java.util.Map;
/**
* The specification for containers as used in {@link TaskSpec}
*
* @since {@link RemoteApiVersion#VERSION_1_24}
*/
@EqualsAndHashCode
@ToString
public class ContainerSpec implements Serializable {
public static final long serialVersionUID = 1L;
/**
* @since 1.24
*/
@JsonProperty("Image")
private String image;
/**
* @since 1.24
*/
@JsonProperty("Labels")
private Map labels;
/**
* @since 1.24
*/
@JsonProperty("Command")
private List command;
/**
* @since 1.24
*/
@JsonProperty("Args")
private List args;
/**
* @since 1.24
*/
@JsonProperty("Env")
private List env;
/**
* @since 1.24
*/
@JsonProperty("Dir")
private String dir;
/**
* @since 1.24
*/
@JsonProperty("User")
private String user;
/**
* @since 1.24
*/
@JsonProperty("Groups")
private String groups;
/**
* @since 1.24
*/
@JsonProperty("TTY")
private Boolean tty;
/**
* @since 1.24
*/
@JsonProperty("Mounts")
private List mounts;
/**
* @since 1.24
*/
@JsonProperty("Duration")
private Long duration;
/**
* @since 1.24
*/
@JsonProperty("StopGracePeriod")
private Long stopGracePeriod;
/**
* @since 1.25
* Specification for DNS related configurations in resolver configuration file
*/
@JsonProperty("DNSConfig")
private ContainerDNSConfig dnsConfig;
/**
* @since 1.26
* Open stdin
*/
@JsonProperty("OpenStdin")
private Boolean openStdin;
/**
* @since 1.26
* Mount the container's root filesystem as read only.
*/
@JsonProperty("ReadOnly")
private Boolean readOnly;
/**
* @since 1.26
* A list of hostnames/IP mappings to add to the container's /etc/hosts file.
*/
@JsonProperty("Hosts")
private List hosts;
/**
* @since 1.26
* The hostname to use for the container, as a valid RFC 1123 hostname
*/
@JsonProperty("Hostname")
private String hostname;
/**
* @since 1.26
* Secrets contains references to zero or more secrets that will be exposed to the service.
*/
@JsonProperty("Secrets")
private List secrets;
/**
* @since 1.26
* A test to perform to check that the container is healthy.
*/
@JsonProperty("HealthCheck")
private HealthCheck healthCheck;
/**
* @since 1.28
* Signal to stop the container.
*/
@JsonProperty("StopSignal")
private String stopSignal;
/**
* @since 1.29
* Security options for the container
*/
@JsonProperty("Privileges")
private ContainerSpecPrivileges privileges;
/**
* @since 1.29
* Configs contains references to zero or more configs that will be exposed to the service.
*/
@JsonProperty("Configs")
private List configs;
/**
* @see #image
*/
@CheckForNull
public String getImage() {
return image;
}
/**
* @see #image
*/
public ContainerSpec withImage(String image) {
this.image = image;
return this;
}
/**
* @see #labels
*/
@CheckForNull
public Map getLabels() {
return labels;
}
/**
* @see #labels
*/
public ContainerSpec withLabels(Map labels) {
this.labels = labels;
return this;
}
/**
* @see #command
*/
@CheckForNull
public List getCommand() {
return command;
}
/**
* @see #command
*/
public ContainerSpec withCommand(List command) {
this.command = command;
return this;
}
/**
* @see #args
*/
@CheckForNull
public List getArgs() {
return args;
}
/**
* @see #args
*/
public ContainerSpec withArgs(List args) {
this.args = args;
return this;
}
/**
* @see #env
*/
@CheckForNull
public List getEnv() {
return env;
}
/**
* @see #env
*/
public ContainerSpec withEnv(List env) {
this.env = env;
return this;
}
/**
* @see #dir
*/
@CheckForNull
public String getDir() {
return dir;
}
/**
* @see #dir
*/
public ContainerSpec withDir(String dir) {
this.dir = dir;
return this;
}
/**
* @see #user
*/
@CheckForNull
public String getUser() {
return user;
}
/**
* @see #user
*/
public ContainerSpec withUser(String user) {
this.user = user;
return this;
}
/**
* @see #groups
*/
@CheckForNull
public String getGroups() {
return groups;
}
/**
* @see #groups
*/
public ContainerSpec withGroups(String groups) {
this.groups = groups;
return this;
}
/**
* @see #tty
*/
@CheckForNull
public Boolean getTty() {
return tty;
}
/**
* @see #tty
*/
public ContainerSpec withTty(Boolean tty) {
this.tty = tty;
return this;
}
/**
* @see #mounts
*/
@CheckForNull
public List getMounts() {
return mounts;
}
/**
* @see #mounts
*/
public ContainerSpec withMounts(List mounts) {
this.mounts = mounts;
return this;
}
/**
* @see #duration
*/
@CheckForNull
public Long getDuration() {
return duration;
}
/**
* @see #duration
*/
public ContainerSpec withDuration(Long duration) {
this.duration = duration;
return this;
}
public ContainerDNSConfig getDnsConfig() {
return dnsConfig;
}
public ContainerSpec withDnsConfig(ContainerDNSConfig dnsConfig) {
this.dnsConfig = dnsConfig;
return this;
}
public Boolean getOpenStdin() {
return openStdin;
}
public ContainerSpec withOpenStdin(Boolean openStdin) {
this.openStdin = openStdin;
return this;
}
public Boolean getReadOnly() {
return readOnly;
}
public ContainerSpec withReadOnly(Boolean readOnly) {
this.readOnly = readOnly;
return this;
}
public List getHosts() {
return hosts;
}
public ContainerSpec withHosts(List hosts) {
this.hosts = hosts;
return this;
}
public String getHostname() {
return hostname;
}
public ContainerSpec withHostname(String hostname) {
this.hostname = hostname;
return this;
}
public List getSecrets() {
return secrets;
}
public ContainerSpec withSecrets(List secrets) {
this.secrets = secrets;
return this;
}
public HealthCheck getHealthCheck() {
return healthCheck;
}
public ContainerSpec withHealthCheck(HealthCheck healthCheck) {
this.healthCheck = healthCheck;
return this;
}
public String getStopSignal() {
return stopSignal;
}
public ContainerSpec withStopSignal(String stopSignal) {
this.stopSignal = stopSignal;
return this;
}
public Long getStopGracePeriod() {
return stopGracePeriod;
}
public ContainerSpec withStopGracePeriod(Long stopGracePeriod) {
this.stopGracePeriod = stopGracePeriod;
return this;
}
public ContainerSpecPrivileges getPrivileges() {
return privileges;
}
public ContainerSpec withPrivileges(ContainerSpecPrivileges privileges) {
this.privileges = privileges;
return this;
}
public List getConfigs() {
return configs;
}
public ContainerSpec withConfigs(List configs) {
this.configs = configs;
return this;
}
}