Package com.vonage.client.numbers

Class ListNumbersFilter

java.lang.Object

com.vonage.client.numbers.ListNumbersFilter

All Implemented Interfaces:

QueryParamsRequest

public class ListNumbersFilter
extends Object

Filter criteria used in NumbersClient.listNumbers(ListNumbersFilter).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ListNumbersFilter.Builder	Builder for setting the parameters of ListNumbersFilter.

Constructor Summary

Constructors

Constructor	Description
ListNumbersFilter()	Deprecated. Use builder().
ListNumbersFilter(Integer index, Integer size, String pattern, SearchPattern searchPattern)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static ListNumbersFilter.Builder	builder()	Entrypoint for constructing an instance of this class.
UUID	getApplicationId()	Application to return the numbers for.
String	getCountry()	Two character country code in ISO 3166-1 alpha-2 format.
Boolean	getHasApplication()	Whether results should be filtered to numbers assigned to an application.
Integer	getIndex()	Page index to start return results from.
String	getPattern()	Number pattern to narrow down the results by.
SearchPattern	getSearchPattern()	Strategy to use for matching.
Integer	getSize()	Page size.
Map<String,String>	makeParams()	Internal method for serializing the fields of this class into query parameters.
void	setIndex(Integer index)	Deprecated.
void	setPattern(String pattern)	Deprecated.
void	setSearchPattern(SearchPattern searchPattern)	Deprecated. Use BaseNumbersFilter.Builder.pattern(SearchPattern, String).
void	setSize(Integer size)	Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Details

ListNumbersFilter

@Deprecated
public ListNumbersFilter()

Deprecated.

Use builder(). This will be removed in the next major release.

Old constructor.

ListNumbersFilter

@Deprecated
public ListNumbersFilter(Integer index,
 Integer size,
 String pattern,
 SearchPattern searchPattern)

Deprecated.

Method Details

getApplicationId

public UUID getApplicationId()

Application to return the numbers for.

Returns:

The selected application ID to list numbers from, or null if unspecified.

Since:

8.10.0

getHasApplication

public Boolean getHasApplication()

Whether results should be filtered to numbers assigned to an application.

Returns:

true if results should contain only numbers associated with an application, false if only numbers unassigned to an application should be returned, or null if unspecified (i.e. the application assignment status is not considered).

Since:

8.10.0

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.

builder

public static ListNumbersFilter.Builder builder()

Entrypoint for constructing an instance of this class.

Returns:

A new Builder.

Since:

8.10.0

getIndex

public Integer getIndex()

Page index to start return results from. Default is 1.

Returns:

The cursor index, or null if unspecified.

getSize

public Integer getSize()

Page size. Default is 10, max is 100.

Returns:

The number of results to return, or null if unspecified.

getCountry

public String getCountry()

Two character country code in ISO 3166-1 alpha-2 format.

Returns:

The number's country code.

getPattern

public String getPattern()

Number pattern to narrow down the results by.

Returns:

The number pattern, or null if unspecified.

getSearchPattern

public SearchPattern getSearchPattern()

Strategy to use for matching.

Returns:

The pattern matching strategy as an enum, or null if unspecified.

setIndex

@Deprecated
public void setIndex(Integer index)

Deprecated.

setSize

@Deprecated
public void setSize(Integer size)

Deprecated.

Set the maximum number of matching results to be returned.

Parameters:

size - An Integer between 10 and 100 (inclusive) or null, to indicate that the default value should be used.

setPattern

@Deprecated
public void setPattern(String pattern)

Deprecated.

setSearchPattern

@Deprecated
public void setSearchPattern(SearchPattern searchPattern)

Deprecated.

Use BaseNumbersFilter.Builder.pattern(SearchPattern, String). This will be removed in the next major release.

Parameters:

searchPattern - The pattern you want to search for. Use the * wildcard to match the start or end of the number. For example, *123* matches all numbers that contain the pattern 123.