com.mailgun.model.stats.StatsResult Maven / Gradle / Ivy

Go to download
package com.mailgun.model.stats;

import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.mailgun.enums.ResolutionPeriod;
import lombok.Builder;
import lombok.Value;
import lombok.extern.jackson.Jacksonized;

import java.time.ZonedDateTime;
import java.util.List;

import static com.mailgun.util.Constants.ENGLISH;
import static com.mailgun.util.Constants.RFC_2822_DATE_TIME_PATTERN_TIME_ZONE_NAME;

/**
 * 
 * Mailgun tracks all of the events that occur throughout the system.
 * 
 *
 * @see Stats
 */
@Value
@Jacksonized
@Builder
@JsonIgnoreProperties(ignoreUnknown = true)
public class StatsResult {

    /**
     * 
     * Stats description.
     * 
     */
    String description;

    /**
     * 
     * The starting time.
     * 
     */
    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = RFC_2822_DATE_TIME_PATTERN_TIME_ZONE_NAME, locale = ENGLISH)
    ZonedDateTime start;

    /**
     * 
     * The ending date.
     * 
     */
    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = RFC_2822_DATE_TIME_PATTERN_TIME_ZONE_NAME, locale = ENGLISH)
    ZonedDateTime end;

    /**
     * 
     * Resolution
     * 
     * {@link ResolutionPeriod}
     * 
     * Can be either HOUR, DAY or MONTH
     * 
     */
    ResolutionPeriod resolution;

    /**
     * 
     * Statistics.
     * 
     * {@link Stats}
     */
    List stats;

}