com.squareup.square.models

Class SearchSubscriptionsRequest

java.lang.Object

com.squareup.square.models.SearchSubscriptionsRequest

public class SearchSubscriptionsRequest
extends Object

This is a model class for SearchSubscriptionsRequest type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchSubscriptionsRequest.Builder Class to build instances of SearchSubscriptionsRequest.

Constructor Summary

Constructors

Constructor and Description
SearchSubscriptionsRequest(String cursor, Integer limit, SearchSubscriptionsQuery query, List<String> include) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCursor() Getter for Cursor.
List<String>	getInclude() Getter for Include.
Integer	getLimit() Getter for Limit.
SearchSubscriptionsQuery	getQuery() Getter for Query.
int	hashCode()
SearchSubscriptionsRequest.Builder	toBuilder() Builds a new SearchSubscriptionsRequest.Builder object.
String	toString() Converts this SearchSubscriptionsRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchSubscriptionsRequest

public SearchSubscriptionsRequest(String cursor,
                                  Integer limit,
                                  SearchSubscriptionsQuery query,
                                  List<String> include)

Initialization constructor.

Parameters:

cursor - String value for cursor.

limit - Integer value for limit.

query - SearchSubscriptionsQuery value for query.

include - List of String value for include.

Method Detail

getCursor

public String getCursor()

Getter for Cursor. When the total number of resulting subscriptions exceeds the limit of a paged response, specify the cursor returned from a preceding response here to fetch the next set of results. If the cursor is unset, the response contains the last page of the results. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).

Returns:

Returns the String

getLimit

public Integer getLimit()

Getter for Limit. The upper limit on the number of subscriptions to return in a paged response.

Returns:

Returns the Integer

getQuery

public SearchSubscriptionsQuery getQuery()

Getter for Query. Represents a query, consisting of specified query expressions, used to search for subscriptions.

Returns:

Returns the SearchSubscriptionsQuery

getInclude

public List<String> getInclude()

Getter for Include. An option to include related information in the response. The supported values are: - `actions`: to include scheduled actions on the targeted subscriptions.

Returns:

Returns the List of String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this SearchSubscriptionsRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public SearchSubscriptionsRequest.Builder toBuilder()

Builds a new SearchSubscriptionsRequest.Builder object. Creates the instance with the state of the current model.

Returns:

a new SearchSubscriptionsRequest.Builder object