Package com.stripe.model

Class StripeSearchResult<T>

java.lang.Object

com.stripe.model.StripeObject

com.stripe.model.StripeSearchResult<T>

All Implemented Interfaces:

StripeCollectionInterface<T>, StripeObjectInterface, StripeSearchResultInterface<T>

Direct Known Subclasses:

ChargeSearchResult, CustomerSearchResult, InvoiceSearchResult, PaymentIntentSearchResult, PriceSearchResult, ProductSearchResult, SubscriptionSearchResult

public abstract class StripeSearchResult<T>
extends StripeObject
implements StripeSearchResultInterface<T>

Provides a representation of a single page worth of data from a Stripe API search method.

Field Summary

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
StripeSearchResult()

Method Summary

Modifier and Type	Method	Description
Iterable<T>	autoPagingIterable()
Iterable<T>	autoPagingIterable(Map<String,Object> params)
Iterable<T>	autoPagingIterable(Map<String,Object> params, RequestOptions options)	Constructs an iterable that can be used to iterate across all objects across all pages.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<T>	getData()
Boolean	getHasMore()
String	getNextPage()
String	getObject()
RequestOptions	getRequestOptions()	Get request options that were used to fetch the collection.
Map<String,Object>	getRequestParams()	Get request parameters that were used to fetch the collection.
Long	getTotalCount()	Get the total count of search records in the result.
String	getUrl()
int	hashCode()
void	setData(List<T> data)
void	setHasMore(Boolean hasMore)
void	setNextPage(String nextPage)
void	setObject(String object)
void	setRequestOptions(RequestOptions requestOptions)	Set request options that were used to fetch the collection.
void	setRequestParams(Map<String,Object> requestParams)	Set request parameters that were used to fetch the collection.
void	setTotalCount(Long totalCount)	Get the total count of search records in the result.
void	setUrl(String url)

Methods inherited from class com.stripe.model.StripeObject

equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stripe.model.StripeObjectInterface

getLastResponse, setLastResponse

Constructor Details

StripeSearchResult

public StripeSearchResult()

Method Details

autoPagingIterable

public Iterable<T> autoPagingIterable()

autoPagingIterable

public Iterable<T> autoPagingIterable(Map<String,Object> params)

autoPagingIterable

public Iterable<T> autoPagingIterable(Map<String,Object> params,
 RequestOptions options)

Constructs an iterable that can be used to iterate across all objects across all pages. As page boundaries are encountered, the next page will be fetched automatically for continued iteration.

Parameters:

params - request parameters (will override the parameters from the initial list request)

options - request options (will override the options from the initial list request)

getObject

public String getObject()

setObject

public void setObject(String object)

setData

public void setData(List<T> data)

setTotalCount

public void setTotalCount(Long totalCount)

Get the total count of search records in the result. The value is present when `total_count` is added to the `expand` search parameter.

setHasMore

public void setHasMore(Boolean hasMore)

setUrl

public void setUrl(String url)

setNextPage

public void setNextPage(String nextPage)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getData

public List<T> getData()

Specified by:

getData in interface StripeCollectionInterface<T>

getTotalCount

public Long getTotalCount()

Get the total count of search records in the result. The value is present when `total_count` is added to the `expand` search parameter.

Specified by:

getTotalCount in interface StripeSearchResultInterface<T>

getHasMore

public Boolean getHasMore()

Specified by:

getHasMore in interface StripeCollectionInterface<T>

getUrl

public String getUrl()

Specified by:

getUrl in interface StripeCollectionInterface<T>

getNextPage

public String getNextPage()

Specified by:

getNextPage in interface StripeSearchResultInterface<T>

getRequestOptions

public RequestOptions getRequestOptions()

Description copied from interface: StripeCollectionInterface

Get request options that were used to fetch the collection. This is useful for purposes of pagination.

Specified by:

getRequestOptions in interface StripeCollectionInterface<T>

setRequestOptions

public void setRequestOptions(RequestOptions requestOptions)

Description copied from interface: StripeCollectionInterface

Set request options that were used to fetch the collection. This is required for purposes of pagination.

Specified by:

setRequestOptions in interface StripeCollectionInterface<T>

getRequestParams

public Map<String,Object> getRequestParams()

Description copied from interface: StripeCollectionInterface

Get request parameters that were used to fetch the collection. This is useful for purposes of pagination.

Specified by:

getRequestParams in interface StripeCollectionInterface<T>

setRequestParams

public void setRequestParams(Map<String,Object> requestParams)

Description copied from interface: StripeCollectionInterface

Set request parameters that were used to fetch the collection. This is required for purposes of pagination.

Specified by:

setRequestParams in interface StripeCollectionInterface<T>