com.github.dockerjava.api.command.RestartContainerCmd 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 javax.annotation.CheckForNull;
import javax.annotation.Nonnull;

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

/**
 * Restart a running container.
 *
 * @param timeout
 *            - Timeout in seconds before killing the container. Defaults to 10 seconds.
 *
 */
public interface RestartContainerCmd extends SyncDockerCmd {

    @CheckForNull
    String getContainerId();

    @CheckForNull
    Integer getTimeout();

    RestartContainerCmd withContainerId(@Nonnull String containerId);

    /**
     * @deprecated wrong name, use {@link #withTimeout(Integer)}
     */
    @Deprecated
    default RestartContainerCmd withtTimeout(Integer timeout) {
        return withTimeout(timeout);
    }

    RestartContainerCmd withTimeout(Integer timeout);

    /**
     * @throws NotFoundException
     *             No such container
     */
    @Override
    Void exec() throws NotFoundException;

    interface Exec extends DockerCmdSyncExec {
    }

}