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>
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. Please note, StripeSearchResult is beta functionality and is subject to change or removal at any time.
-
-
Field Summary
-
Fields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON
-
-
Constructor Summary
Constructors Constructor Description StripeSearchResult()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Iterable<T>
autoPagingIterable()
java.lang.Iterable<T>
autoPagingIterable(java.util.Map<java.lang.String,java.lang.Object> params)
java.lang.Iterable<T>
autoPagingIterable(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Constructs an iterable that can be used to iterate across all objects across all pages.protected boolean
canEqual(java.lang.Object other)
boolean
equals(java.lang.Object o)
java.util.List<T>
getData()
java.lang.Boolean
getHasMore()
java.lang.String
getNextPage()
java.lang.String
getObject()
RequestOptions
getRequestOptions()
Get request options that were used to fetch the collection.java.util.Map<java.lang.String,java.lang.Object>
getRequestParams()
Get request parameters that were used to fetch the collection.java.lang.String
getUrl()
int
hashCode()
void
setData(java.util.List<T> data)
void
setHasMore(java.lang.Boolean hasMore)
void
setNextPage(java.lang.String nextPage)
void
setObject(java.lang.String object)
void
setRequestOptions(RequestOptions requestOptions)
Set request options that were used to fetch the collection.void
setRequestParams(java.util.Map<java.lang.String,java.lang.Object> requestParams)
Set request parameters that were used to fetch the collection.void
setUrl(java.lang.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
-
-
-
-
Method Detail
-
autoPagingIterable
public java.lang.Iterable<T> autoPagingIterable()
-
autoPagingIterable
public java.lang.Iterable<T> autoPagingIterable(java.util.Map<java.lang.String,java.lang.Object> params)
-
autoPagingIterable
public java.lang.Iterable<T> autoPagingIterable(java.util.Map<java.lang.String,java.lang.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 java.lang.String getObject()
-
setObject
public void setObject(java.lang.String object)
-
setData
public void setData(java.util.List<T> data)
-
setHasMore
public void setHasMore(java.lang.Boolean hasMore)
-
setUrl
public void setUrl(java.lang.String url)
-
setNextPage
public void setNextPage(java.lang.String nextPage)
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
canEqual
protected boolean canEqual(java.lang.Object other)
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
getData
public java.util.List<T> getData()
- Specified by:
getData
in interfaceStripeCollectionInterface<T>
-
getHasMore
public java.lang.Boolean getHasMore()
- Specified by:
getHasMore
in interfaceStripeCollectionInterface<T>
-
getUrl
public java.lang.String getUrl()
- Specified by:
getUrl
in interfaceStripeCollectionInterface<T>
-
getNextPage
public java.lang.String getNextPage()
- Specified by:
getNextPage
in interfaceStripeSearchResultInterface<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 interfaceStripeCollectionInterface<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 interfaceStripeCollectionInterface<T>
-
getRequestParams
public java.util.Map<java.lang.String,java.lang.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 interfaceStripeCollectionInterface<T>
-
setRequestParams
public void setRequestParams(java.util.Map<java.lang.String,java.lang.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 interfaceStripeCollectionInterface<T>
-
-