io.digdag.spi.Notification Maven / Gradle / Ivy

Go to download
package io.digdag.spi;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.google.common.base.Optional;
import org.immutables.value.Value;

import java.time.Instant;
import java.time.LocalDateTime;
import java.time.OffsetDateTime;
import java.time.ZoneId;
import java.util.UUID;

@Value.Immutable
@JsonSerialize(as = ImmutableNotification.class)
@JsonDeserialize(as = ImmutableNotification.class)
public interface Notification
{
    // A message and timestamp
    @JsonProperty("timestamp")
    Instant getTimestamp();

    @JsonProperty("message")
    String getMessage();

    // Optional context information with further details about the origin of the notification
    @JsonProperty("site_id")
    Optional getSiteId();

    @JsonProperty("project_id")
    Optional getProjectId();

    @JsonProperty("project_name")
    Optional getProjectName();

    @JsonProperty("workflow_name")
    Optional getWorkflowName();

    @JsonProperty("revision")
    Optional getRevision();

    @JsonProperty("attempt_id")
    Optional getAttemptId();

    @JsonProperty("session_id")
    Optional getSessionId();

    @JsonProperty("task_name")
    Optional getTaskName();

    @JsonProperty("timezone")
    Optional getTimeZone();

    @JsonProperty("session_uuid")
    Optional getSessionUuid();

    @JsonProperty("session_time")
    Optional getSessionTime();

    static ImmutableNotification.Builder builder(Instant timestamp, String message) {
        return ImmutableNotification.builder()
                .timestamp(timestamp)
                .message(message);
    }
}