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

Go to download
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.model.AuthConfigurations;
import com.github.dockerjava.api.model.BuildResponseItem;

import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import java.io.File;
import java.io.InputStream;
import java.net.URI;
import java.util.Map;
import java.util.Set;

/**
 * Build an image from Dockerfile.
 * 
 * TODO: http://docs.docker.com/reference/builder/#dockerignore
 *
 * @see build-image-from-a-dockerfile
 */
public interface BuildImageCmd extends AsyncDockerCmd {

    // lib specific

    @CheckForNull
    InputStream getTarInputStream();

    @CheckForNull
    AuthConfigurations getBuildAuthConfigs();

    // getters

    /**
     * "t" in API
     *
     * @deprecated since docker API version 1.21 there can be multiple tags
     * specified so use {@link #getTags()}
     */
    @CheckForNull
    @Deprecated
    String getTag();

    /**
     * Multple "t" tags.
     *
     * @since {@link RemoteApiVersion#VERSION_1_21}
     */
    @CheckForNull
    Set getTags();

    /**
     * "Cache-from" in API
     */
    @CheckForNull
    Set getCacheFrom();

    /**
     * "remote" in API
     */
    @CheckForNull
    URI getRemote();

    /**
     * "nocache" in API
     */
    @CheckForNull
    Boolean hasNoCacheEnabled();

    /**
     * "rm" in API
     */
    @CheckForNull
    Boolean hasRemoveEnabled();

    /**
     * "forcerm" in API
     */
    @CheckForNull
    Boolean isForcerm();

    /**
     * "q" in API
     */
    @CheckForNull
    Boolean isQuiet();

    /**
     * "pull" in API
     */
    @CheckForNull
    Boolean hasPullEnabled();

    @CheckForNull
    String getPathToDockerfile();

    @CheckForNull
    Long getMemory();

    @CheckForNull
    Long getMemswap();

    @CheckForNull
    String getCpushares();

    @CheckForNull
    String getCpusetcpus();

    /**
     * @since {@link RemoteApiVersion#VERSION_1_21}
     */
    @CheckForNull
    Map getBuildArgs();

    /**
     * @since {@link RemoteApiVersion#VERSION_1_22}
     */
    @CheckForNull
    Long getShmsize();

    /**
     * @since {@link RemoteApiVersion#VERSION_1_23}
     */
    @CheckForNull
    Map getLabels();

    /**
     * @since {@link RemoteApiVersion#VERSION_1_25}
     */
    @CheckForNull
    String getNetworkMode();

    /**
     * "platform" in API
     *
     * @since {@link RemoteApiVersion#VERSION_1_32}
     */
    @CheckForNull
    String getPlatform();

    /**
     * @since {@link RemoteApiVersion#VERSION_1_38}
     */
    @CheckForNull
    String getTarget();

    /**
     * @since {@link RemoteApiVersion#VERSION_1_28}
     */
    @CheckForNull
    Set getExtraHosts();

    // setters

    /**
     * @deprecated since docker API version 1.21 there can be multiple tags
     * specified so use {@link BuildImageCmd#withTags(java.util.Set)}
     */
    @Deprecated
    BuildImageCmd withTag(String tag);

    BuildImageCmd withTags(Set tags);

    /*
     * @since {@link RemoteApiVersion#VERSION_1_25}
     */
    BuildImageCmd withCacheFrom(Set cacheFrom);

    BuildImageCmd withRemote(URI remote);

    BuildImageCmd withBaseDirectory(File baseDirectory);

    BuildImageCmd withDockerfile(File dockerfile);

    BuildImageCmd withDockerfilePath(String dockerfilePath);

    BuildImageCmd withNoCache(Boolean noCache);

    BuildImageCmd withRemove(Boolean rm);

    BuildImageCmd withForcerm(Boolean forcerm);

    BuildImageCmd withQuiet(Boolean quiet);

    BuildImageCmd withPull(Boolean pull);

    BuildImageCmd withMemory(Long memory);

    BuildImageCmd withMemswap(Long memswap);

    BuildImageCmd withCpushares(String cpushares);

    BuildImageCmd withCpusetcpus(String cpusetcpus);

    /**
     * @since {@link RemoteApiVersion#VERSION_1_21}
     */
    BuildImageCmd withBuildArg(String key, String value);

    // setters lib specific

    BuildImageCmd withBuildAuthConfigs(AuthConfigurations authConfig);

    BuildImageCmd withTarInputStream(@Nonnull InputStream tarInputStream);

    /**
     * @since {@link RemoteApiVersion#VERSION_1_22}
     */
    BuildImageCmd withShmsize(Long shmsize);

    /**
     * @since {@link RemoteApiVersion#VERSION_1_23}
     */
    BuildImageCmd withLabels(Map labels);

    /**
     * @since {@link RemoteApiVersion#VERSION_1_25}
     */
    BuildImageCmd withNetworkMode(String networkMode);

    /**
     *@since {@link RemoteApiVersion#VERSION_1_32}
     */
    BuildImageCmd withPlatform(String platform);

    /**
     * @since {@link RemoteApiVersion#VERSION_1_38}
     */
    BuildImageCmd withTarget(String target);

    /**
     * @since {@link RemoteApiVersion#VERSION_1_28}
     */
    BuildImageCmd withExtraHosts(Set extraHosts);

    @Override
    default BuildImageResultCallback start() {
        return exec(new BuildImageResultCallback());
    }

    interface Exec extends DockerCmdAsyncExec {
    }

}