com.mailgun.model.events

Class EventsQueryOptions.EventsQueryOptionsBuilder

java.lang.Object

com.mailgun.model.events.EventsQueryOptions.EventsQueryOptionsBuilder

Enclosing class:

EventsQueryOptions

public static class EventsQueryOptions.EventsQueryOptionsBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
EventsQueryOptionsBuilder()

Method Summary

Modifier and Type	Method and Description
EventsQueryOptions.EventsQueryOptionsBuilder	ascending(boolean ascending) Defines the direction of the search time range and must be provided if the range end time is not specified.
EventsQueryOptions.EventsQueryOptionsBuilder	attachment(String filterExpression) Filter Expression for the attachment field.
EventsQueryOptions.EventsQueryOptionsBuilder	begin(Long time) The beginning of the search time range in Linux epoch seconds.
EventsQueryOptions.EventsQueryOptionsBuilder	begin(java.time.ZonedDateTime time) The beginning of the search time range.
EventsQueryOptions.EventsQueryOptionsBuilder	end(Long time) The end of the search time range in Linux epoch seconds.
EventsQueryOptions.EventsQueryOptionsBuilder	end(java.time.ZonedDateTime time) The end of the search time range.
EventsQueryOptions.EventsQueryOptionsBuilder	event(EventType event) An event type.
EventsQueryOptions.EventsQueryOptionsBuilder	eventFieldFilterExpression(String filterExpression) Filter Expression for the event field.
EventsQueryOptions.EventsQueryOptionsBuilder	from(String filterExpression) Filter Expression for the from field.
EventsQueryOptions.EventsQueryOptionsBuilder	messageId(String filterExpression) Filter Expression for the messageId field.
EventsQueryOptions.EventsQueryOptionsBuilder	recipient(String filterExpression) Filter Expression for the recipient field.
EventsQueryOptions.EventsQueryOptionsBuilder	recipients(String filterExpression) Filter Expression for the recipients field.
EventsQueryOptions.EventsQueryOptionsBuilder	severity(Severity severity) Used to filter events based on severity, if exists.
EventsQueryOptions.EventsQueryOptionsBuilder	size(String filterExpression) Filter Expression for the size field.
EventsQueryOptions.EventsQueryOptionsBuilder	subject(String filterExpression) Filter Expression for the subject field.
EventsQueryOptions.EventsQueryOptionsBuilder	tags(String filterExpression) Filter Expression for the tags field.
EventsQueryOptions.EventsQueryOptionsBuilder	to(String filterExpression) Filter Expression for the to field.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventsQueryOptionsBuilder

public EventsQueryOptionsBuilder()

Method Detail

begin

public EventsQueryOptions.EventsQueryOptionsBuilder begin(java.time.ZonedDateTime time)

The beginning of the search time range.

Parameters:

time - The beginning of the search time range.

Returns:

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

See Also:

Time Range

begin

public EventsQueryOptions.EventsQueryOptionsBuilder begin(Long time)

The beginning of the search time range in Linux epoch seconds.

Parameters:

time - The beginning of the search time range in Linux epoch seconds.

Returns:

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

See Also:

Time Range

end

public EventsQueryOptions.EventsQueryOptionsBuilder end(java.time.ZonedDateTime time)

The end of the search time range.

Parameters:

time - The end of the search time range ZonedDateTime

Returns:

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

See Also:

Time Range

end

public EventsQueryOptions.EventsQueryOptionsBuilder end(Long time)

The end of the search time range in Linux epoch seconds.

Parameters:

time - The end of the search time range in Linux epoch seconds.

Returns:

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

See Also:

Time Range

ascending

public EventsQueryOptions.EventsQueryOptionsBuilder ascending(boolean ascending)

Defines the direction of the search time range and must be provided if the range end time is not specified.

Can be either true or false

Parameters:

ascending - Defines the direction of the search time range and must be provided if the range end time is not specified. Can be either true or false

Returns:

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

event

public EventsQueryOptions.EventsQueryOptionsBuilder event(EventType event)

An event type.

Parameters:

event - An event type.

Returns:

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

eventFieldFilterExpression

public EventsQueryOptions.EventsQueryOptionsBuilder eventFieldFilterExpression(String filterExpression)

Filter Expression for the event field.

The value of the parameter should be a valid Filter Expression.

Examples:

 foo bar   Matches field values that contain both term foo and term bar.
 foo AND bar       Same as above.
 foo OR bar        Matches field values that contain either term foo or term bar.
 “foo bar” Matches field values that literally contain foo bar.
 NOT foo   Matches field values that do not contain term foo.
 

Note that more then one expression can be used as a filter value and parentheses can be used to specify grouping.

 E.g.: (Hello AND NOT Rachel) OR (Farewell AND Monica).
 

Parameters:

filterExpression - Filter Expression

Returns:

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

severity

public EventsQueryOptions.EventsQueryOptionsBuilder severity(Severity severity)

Used to filter events based on severity, if exists. (Currently failed events only) Temporary or Permanent.

Parameters:

severity - severity

Returns:

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

attachment

public EventsQueryOptions.EventsQueryOptionsBuilder attachment(String filterExpression)

Filter Expression for the attachment field. A name of an attached file.

The value of the parameter should be a valid Filter Expression.

Examples:

 foo bar   Matches field values that contain both term foo and term bar.
 foo AND bar       Same as above.
 foo OR bar        Matches field values that contain either term foo or term bar.
 “foo bar” Matches field values that literally contain foo bar.
 NOT foo   Matches field values that do not contain term foo.
 

Note that more then one expression can be used as a filter value and parentheses can be used to specify grouping.

 E.g.: (Hello AND NOT Rachel) OR (Farewell AND Monica).
 

Parameters:

filterExpression - Filter Expression

Returns:

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

from

public EventsQueryOptions.EventsQueryOptionsBuilder from(String filterExpression)

Filter Expression for the from field. An email address mentioned in the from MIME header.

The value of the parameter should be a valid Filter Expression.

Examples:

 foo bar   Matches field values that contain both term foo and term bar.
 foo AND bar       Same as above.
 foo OR bar        Matches field values that contain either term foo or term bar.
 “foo bar” Matches field values that literally contain foo bar.
 NOT foo   Matches field values that do not contain term foo.
 

Note that more then one expression can be used as a filter value and parentheses can be used to specify grouping.

 E.g.: (Hello AND NOT Rachel) OR (Farewell AND Monica).
 

Parameters:

filterExpression - Filter Expression

Returns:

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

messageId

public EventsQueryOptions.EventsQueryOptionsBuilder messageId(String filterExpression)

Filter Expression for the messageId field. A Mailgun message id returned by the messages API.

The value of the parameter should be a valid Filter Expression.

Examples:

 foo bar   Matches field values that contain both term foo and term bar.
 foo AND bar       Same as above.
 foo OR bar        Matches field values that contain either term foo or term bar.
 “foo bar” Matches field values that literally contain foo bar.
 NOT foo   Matches field values that do not contain term foo.
 

Note that more then one expression can be used as a filter value and parentheses can be used to specify grouping.

 E.g.: (Hello AND NOT Rachel) OR (Farewell AND Monica).
 

Parameters:

filterExpression - Filter Expression

Returns:

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

subject

public EventsQueryOptions.EventsQueryOptionsBuilder subject(String filterExpression)

Filter Expression for the subject field. A subject line.

The value of the parameter should be a valid Filter Expression.

Examples:

 foo bar   Matches field values that contain both term foo and term bar.
 foo AND bar       Same as above.
 foo OR bar        Matches field values that contain either term foo or term bar.
 “foo bar” Matches field values that literally contain foo bar.
 NOT foo   Matches field values that do not contain term foo.
 

Note that more then one expression can be used as a filter value and parentheses can be used to specify grouping.

 E.g.: (Hello AND NOT Rachel) OR (Farewell AND Monica).
 

Parameters:

filterExpression - Filter Expression

Returns:

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

to

public EventsQueryOptions.EventsQueryOptionsBuilder to(String filterExpression)

Filter Expression for the to field. An email address mentioned in the to MIME header.

The value of the parameter should be a valid Filter Expression.

Examples:

 foo bar   Matches field values that contain both term foo and term bar.
 foo AND bar       Same as above.
 foo OR bar        Matches field values that contain either term foo or term bar.
 “foo bar” Matches field values that literally contain foo bar.
 NOT foo   Matches field values that do not contain term foo.
 

Note that more then one expression can be used as a filter value and parentheses can be used to specify grouping.

 E.g.: (Hello AND NOT Rachel) OR (Farewell AND Monica).
 

Parameters:

filterExpression - Filter Expression

Returns:

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

size

public EventsQueryOptions.EventsQueryOptionsBuilder size(String filterExpression)

Filter Expression for the size field. Message size.

The value of the parameter should be a valid Filter Expression.

Examples:

 10000 Matches values that greater then 10000.
 >10000 <20000 Matches values that are greater then 10000 and less then 20000.
 

Parameters:

filterExpression - Filter Expression

Returns:

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

recipient

public EventsQueryOptions.EventsQueryOptionsBuilder recipient(String filterExpression)

Filter Expression for the recipient field. An email address of a particular recipient.

The value of the parameter should be a valid Filter Expression.

Examples:

 foo bar   Matches field values that contain both term foo and term bar.
 foo AND bar       Same as above.
 foo OR bar        Matches field values that contain either term foo or term bar.
 “foo bar” Matches field values that literally contain foo bar.
 NOT foo   Matches field values that do not contain term foo.
 

Note that more then one expression can be used as a filter value and parentheses can be used to specify grouping.

 E.g.: (Hello AND NOT Rachel) OR (Farewell AND Monica).
 

Parameters:

filterExpression - Filter Expression

Returns:

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

recipients

public EventsQueryOptions.EventsQueryOptionsBuilder recipients(String filterExpression)

Filter Expression for the recipients field. Specific to stored events, this field tracks all of the potential message recipients.

The value of the parameter should be a valid Filter Expression.

Examples:

 foo bar   Matches field values that contain both term foo and term bar.
 foo AND bar       Same as above.
 foo OR bar        Matches field values that contain either term foo or term bar.
 “foo bar” Matches field values that literally contain foo bar.
 NOT foo   Matches field values that do not contain term foo.
 

Note that more then one expression can be used as a filter value and parentheses can be used to specify grouping.

 E.g.: (Hello AND NOT Rachel) OR (Farewell AND Monica).
 

Parameters:

filterExpression - Filter Expression

Returns:

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

tags

public EventsQueryOptions.EventsQueryOptionsBuilder tags(String filterExpression)

Filter Expression for the tags field. User defined tags.

The value of the parameter should be a valid Filter Expression.

Examples:

 foo bar   Matches field values that contain both term foo and term bar.
 foo AND bar       Same as above.
 foo OR bar        Matches field values that contain either term foo or term bar.
 “foo bar” Matches field values that literally contain foo bar.
 NOT foo   Matches field values that do not contain term foo.
 

Note that more then one expression can be used as a filter value and parentheses can be used to specify grouping.

 E.g.: (Hello AND NOT Rachel) OR (Farewell AND Monica).
 

Parameters:

filterExpression - Filter Expression

Returns:

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