com.spotify.docker.client

Class DockerClient.EventsParam

java.lang.Object

com.spotify.docker.client.DockerClient.EventsParam

Direct Known Subclasses:

DockerClient.EventsFilterParam

Enclosing interface:

DockerClient

public static class DockerClient.EventsParam
extends Object

Parameters for DockerClient.events(EventsParam...)

Method Summary

Modifier and Type	Method and Description
static DockerClient.EventsParam	container(String container) Show events for a container.
static DockerClient.EventsParam	daemon(String daemon) Show events for a daemon.
static DockerClient.EventsParam	event(String event) Show only certain events.
static DockerClient.EventsParam	image(String image) Show events for an image.
static DockerClient.EventsParam	label(String label) Show events with a label value.
static DockerClient.EventsParam	label(String label, String value) Show events with a label value.
String	name() Parameter name.
static DockerClient.EventsParam	network(String network) Show events for a network.
static DockerClient.EventsParam	since(Long since) Filter events since the given timestamp
static DockerClient.EventsParam	type(String type) Show events of a given type.
static DockerClient.EventsParam	until(Long until) Filter events until the given timestamp
String	value() Parameter value.
static DockerClient.EventsParam	volume(String volume) Show events for a volume.

Methods inherited from class java.lang.Object

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

Method Detail

name

public String name()

Parameter name.

Returns:

The name

value

public String value()

Parameter value.

Returns:

The value

until

public static DockerClient.EventsParam until(Long until)

Filter events until the given timestamp

Parameters:

until - Return events up until this Unix timestamp.

Returns:

DockerClient.EventsParam

since

public static DockerClient.EventsParam since(Long since)

Filter events since the given timestamp

Parameters:

since - Return events since this Unix timestamp.

Returns:

DockerClient.EventsParam

event

public static DockerClient.EventsParam event(String event)

Show only certain events. For example, "event=pull" for image pull events.

Parameters:

event - Type of event to show

Returns:

EventsParam

image

public static DockerClient.EventsParam image(String image)

Show events for an image.

Parameters:

image - An image tag or id

Returns:

EventsParam

container

public static DockerClient.EventsParam container(String container)

Show events for a container.

Parameters:

container - A container name or id

Returns:

EventsParam

volume

public static DockerClient.EventsParam volume(String volume)

Show events for a volume.

Parameters:

volume - A volume name or id

Returns:

EventsParam

network

public static DockerClient.EventsParam network(String network)

Show events for a network.

Parameters:

network - A network name or id

Returns:

EventsParam

daemon

public static DockerClient.EventsParam daemon(String daemon)

Show events for a daemon.

Parameters:

daemon - A daemon name or id

Returns:

EventsParam

type

public static DockerClient.EventsParam type(String type)

Show events of a given type. For instance, "type=image" for all image events.

Parameters:

type - A type of event. Possible values: container, image, volume, network, or daemon

Returns:

EventsParam

label

public static DockerClient.EventsParam label(String label,
                                             String value)

Show events with a label value.

Parameters:

label - The label to filter on

value - The value of the label

Returns:

EventsParam

label

public static DockerClient.EventsParam label(String label)

Show events with a label value.

Parameters:

label - The label to filter on

Returns:

EventsParam