Package com.vonage.client.proactiveconnect

Class ListEventsFilter.Builder

java.lang.Object

com.vonage.client.proactiveconnect.ListEventsFilter.Builder

Enclosing class:

ListEventsFilter

public static class ListEventsFilter.Builder
extends Object

Builder for specifying options to filter events by. All fields are optional.

Method Summary

Modifier and Type	Method	Description
ListEventsFilter.Builder	actionId(String actionId)	Action ID to filter by.
ListEventsFilter	build()	Builds the ListEventsFilter.
ListEventsFilter.Builder	endDate(Instant endDate)	ISO-8601 formatted date for when to end events filter.
ListEventsFilter.Builder	invocationId(String invocationId)	Invocation ID to filter by.
ListEventsFilter.Builder	order(SortOrder order)	Sort in either ascending or descending order.
ListEventsFilter.Builder	recipientId(String recipientId)	Recipient ID to filter by.
ListEventsFilter.Builder	runId(String runId)	Run ID to filter by.
ListEventsFilter.Builder	runItemId(String runItemId)	Run item ID to filter by.
ListEventsFilter.Builder	sourceContext(String sourceContext)	The name of the segment / matcher the item / event to filter by (exact string).
ListEventsFilter.Builder	sourceType(SourceType sourceType)	Source type to filter by.
ListEventsFilter.Builder	startDate(Instant startDate)	ISO-8601 formatted date for when to begin events filter.
ListEventsFilter.Builder	traceId(String traceId)	Trace ID to filter by.

Methods inherited from class java.lang.Object

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

Method Details

order

public ListEventsFilter.Builder order(SortOrder order)

Sort in either ascending or descending order.

Parameters:

order - The sort order as an enum.

Returns:

This builder.

runId

public ListEventsFilter.Builder runId(String runId)

Run ID to filter by.

Parameters:

runId - The run ID.

Returns:

This builder.

runItemId

public ListEventsFilter.Builder runItemId(String runItemId)

Run item ID to filter by.

Parameters:

runItemId - The run item ID.

Returns:

This builder.

invocationId

public ListEventsFilter.Builder invocationId(String invocationId)

Invocation ID to filter by.

Parameters:

invocationId - The invocation ID.

Returns:

This builder.

actionId

public ListEventsFilter.Builder actionId(String actionId)

Action ID to filter by.

Parameters:

actionId - The action ID.

Returns:

This builder.

traceId

public ListEventsFilter.Builder traceId(String traceId)

Trace ID to filter by.

Parameters:

traceId - The trace ID.

Returns:

This builder.

recipientId

public ListEventsFilter.Builder recipientId(String recipientId)

Recipient ID to filter by.

Parameters:

recipientId - The recipient ID.

Returns:

This builder.

sourceContext

public ListEventsFilter.Builder sourceContext(String sourceContext)

The name of the segment / matcher the item / event to filter by (exact string).

Parameters:

sourceContext - The source context string.

Returns:

This builder.

sourceType

public ListEventsFilter.Builder sourceType(SourceType sourceType)

Source type to filter by.

Parameters:

sourceType - The source type as an enum.

Returns:

This builder.

startDate

public ListEventsFilter.Builder startDate(Instant startDate)

ISO-8601 formatted date for when to begin events filter.

Parameters:

startDate - The start date for events as an Instant.

Returns:

This builder.

endDate

public ListEventsFilter.Builder endDate(Instant endDate)

ISO-8601 formatted date for when to end events filter.

Parameters:

endDate - The end date for events as an Instant.

Returns:

This builder.

build

public ListEventsFilter build()

Builds the ListEventsFilter.

Returns:

An instance of ListEventsFilter, populated with all fields from this builder.