com.spotify.docker.client

Class DockerClient.LogsParam

java.lang.Object

com.spotify.docker.client.DockerClient.LogsParam

Enclosing interface:

DockerClient

public static class DockerClient.LogsParam
extends Object

Parameters for DockerClient.logs(String, LogsParam...)

Constructor Summary

Constructors

Constructor and Description
LogsParam(String name, String value)

Method Summary

Modifier and Type	Method and Description
static DockerClient.LogsParam	create(String name, String value) Create a custom parameter.
static DockerClient.LogsParam	follow() Return stream.
static DockerClient.LogsParam	follow(boolean follow) Return stream.
String	name() Parameter name.
static DockerClient.LogsParam	since(Integer timestamp) Filter logs and only output entries since given Unix timestamp.
static DockerClient.LogsParam	stderr() Show stderr log.
static DockerClient.LogsParam	stderr(boolean stderr) Show stderr log.
static DockerClient.LogsParam	stdout() Show stdout log.
static DockerClient.LogsParam	stdout(boolean stdout) Show stdout log.
static DockerClient.LogsParam	tail(Integer lines) Output specified number of lines at the end of logs.
static DockerClient.LogsParam	timestamps() Print timestamp for every log line.
static DockerClient.LogsParam	timestamps(boolean timestamps) Print timestamp for every log line.
String	value() Parameter value.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogsParam

public LogsParam(String name,
                 String value)

Method Detail

name

public String name()

Parameter name.

Returns:

name of parameter

value

public String value()

Parameter value.

Returns:

value of parameter

follow

public static DockerClient.LogsParam follow()

Return stream.

Returns:

LogsParam

follow

public static DockerClient.LogsParam follow(boolean follow)

Return stream. Default false.

Parameters:

follow - Whether to return stream.

Returns:

LogsParam

stdout

public static DockerClient.LogsParam stdout()

Show stdout log.

Returns:

LogsParam

stdout

public static DockerClient.LogsParam stdout(boolean stdout)

Show stdout log. Default false.

Parameters:

stdout - Whether to show stdout log.

Returns:

LogsParam

stderr

public static DockerClient.LogsParam stderr()

Show stderr log.

Returns:

LogsParam

stderr

public static DockerClient.LogsParam stderr(boolean stderr)

Show stderr log. Default false.

Parameters:

stderr - Whether to show stderr log.

Returns:

LogsParam

since

public static DockerClient.LogsParam since(Integer timestamp)

Filter logs and only output entries since given Unix timestamp. Only available in Docker API >= 1.19.

Parameters:

timestamp - Only output entries since timestamp.

Returns:

LogsParam

timestamps

public static DockerClient.LogsParam timestamps()

Print timestamp for every log line.

Returns:

LogsParam

timestamps

public static DockerClient.LogsParam timestamps(boolean timestamps)

Print timestamp for every log line. Default false.

Parameters:

timestamps - Whether to print timestamp for every log line.

Returns:

LogsParam

tail

public static DockerClient.LogsParam tail(Integer lines)

Output specified number of lines at the end of logs.

Parameters:

lines - Number of lines to output at the end of logs.

Returns:

LogsParam

create

public static DockerClient.LogsParam create(String name,
                                            String value)

Create a custom parameter.

Parameters:

name - custom name

value - custom value

Returns:

LogsParam