Package com.vonage.client.subaccounts

Class ListTransfersFilter

java.lang.Object

com.vonage.client.subaccounts.ListTransfersFilter

All Implemented Interfaces:

QueryParamsRequest

public class ListTransfersFilter
extends Object
implements QueryParamsRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListTransfersFilter.Builder

Method Summary

Modifier and Type	Method	Description
static ListTransfersFilter.Builder	builder()	Entry point for constructing an instance of this class.
Instant	getEndDate()	End of the retrieval period.
Instant	getStartDate()	Start of the retrieval period.
String	getSubaccount()	Subaccount API key to filter by.
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.

getStartDate

public Instant getStartDate()

Start of the retrieval period.

Returns:

The start date of the range or Instant.EPOCH if unspecified (the default).

getEndDate

public Instant getEndDate()

End of the retrieval period. If absent then all transfers until now are returned.

Returns:

The end date of the range or null if unspecified (the default).

getSubaccount

public String getSubaccount()

Subaccount API key to filter by.

Returns:

The subaccount ID to filter by, or null if unspecified (the default).

builder

public static ListTransfersFilter.Builder builder()

Entry point for constructing an instance of this class.

Returns:

A new Builder.