Package com.vonage.client.users

Class ListUsersRequest

java.lang.Object

com.vonage.client.users.ListUsersRequest

All Implemented Interfaces:

QueryParamsRequest

public final class ListUsersRequest
extends Object
implements QueryParamsRequest

Query parameters for UsersClient.listUsers(ListUsersRequest).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListUsersRequest.Builder
static enum	ListUsersRequest.SortOrder	Represents the sort order for events.

Method Summary

Modifier and Type	Method	Description
static ListUsersRequest.Builder	builder()	Entry point for constructing an instance of this class.
String	getCursor()	The cursor to start returning results from, as derived from the _links section of a response.
String	getName()	Unique name for a user to filter by.
ListUsersRequest.SortOrder	getOrder()	The time order to return results in.
int	getPageSize()	Number of records to return in the response.
Map<String,String>	makeParams()	Internal method for serializing the fields of this class into query parameters.

Methods inherited from class java.lang.Object

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

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.

getPageSize

public int getPageSize()

Number of records to return in the response. Default is 10.

Returns:

The number of results to return.

getOrder

public ListUsersRequest.SortOrder getOrder()

The time order to return results in. Default is ascending.

Returns:

The order to return results in as an enum.

getName

public String getName()

Unique name for a user to filter by.

Returns:

The username to search for, or null if not specified.

getCursor

public String getCursor()

The cursor to start returning results from, as derived from the _links section of a response.

Returns:

The cursor key to search from, or null if not specified.

builder

public static ListUsersRequest.Builder builder()

Entry point for constructing an instance of this class.

Returns:

A new Builder.