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

Go to download
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 signal  - Signal to send to the container as an integer or string (e.g. SIGINT).
 * @param timeout - Timeout in seconds before killing the container. Defaults to 10 seconds.
 */
public interface RestartContainerCmd extends SyncDockerCmd {

    @CheckForNull
    String getContainerId();

    @CheckForNull
    Integer getTimeout();

    /**
     * @since {@link com.github.dockerjava.core.RemoteApiVersion#VERSION_1_42}
     */
    @CheckForNull
    String getSignal();

    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);

    RestartContainerCmd withSignal(String signal);

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

    interface Exec extends DockerCmdSyncExec {
    }

}