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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of docker-java Show documentation

Java API Client for Docker

There is a newer version: 3.4.1

package com.github.dockerjava.api.command;

import com.github.dockerjava.api.NotFoundException;
import com.github.dockerjava.api.NotModifiedException;

/**
 * Stop a running container.
 *
 * @param containerId - Id of the container
 * @param timeout - Timeout in seconds before killing the container. Defaults to 10 seconds.
 *
 */
public interface StopContainerCmd extends DockerCmd {

	public String getContainerId();

	public int getTimeout();

	public StopContainerCmd withContainerId(String containerId);

	public StopContainerCmd withTimeout(int timeout);

	/**
	 * @throws NotFoundException No such container
	 * @throws NotModifiedException Container already stopped
	 */
	@Override
	public Void exec() throws NotFoundException, NotModifiedException;
	
	public static interface Exec extends DockerCmdExec {
	}

}