Package com.vonage.client.proactiveconnect

Class ListEventsFilter

java.lang.Object
com.vonage.client.proactiveconnect.ListEventsFilter
All Implemented Interfaces:
QueryParamsRequest
public class ListEventsFilter extends Object implements QueryParamsRequest
Filter options for finding events using ProactiveConnectClient.listEvents(ListEventsFilter).

  • Method Details

    • makeParams

      public Map<String,String> makeParams()
      Description copied from interface: QueryParamsRequest
      Internal method for serializing the fields of this class into query parameters. The Map should be mutable so that subclasses can add fields, otherwise the method or implementing class should be marked as final. Duplicate entries can be handled by mapping the key to a list of the entries.
      Specified by:
      makeParams in interface QueryParamsRequest
      Returns:
      The query parameters as unique key-value pairs.

    • getOrder

      public SortOrder getOrder()
      Sort in either ascending or descending order.
      Returns:
      The sort order as an enum, or null if unspecified.

    • getRunId

      public UUID getRunId()
      Run ID to filter by.
      Returns:
      The run ID, or null if unspecified.

    • getRunItemId

      public UUID getRunItemId()
      Run item ID to filter by.
      Returns:
      The run item ID, or null if unspecified.

    • getInvocationId

      public UUID getInvocationId()
      Invocation ID to filter by.
      Returns:
      The invocation ID, or null if unspecified.

    • getActionId

      public UUID getActionId()
      Action ID to filter by.
      Returns:
      The action ID, or null if unspecified.

    • getTraceId

      public UUID getTraceId()
      Trace ID to filter by.
      Returns:
      The trace ID, or null if unspecified.

    • getRecipientId

      public String getRecipientId()
      Recipient ID to filter by.
      Returns:
      The recipient ID, or null if unspecified.

    • getSourceContext

      public String getSourceContext()
      The name of the segment / matcher the item / event to filter by (exact string).
      Returns:
      The source context string, or null if unspecified.

    • getSourceType

      public SourceType getSourceType()
      Source type to filter by.
      Returns:
      The source type as an enum, or null if unspecified.

    • getStartDate

      public Instant getStartDate()
      ISO-8601 formatted date for when to begin events filter.
      Returns:
      The start date for events as an Instant, or null if unspecified.

    • getEndDate

      public Instant getEndDate()
      ISO-8601 formatted date for when to end events filter.
      Returns:
      The end date for events as an Instant, or null if unspecified.

    • builder

      public static ListEventsFilter.Builder builder()
      Entry point for constructing an instance of this class.
      Returns:
      A new Builder.