com.github.dockerjava.api.model

Class RestartPolicy

java.lang.Object

com.github.dockerjava.api.model.DockerObject

com.github.dockerjava.api.model.RestartPolicy

All Implemented Interfaces:

Serializable

public class RestartPolicy
extends DockerObject
implements Serializable

Container restart policy

no

Do not restart the container if it dies. (default)

on-failure

Restart the container if it exits with a non-zero exit code. Can also accept an optional maximum restart count (e.g. on-failure:5).

always

Always restart the container no matter what exit code is returned.

Author:

Marcus Linke

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RestartPolicy()

Method Summary

Modifier and Type	Method and Description
static RestartPolicy	alwaysRestart() Always restart the container no matter what exit code is returned.
Integer	getMaximumRetryCount()
String	getName()
static RestartPolicy	noRestart() Do not restart the container if it dies.
static RestartPolicy	onFailureRestart(int maximumRetryCount) Restart the container if it exits with a non-zero exit code.
static RestartPolicy	parse(String serialized) Parses a textual restart polixy specification (as used by the Docker CLI) to a RestartPolicy.
String	toString() Returns a string representation of this RestartPolicy.
static RestartPolicy	unlessStoppedRestart() Restart the container unless it has been stopped

Methods inherited from class com.github.dockerjava.api.model.DockerObject

getRawValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RestartPolicy

public RestartPolicy()

Method Detail

noRestart

public static RestartPolicy noRestart()

Do not restart the container if it dies. (default)

alwaysRestart

public static RestartPolicy alwaysRestart()

Always restart the container no matter what exit code is returned.

onFailureRestart

public static RestartPolicy onFailureRestart(int maximumRetryCount)

Restart the container if it exits with a non-zero exit code.

Parameters:

maximumRetryCount - the maximum number of restarts. Set to 0 for unlimited retries.

unlessStoppedRestart

public static RestartPolicy unlessStoppedRestart()

Restart the container unless it has been stopped

getMaximumRetryCount

public Integer getMaximumRetryCount()

getName

public String getName()

parse

public static RestartPolicy parse(String serialized)
                           throws IllegalArgumentException

Parses a textual restart polixy specification (as used by the Docker CLI) to a RestartPolicy.

Parameters:

serialized - the specification, e.g. on-failure:2

Returns:

a RestartPolicy matching the specification

Throws:

IllegalArgumentException - if the specification cannot be parsed

toString

public String toString()

Returns a string representation of this RestartPolicy. The format is name[:count], like the argument in parse(String).

Overrides:

toString in class Object

Returns:

a string representation of this RestartPolicy