com.synedge.oss.client.StatusClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of synedge-java-client Show documentation

This client allows you to easily connect to the Synedge API with any language running on the JDK

The newest version!

package com.synedge.oss.client;

import com.synedge.oss.client.status.Incident;
import com.synedge.oss.client.status.StatusSystem;

import java.util.List;

/**
 * Client for getting the status of the system
 * @author Paul van Assen
 */
public interface StatusClient {
    /**
     * Get a list of all systems of the SynEdge platform
     *
     * @return A list of current systems
     */
    List getSystems();

    /**
     * Retrieve a list of current incidents, which are currently unresolved and may impact parts of the system
     *
     * @return List of incidents
     */
    List getCurrentIncidents();

    /**
     * Retrieve a list of historic incidents, which are may already be resolved
     *
     * @param start Start, this may be an absolute date (ISO 8601 date) or relative: -1w for one week ago
     * @param end End time. Same rules apply as for start time
     * @return List of incidents
     */
    List getHistoricIncidents(String start, String end);
}