Package com.rivet.api.resources.identity.requests

Class SearchRequest.Builder

java.lang.Object

com.rivet.api.resources.identity.requests.SearchRequest.Builder

All Implemented Interfaces:

SearchRequest._FinalStage, SearchRequest.QueryStage

Enclosing class:

SearchRequest

public static final class SearchRequest.Builder
extends java.lang.Object
implements SearchRequest.QueryStage, SearchRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
SearchRequest._FinalStage	anchor(java.lang.String anchor)	How many identities to offset the search by.
SearchRequest._FinalStage	anchor(java.util.Optional<java.lang.String> anchor)
SearchRequest	build()
SearchRequest.Builder	from(SearchRequest other)
SearchRequest._FinalStage	limit(java.lang.Integer limit)	Amount of identities to return.
SearchRequest._FinalStage	limit(java.util.Optional<java.lang.Integer> limit)
SearchRequest._FinalStage	query(java.lang.String query)	The query to match identity display names and account numbers against.

Methods inherited from class java.lang.Object

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

Method Detail

from

public SearchRequest.Builder from(SearchRequest other)

Specified by:

from in interface SearchRequest.QueryStage

query

public SearchRequest._FinalStage query(java.lang.String query)

The query to match identity display names and account numbers against.

Specified by:

query in interface SearchRequest.QueryStage

Returns:

Reference to this so that method calls can be chained together.

limit

public SearchRequest._FinalStage limit(java.lang.Integer limit)

Amount of identities to return. Must be between 1 and 32 inclusive.

Specified by:

limit in interface SearchRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

limit

public SearchRequest._FinalStage limit(java.util.Optional<java.lang.Integer> limit)

Specified by:

limit in interface SearchRequest._FinalStage

anchor

public SearchRequest._FinalStage anchor(java.lang.String anchor)

How many identities to offset the search by.

Specified by:

anchor in interface SearchRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

anchor

public SearchRequest._FinalStage anchor(java.util.Optional<java.lang.String> anchor)

Specified by:

anchor in interface SearchRequest._FinalStage

build

public SearchRequest build()

Specified by:

build in interface SearchRequest._FinalStage