com.fitbur.github.dockerjava.api.model.Event Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of external-docker-java Show documentation

There is a newer version: 1.0.0

package com.fitbur.github.dockerjava.api.model;

import com.fitbur.apache.com.fitburmons.lang.builder.ToStringBuilder;

import com.fitbur.fasterxml.jackson.annotation.JsonIgnoreProperties;

/**
 * Representation of a Docker event.
 */
@JsonIgnoreProperties(ignoreUnknown = true)
public class Event {
    private String status;

    private String id;

    private String from;

    private long time;

    @JsonIgnoreProperties
    private Node node;

    /**
     * Default constructor for the com.fitburserialization.
     */
    public Event() {
    }

    /**
     * Constructor.
     *
     * @param id
     *            Container ID
     * @param status
     *            Status string. List of statuses is available in Docker
     *            API v.1.16
     * @param from
     *            Image, from which the container has been created
     * @param time
     *            Event time The time is specified in milliseconds since January 1, 1970, 00:00:00 GMT
     * @since TODO
     */
    public Event(String status, String id, String from, long time) {
        this.status = status;
        this.id = id;
        this.from = from;
        this.time = time;
    }

    /**
     * Status of docker image or container. List of statuses is available in Docker API
     * v.1.16
     *
     * @return Status string
     */
    public String getStatus() {
        return status;
    }

    /**
     * Get ID of docker container.
     *
     * @return Container ID
     */
    public String getId() {
        return id;
    }

    /**
     * Get source image of the container.
     *
     * @return Name of the parent container
     */
    public String getFrom() {
        return from;
    }

    /**
     * Get the event time. The time is specified in milliseconds since January 1, 1970, 00:00:00 GMT
     *
     * @return Event time in the specified format.
     */
    public long getTime() {
        return time;
    }

    /**
     * Returns the node when working against docker swarm
     */
    public Node getNode() {
        return node;
    }

    @Override
    public String toString() {
        return ToStringBuilder.reflectionToString(this);
    }
}