Package com.vonage.client.common

Class HalFilterRequest.Builder<F extends HalFilterRequest,B extends HalFilterRequest.Builder<? extends F,? extends B>>

java.lang.Object
com.vonage.client.common.HalFilterRequest.Builder<F,B>
Direct Known Subclasses:
ListApplicationRequest.Builder, ListConversationsRequest.Builder, ListEventsRequest.Builder, ListMembersRequest.Builder, ListUserConversationsRequest.Builder
Enclosing class:
HalFilterRequest
protected abstract static class HalFilterRequest.Builder<F extends HalFilterRequest,B extends HalFilterRequest.Builder<? extends F,? extends B>> extends Object

  • Field Details

  • Constructor Details

  • Method Details

    • cursor

      protected B cursor(String cursor)
      The cursor to start returning results from. This can be obtained from the URL in the relevant section from HalPageResponse.getLinks().
      Parameters:
      cursor - The page navigation cursor as a string.
      Returns:
      This builder.

    • page

      protected B page(int page)
      Page to navigate to in the response.
      Parameters:
      page - The page as an int.
      Returns:
      This builder.

    • pageSize

      protected B pageSize(int pageSize)
      Number of results per page.
      Parameters:
      pageSize - he page size as an int.
      Returns:
      This builder.

    • order

      protected B order(SortOrder order)
      Order to sort the results by.
      Parameters:
      order - The results sort order as an enum.
      Returns:
      This builder.

    • startDate

      protected B startDate(Instant startDate)
      Filter records that occurred after this point in time.
      Parameters:
      startDate - The start timestamp for results.
      Returns:
      This builder.

    • endDate

      protected B endDate(Instant endDate)
      Filter records that occurred before this point in time.
      Parameters:
      endDate - The end timestamp for results.
      Returns:
      This builder.

    • build

      public abstract F build()
      Builds the filter request.
      Returns:
      A new FilterRequest with this builder's properties.