Package com.spotify.docker.client

Class DockerClient.EventsParam

java.lang.Object

com.spotify.docker.client.DockerClient.Param

com.spotify.docker.client.DockerClient.EventsParam

Direct Known Subclasses:

DockerClient.EventsFilterParam

Enclosing interface:

DockerClient

public static class DockerClient.EventsParam
extends DockerClient.Param

Parameters for DockerClient.events(EventsParam...)

Constructor Summary

Constructors

Modifier	Constructor	Description
private	EventsParam(java.lang.String name, java.lang.String value)

Method Summary

Modifier and Type	Method	Description
static DockerClient.EventsParam	container(java.lang.String container)	Show events for a container.
static DockerClient.EventsParam	daemon(java.lang.String daemon)	Show events for a daemon.
static DockerClient.EventsParam	event(java.lang.String event)	Show only certain events.
private static DockerClient.EventsParam	filter(java.lang.String name, java.lang.String value)	Apply filters to the returned events.
static DockerClient.EventsParam	image(java.lang.String image)	Show events for an image.
static DockerClient.EventsParam	label(java.lang.String label)	Show events with a label value.
static DockerClient.EventsParam	label(java.lang.String label, java.lang.String value)	Show events with a label value.
static DockerClient.EventsParam	network(java.lang.String network)	Show events for a network.
static DockerClient.EventsParam	plugin(java.lang.String plugin)	Show events for a plugin.
static DockerClient.EventsParam	scope(java.lang.String scope)	Show events for a scope: "local" or "swarm"
static DockerClient.EventsParam	since(java.lang.Long since)	Filter events since the given timestamp
static DockerClient.EventsParam	type(Event.Type type)	Show events of a given type.
static DockerClient.EventsParam	type(java.lang.String type)	Deprecated. Use type(Event.Type).
static DockerClient.EventsParam	until(java.lang.Long until)	Filter events until the given timestamp
static DockerClient.EventsParam	volume(java.lang.String volume)	Show events for a volume.

Methods inherited from class com.spotify.docker.client.DockerClient.Param

equals, hashCode, name, value

Methods inherited from class java.lang.Object

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

Constructor Detail

EventsParam

private EventsParam(java.lang.String name,
                    java.lang.String value)

Method Detail

until

public static DockerClient.EventsParam until(java.lang.Long until)

Filter events until the given timestamp

Parameters:

until - Return events up until this Unix timestamp.

Returns:

DockerClient.EventsParam

Since:

API 1.18

since

public static DockerClient.EventsParam since(java.lang.Long since)

Filter events since the given timestamp

Parameters:

since - Return events since this Unix timestamp.

Returns:

DockerClient.EventsParam

Since:

API 1.18

filter

private static DockerClient.EventsParam filter(java.lang.String name,
                                               java.lang.String value)

Apply filters to the returned events.

Parameters:

name - Name

value - Value

Returns:

DockerClient.EventsParam

Since:

API 1.18

event

public static DockerClient.EventsParam event(java.lang.String event)

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

Parameters:

event - Type of event to show

Returns:

EventsParam

Since:

API 1.18

image

public static DockerClient.EventsParam image(java.lang.String image)

Show events for an image.

Parameters:

image - An image tag or id

Returns:

EventsParam

Since:

API 1.18

container

public static DockerClient.EventsParam container(java.lang.String container)

Show events for a container.

Parameters:

container - A container name or id

Returns:

EventsParam

Since:

API 1.18

volume

public static DockerClient.EventsParam volume(java.lang.String volume)

Show events for a volume.

Parameters:

volume - A volume name or id

Returns:

EventsParam

Since:

API 1.22

network

public static DockerClient.EventsParam network(java.lang.String network)

Show events for a network.

Parameters:

network - A network name or id

Returns:

EventsParam

Since:

API 1.22

daemon

public static DockerClient.EventsParam daemon(java.lang.String daemon)

Show events for a daemon.

Parameters:

daemon - A daemon name or id

Returns:

EventsParam

Since:

API 1.24

type

@Deprecated
public static DockerClient.EventsParam type(java.lang.String type)

Deprecated.

Use type(Event.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

Since:

API 1.22

type

public static DockerClient.EventsParam type(Event.Type 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

Since:

API 1.22

label

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

Show events with a label value.

Parameters:

label - The label to filter on

value - The value of the label

Returns:

EventsParam

Since:

API 1.21

label

public static DockerClient.EventsParam label(java.lang.String label)

Show events with a label value.

Parameters:

label - The label to filter on

Returns:

EventsParam

Since:

API 1.21

plugin

public static DockerClient.EventsParam plugin(java.lang.String plugin)

Show events for a plugin.

Parameters:

plugin - A plugin name or id

Returns:

EventsParam

Since:

API 1.30

scope

public static DockerClient.EventsParam scope(java.lang.String scope)

Show events for a scope: "local" or "swarm"

Parameters:

scope - "local" or "swarm"

Returns:

EventsParam

Since:

API 1.30