Module com.oracle.bedrock.runtime.docker
Package com.oracle.bedrock.runtime.docker.commands

Class Events

  • All Implemented Interfaces:
    com.oracle.bedrock.runtime.MetaClass<com.oracle.bedrock.runtime.Application>
    public class Events
extends AbstractDockerCommand<Events>
    A representation of the Docker events command.

    Instances of Events are immutable, methods that add options and configuration to this Events command return a new instance of a Events command with the modifications applied.

    Copyright (c) 2016. All Rights Reserved. Oracle Corporation.
    Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

    Author:
    Jonathan Knight

    • Method Detail

      • filter

        public Events filter​(Object... filters)
        Filter the event output (equates to the --filter argument).
        Parameters:
        filters - values that resolve to one or more valid filter arguments
        Returns:
        a new Events instance that is the same as this instance with the --filter option applied

      • since

        public Events since​(Object timestamp)
        Show events since timestamp (equates to the --since argument).
        Parameters:
        timestamp - a value that resolves to the timestamp to use to determine the events to show
        Returns:
        a new Events instance that is the same as this instance with the --since option applied

      • until

        public Events until​(Object timestamp)
        Show events until timestamp (equates to the --until argument).
        Parameters:
        timestamp - a value that resolves to the timestamp to use to determine the events to show
        Returns:
        a new Events instance that is the same as this instance with the --until option applied

      • fromContainer

        public static Events fromContainer​(Object containerName)
        Create a Events command to view the events from a specific container.
        Parameters:
        containerName - the container to view the events for
        Returns:
        a Events command to view the events from a specific container

      • all

        public static Events all()
        Create a Events command to view Docker events.
        Returns:
        a Events command to view Docker events

      • withCommandArguments

        public Events withCommandArguments​(com.oracle.bedrock.runtime.options.Argument... args)
        Description copied from class: AbstractDockerCommand
        Obtain a copy of this AbstractDockerCommand with the addition of the specified command arguments Arguments.

        Command arguments in Docker come after the command name on the command line, e.g. docker [options...] COMMAND_NAME [args...] Parts of the Docker documentation that refer to these parameters as both arguments and options. In our case we refer to them as arguments and the are applied after the command name on the command line.

        Specified by:
        withCommandArguments in class AbstractDockerCommand<Events>
        Parameters:
        args - the additional Arguments
        Returns:
        a copy of this AbstractDockerCommand with the addition of the specified Arguments

      • withoutCommandArguments

        public Events withoutCommandArguments​(com.oracle.bedrock.runtime.options.Argument... args)
        Description copied from class: AbstractDockerCommand
        Obtain a copy of this AbstractDockerCommand without the specified command arguments Arguments.

        Command arguments in Docker come after the command name on the command line, e.g. docker [options...] COMMAND_NAME [args...] Parts of the Docker documentation that refer to these parameters as both arguments and options. In our case we refer to them as arguments and the are applied after the command name on the command line.

        Specified by:
        withoutCommandArguments in class AbstractDockerCommand<Events>
        Parameters:
        args - the additional Arguments
        Returns:
        a copy of this AbstractDockerCommand without the specified Arguments