com.mailgun.model

Class StatisticsOptions.StatisticsOptionsBuilder

java.lang.Object

com.mailgun.model.StatisticsOptions.StatisticsOptionsBuilder

Enclosing class:

StatisticsOptions

public static class StatisticsOptions.StatisticsOptionsBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
StatisticsOptionsBuilder()

Method Summary

Modifier and Type	Method and Description
StatisticsOptions.StatisticsOptionsBuilder	duration(int timeValue, Duration duration) Period of time with resolution encoded.
StatisticsOptions.StatisticsOptionsBuilder	end(java.time.ZonedDateTime zonedDateTime) The ending date.
StatisticsOptions.StatisticsOptionsBuilder	event(List<StatsEventType> events) Event types.
StatisticsOptions.StatisticsOptionsBuilder	event(StatsEventType event) Event type.
StatisticsOptions.StatisticsOptionsBuilder	resolution(ResolutionPeriod resolutionPeriod) Resolution period.
StatisticsOptions.StatisticsOptionsBuilder	start(java.time.ZonedDateTime zonedDateTime) The starting time.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StatisticsOptionsBuilder

public StatisticsOptionsBuilder()

Method Detail

event

public StatisticsOptions.StatisticsOptionsBuilder event(StatsEventType event)

Event type.

Parameters:

event - StatsEventType

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Event Types

event

public StatisticsOptions.StatisticsOptionsBuilder event(List<StatsEventType> events)

Event types.

Parameters:

events - list of StatsEventType

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Event Types

start

public StatisticsOptions.StatisticsOptionsBuilder start(java.time.ZonedDateTime zonedDateTime)

The starting time.

Default: 7 days from the current time.

Parameters:

zonedDateTime - ZonedDateTime

Returns:

Returns a reference to this object so that method calls can be chained together.

end

public StatisticsOptions.StatisticsOptionsBuilder end(java.time.ZonedDateTime zonedDateTime)

The ending date.

Default: current time.

Parameters:

zonedDateTime - ZonedDateTime

Returns:

Returns a reference to this object so that method calls can be chained together.

resolution

public StatisticsOptions.StatisticsOptionsBuilder resolution(ResolutionPeriod resolutionPeriod)

Resolution period.

Can be either HOUR, DAY or MONTH

Default: DAY

Parameters:

resolutionPeriod - ResolutionPeriod

Returns:

Returns a reference to this object so that method calls can be chained together.

duration

public StatisticsOptions.StatisticsOptionsBuilder duration(int timeValue,
                                                           Duration duration)

Period of time with resolution encoded. If provided, overwrites the start date.

Parameters:

timeValue - time value

duration - Duration

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Duration