Model

Class CreateSearchRequest

java.lang.Object

Model.CreateSearchRequest

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2020-09-14T15:19:00.879+05:30")
public class CreateSearchRequest
extends Object

CreateSearchRequest

Constructor Summary

Constructors

Constructor and Description
CreateSearchRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Integer	getLimit() Controls the maximum number of items that may be returned for a single request.
String	getName() Name of this search.
Integer	getOffset() Controls the starting point within the collection of results, which defaults to 0.
String	getQuery() String that contains the filters and variables for which you want to search.
Boolean	getSave() Indicates whether or not you want to save this search request for future use.
String	getSort() A comma separated list of the following form: `submitTimeUtc:desc`
String	getTimezone() Merchant’s time zone in ISO standard, using the TZ database format.
int	hashCode()
CreateSearchRequest	limit(Integer limit)
CreateSearchRequest	name(String name)
CreateSearchRequest	offset(Integer offset)
CreateSearchRequest	query(String query)
CreateSearchRequest	save(Boolean save)
void	setLimit(Integer limit)
void	setName(String name)
void	setOffset(Integer offset)
void	setQuery(String query)
void	setSave(Boolean save)
void	setSort(String sort)
void	setTimezone(String timezone)
CreateSearchRequest	sort(String sort)
CreateSearchRequest	timezone(String timezone)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateSearchRequest

public CreateSearchRequest()

Method Detail

save

public CreateSearchRequest save(Boolean save)

getSave

public Boolean getSave()

Indicates whether or not you want to save this search request for future use. The options are: * `true` * `false` (default value) If set to `true`, this field returns `searchID` in the response. You can use this value to retrieve the details of the saved search.

Returns:

save

setSave

public void setSave(Boolean save)

name

public CreateSearchRequest name(String name)

getName

public String getName()

Name of this search. When `save` is set to `true`, this search is saved with this name.

Returns:

name

setName

public void setName(String name)

timezone

public CreateSearchRequest timezone(String timezone)

getTimezone

public String getTimezone()

Merchant’s time zone in ISO standard, using the TZ database format. For example: `America/Chicago`

Returns:

timezone

setTimezone

public void setTimezone(String timezone)

query

public CreateSearchRequest query(String query)

getQuery

public String getQuery()

String that contains the filters and variables for which you want to search. For information about supported field-filters and operators, see the [Query Filters]( https://developer.cybersource.com/api/developer-guides/dita-txn-search-details-rest-api-dev-guide-102718/txn_search_api/creating_txn_search_request.html) section of the Transaction Search Developer Guide.

Returns:

query

setQuery

public void setQuery(String query)

offset

public CreateSearchRequest offset(Integer offset)

getOffset

public Integer getOffset()

Controls the starting point within the collection of results, which defaults to 0. The first item in the collection is retrieved by setting a zero offset. For example, if you have a collection of 15 items to be retrieved from a resource and you specify limit=5, you can retrieve the entire set of results in 3 successive requests by varying the offset value like this: `offset=0` `offset=5` `offset=10` **Note:** If an offset larger than the number of results is provided, this will result in no embedded object being returned.

Returns:

offset

setOffset

public void setOffset(Integer offset)

limit

public CreateSearchRequest limit(Integer limit)

getLimit

public Integer getLimit()

Controls the maximum number of items that may be returned for a single request. The default is 20, the maximum is 2000.

Returns:

limit

setLimit

public void setLimit(Integer limit)

sort

public CreateSearchRequest sort(String sort)

getSort

public String getSort()

A comma separated list of the following form: `submitTimeUtc:desc`

Returns:

sort

setSort

public void setSort(String sort)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object