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

package com.github.dockerjava.api.command;

import java.util.List;
import java.util.Map;
import java.util.stream.Stream;

import javax.annotation.CheckForNull;

import com.github.dockerjava.api.model.Event;
import com.github.dockerjava.api.model.EventType;

/**
 * Get events
 */
public interface EventsCmd extends AsyncDockerCmd {

    @CheckForNull
    Map> getFilters();

    @CheckForNull
    String getSince();

    @CheckForNull
    String getUntil();

    /**
     * @param container
     *            - container to filter
     */
    EventsCmd withContainerFilter(String... container);

    /**
     * @param event
     *            - event to filter (pull | create | attach | start | stop | kill)
     */
    EventsCmd withEventFilter(String... event);

    /**
     * @param eventTypes event types to filter
     */
    EventsCmd withEventTypeFilter(String... eventTypes);

    /**
     * This provides a type safe version of {@link #withEventTypeFilter(String...)}.
     *
     * @param eventTypes event types to filter
     */
    default EventsCmd withEventTypeFilter(EventType... eventTypes) {
        return withEventTypeFilter(
            Stream.of(eventTypes)
                .map(EventType::getValue)
                .toArray(String[]::new)
        );
    }

    /**
     * @param image
     *            - image to filter
     */
    EventsCmd withImageFilter(String... image);

    /**
     * @param label
     *            - label to filter
     */
    EventsCmd withLabelFilter(String... label);

    /**
     * @param labels
     *            - labels to filter (map of names and values)
     */
    EventsCmd withLabelFilter(Map labels);

    /**
     * @param since
     *            - Show all events created since timestamp
     */
    EventsCmd withSince(String since);

    /**
     * @param until
     *            - Show all events created until timestamp
     */
    EventsCmd withUntil(String until);

    interface Exec extends DockerCmdAsyncExec {
    }
}