com.github.dockerjava.api.command.CreateContainerCmd Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of docker-java-api Show documentation
Java API Client for Docker
There is a newer version: 3.4.0
package com.github.dockerjava.api.command;

import com.github.dockerjava.api.exception.ConflictException;
import com.github.dockerjava.api.exception.NotFoundException;
import com.github.dockerjava.api.model.AuthConfig;
import com.github.dockerjava.api.model.Bind;
import com.github.dockerjava.api.model.Capability;
import com.github.dockerjava.api.model.Device;
import com.github.dockerjava.api.model.ExposedPort;
import com.github.dockerjava.api.model.HealthCheck;
import com.github.dockerjava.api.model.HostConfig;
import com.github.dockerjava.api.model.Link;
import com.github.dockerjava.api.model.LogConfig;
import com.github.dockerjava.api.model.LxcConf;
import com.github.dockerjava.api.model.PortBinding;
import com.github.dockerjava.api.model.Ports;
import com.github.dockerjava.api.model.RestartPolicy;
import com.github.dockerjava.api.model.Ulimit;
import com.github.dockerjava.api.model.Volume;
import com.github.dockerjava.api.model.VolumesFrom;

import javax.annotation.CheckForNull;
import java.util.List;
import java.util.Map;

public interface CreateContainerCmd extends SyncDockerCmd {

    @CheckForNull
    AuthConfig getAuthConfig();

    /**
     * While using swarm classic, you can provide an optional auth config which will be used to pull images from a private registry,
     * if the swarm node does not already have the docker image.
     * Note: This option does not have any effect in normal docker
     *
     * @param authConfig The optional auth config
     */
    CreateContainerCmd withAuthConfig(AuthConfig authConfig);

    @CheckForNull
    List getAliases();

    @Deprecated
    @CheckForNull
    Bind[] getBinds();

    @Deprecated
    CreateContainerCmd withBinds(Bind... binds);

    @Deprecated
    CreateContainerCmd withBinds(List binds);

    /**
     * Add network-scoped alias for the container
     *
     * @param aliases on ore more aliases
     */
    CreateContainerCmd withAliases(List aliases);

    /**
     * Add network-scoped alias for the container
     *
     * @param aliases on ore more aliases
     */
    CreateContainerCmd withAliases(String... aliases);

    @CheckForNull
    String[] getCmd();

    CreateContainerCmd withCmd(String... cmd);

    CreateContainerCmd withCmd(List cmd);

    @CheckForNull
    HealthCheck getHealthcheck();

    CreateContainerCmd withHealthcheck(HealthCheck healthCheck);

    @CheckForNull
    Boolean getArgsEscaped();

    CreateContainerCmd withArgsEscaped(Boolean argsEscaped);

    @CheckForNull
    String getDomainName();

    CreateContainerCmd withDomainName(String domainName);

    @CheckForNull
    String[] getEntrypoint();

    CreateContainerCmd withEntrypoint(String... entrypoint);

    CreateContainerCmd withEntrypoint(List entrypoint);

    @CheckForNull
    String[] getEnv();

    /**
     * Adds environment-variables. NB: Not additive, i.e. in case of multiple calls to the method, only the most recent
     * values will be injected. Prior env-variables will be deleted.
     *
     * @param env the String(s) to set as ENV in the container
     */
    CreateContainerCmd withEnv(String... env);

    /**
     * Adds environment-variables. NB: Not additive, i.e. in case of multiple calls to the method, only the most recent
     * values will be injected. Prior env-variables will be deleted.
     *
     * @param env the list of Strings to set as ENV in the container
     */
    CreateContainerCmd withEnv(List env);

    @CheckForNull
    ExposedPort[] getExposedPorts();

    CreateContainerCmd withExposedPorts(List exposedPorts);

    CreateContainerCmd withExposedPorts(ExposedPort... exposedPorts);

    @CheckForNull
    String getStopSignal();

    CreateContainerCmd withStopSignal(String stopSignal);

    @CheckForNull
    Integer getStopTimeout();

    CreateContainerCmd withStopTimeout(Integer stopTimeout);

    @CheckForNull
    String getHostName();

    CreateContainerCmd withHostName(String hostName);

    @CheckForNull
    String getImage();

    CreateContainerCmd withImage(String image);

    @CheckForNull
    String getIpv4Address();

    CreateContainerCmd withIpv4Address(String ipv4Address);

    @Deprecated
    @CheckForNull
    Link[] getLinks();

    /**
     * Add link to another container.
     */
    @Deprecated
    CreateContainerCmd withLinks(Link... links);

    /**
     * Add link to another container.
     */
    @Deprecated
    CreateContainerCmd withLinks(List links);

    @CheckForNull
    String getIpv6Address();

    CreateContainerCmd withIpv6Address(String ipv6Address);

    @CheckForNull
    Map getLabels();

    CreateContainerCmd withLabels(Map labels);

    @CheckForNull
    String getMacAddress();

    CreateContainerCmd withMacAddress(String macAddress);

    @Deprecated
    @CheckForNull
    Long getMemory();

    @Deprecated
    CreateContainerCmd withMemory(Long memory);

    @Deprecated
    @CheckForNull
    Long getMemorySwap();

    @Deprecated
    CreateContainerCmd withMemorySwap(Long memorySwap);

    @CheckForNull
    String getName();

    @Deprecated
    @CheckForNull
    String getNetworkMode();

    /**
     * Set the Network mode for the container
     * 
     * 'bridge': creates a new network stack for the container on the docker bridge
     * 'none': no networking for this container
     * 'container:': reuses another container network stack
     * 'host': use the host network stack inside the container. Note: the host mode gives the container full access to local system
     * services such as D-bus and is therefore considered insecure.
     * 
     */
    @Deprecated
    CreateContainerCmd withNetworkMode(String networkMode);

    @Deprecated
    @CheckForNull
    Ports getPortBindings();

    /**
     * Add one or more {@link PortBinding}s. This corresponds to the --publish (-p) option of the
     * docker run CLI command.
     */
    @Deprecated
    CreateContainerCmd withPortBindings(PortBinding... portBindings);

    /**
     * Add one or more {@link PortBinding}s. This corresponds to the --publish (-p) option of the
     * docker run CLI command.
     */
    @Deprecated
    CreateContainerCmd withPortBindings(List portBindings);

    /**
     * Add the port bindings that are contained in the given {@link Ports} object.
     *
     * @see #withPortBindings(PortBinding...)
     */
    @Deprecated
    CreateContainerCmd withPortBindings(Ports portBindings);

    CreateContainerCmd withName(String name);

    @CheckForNull
    String[] getPortSpecs();

    CreateContainerCmd withPortSpecs(String... portSpecs);

    CreateContainerCmd withPortSpecs(List portSpecs);

    @Deprecated
    @CheckForNull
    Boolean getPrivileged();

    @Deprecated
    CreateContainerCmd withPrivileged(Boolean privileged);

    @CheckForNull
    String getUser();

    CreateContainerCmd withUser(String user);

    @CheckForNull
    Volume[] getVolumes();

    CreateContainerCmd withVolumes(Volume... volumes);

    CreateContainerCmd withVolumes(List volumes);

    @Deprecated
    @CheckForNull
    VolumesFrom[] getVolumesFrom();

    @Deprecated
    CreateContainerCmd withVolumesFrom(VolumesFrom... volumesFrom);

    @Deprecated
    CreateContainerCmd withVolumesFrom(List volumesFrom);

    @CheckForNull
    String getWorkingDir();

    CreateContainerCmd withWorkingDir(String workingDir);

    @CheckForNull
    Boolean isAttachStderr();

    CreateContainerCmd withAttachStderr(Boolean attachStderr);

    @CheckForNull
    Boolean isAttachStdin();

    CreateContainerCmd withAttachStdin(Boolean attachStdin);

    @CheckForNull
    Boolean isAttachStdout();

    CreateContainerCmd withAttachStdout(Boolean attachStdout);

    @CheckForNull
    Boolean isNetworkDisabled();

    CreateContainerCmd withNetworkDisabled(Boolean disableNetwork);

    @CheckForNull
    Boolean isStdInOnce();

    CreateContainerCmd withStdInOnce(Boolean stdInOnce);

    @CheckForNull
    Boolean isStdinOpen();

    CreateContainerCmd withStdinOpen(Boolean stdinOpen);

    @CheckForNull
    Boolean isTty();

    CreateContainerCmd withTty(Boolean tty);

    @Deprecated
    @CheckForNull
    Boolean getPublishAllPorts();

    @Deprecated
    CreateContainerCmd withPublishAllPorts(Boolean publishAllPorts);

    @CheckForNull
    @Deprecated
    String[] getExtraHosts();

    /**
     * Add hostnames to /etc/hosts in the container
     */
    @Deprecated
    CreateContainerCmd withExtraHosts(String... extraHosts);

    /**
     * Add hostnames to /etc/hosts in the container
     */
    @Deprecated
    CreateContainerCmd withExtraHosts(List extraHosts);

    @CheckForNull
    @Deprecated
    Capability[] getCapAdd();

    /**
     * Add linux kernel capability to the container. For example:
     * adding {@link Capability#MKNOD} allows the container to create special files using the 'mknod' command.
     */
    @Deprecated
    CreateContainerCmd withCapAdd(Capability... capAdd);

    /**
     * Add linux kernel capability to the container. For example:
     * adding {@link Capability#MKNOD} allows the container to create special files using the 'mknod' command.
     */
    @Deprecated
    CreateContainerCmd withCapAdd(List capAdd);

    @CheckForNull
    @Deprecated
    Capability[] getCapDrop();

    /**
     * Drop linux kernel capability from the container. For example:
     * dropping {@link Capability#CHOWN} prevents the container from changing the owner of any files.
     */
    @Deprecated
    CreateContainerCmd withCapDrop(Capability... capDrop);

    /**
     * Drop linux kernel capability from the container. For example:
     * dropping {@link Capability#CHOWN} prevents the container from changing the owner of any files.
     */
    @Deprecated
    CreateContainerCmd withCapDrop(List capDrop);


    @CheckForNull
    List getOnBuild();

    CreateContainerCmd withOnBuild(List onBuild);

    @CheckForNull
    HostConfig getHostConfig();

    CreateContainerCmd withHostConfig(HostConfig hostConfig);

    // The following methods are deprecated and should be set on {@link #getHostConfig()} instead.
    // TODO remove in the next big release

    @Deprecated
    @CheckForNull
    Integer getBlkioWeight();

    @CheckForNull
    @Deprecated
    String getCgroupParent();

    @Deprecated
    @CheckForNull
    Integer getCpuPeriod();

    @Deprecated
    @CheckForNull
    Integer getCpuShares();

    @Deprecated
    @CheckForNull
    String getCpusetCpus();

    @Deprecated
    @CheckForNull
    String getCpusetMems();

    @Deprecated
    @CheckForNull
    Device[] getDevices();

    @Deprecated
    @CheckForNull
    String[] getDns();

    @Deprecated
    @CheckForNull
    String[] getDnsSearch();

    @Deprecated
    @CheckForNull
    LogConfig getLogConfig();

    @Deprecated
    @CheckForNull
    LxcConf[] getLxcConf();

    @Deprecated
    @CheckForNull
    Boolean getOomKillDisable();

    @Deprecated
    @CheckForNull
    String getPidMode();

    @Deprecated
    @CheckForNull
    Boolean getReadonlyRootfs();

    @Deprecated
    @CheckForNull
    RestartPolicy getRestartPolicy();

    @Deprecated
    @CheckForNull
    Ulimit[] getUlimits();

    @Deprecated
    CreateContainerCmd withBlkioWeight(Integer blkioWeight);

    @Deprecated
    CreateContainerCmd withCgroupParent(String cgroupParent);

    @Deprecated
    CreateContainerCmd withContainerIDFile(String containerIDFile);

    @Deprecated
    CreateContainerCmd withCpuPeriod(Integer cpuPeriod);

    @Deprecated
    CreateContainerCmd withCpuShares(Integer cpuShares);

    @Deprecated
    CreateContainerCmd withCpusetCpus(String cpusetCpus);

    @Deprecated
    CreateContainerCmd withCpusetMems(String cpusetMems);

    @Deprecated
    CreateContainerCmd withDevices(Device... devices);

    /**
     * Add host devices to the container
     */
    @Deprecated
    CreateContainerCmd withDevices(List devices);

    /**
     * Set custom DNS servers
     */
    @Deprecated
    CreateContainerCmd withDns(String... dns);

    /**
     * Set custom DNS servers
     */
    @Deprecated
    CreateContainerCmd withDns(List dns);

    /**
     * Set custom DNS search domains
     */
    @Deprecated
    CreateContainerCmd withDnsSearch(String... dnsSearch);

    /**
     * Set custom DNS search domains
     */
    @Deprecated
    CreateContainerCmd withDnsSearch(List dnsSearch);

    @Deprecated
    CreateContainerCmd withLogConfig(LogConfig logConfig);

    @Deprecated
    CreateContainerCmd withLxcConf(LxcConf... lxcConf);

    @Deprecated
    CreateContainerCmd withLxcConf(List lxcConf);

    @Deprecated
    CreateContainerCmd withOomKillDisable(Boolean oomKillDisable);

    /**
     * Set the PID (Process) Namespace mode for the container, 'host': use the host's PID namespace inside the container
     */
    @Deprecated
    CreateContainerCmd withPidMode(String pidMode);

    @Deprecated
    CreateContainerCmd withReadonlyRootfs(Boolean readonlyRootfs);

    /**
     * Set custom {@link RestartPolicy} for the container. Defaults to {@link RestartPolicy#noRestart()}
     */
    @Deprecated
    CreateContainerCmd withRestartPolicy(RestartPolicy restartPolicy);

    @Deprecated
    CreateContainerCmd withUlimits(Ulimit... ulimits);

    @Deprecated
    CreateContainerCmd withUlimits(List ulimits);

    /**
     * @throws NotFoundException No such container
     * @throws ConflictException Named container already exists
     */
    @Override
    CreateContainerResponse exec() throws NotFoundException, ConflictException;

    interface Exec extends DockerCmdSyncExec {
    }
}