com.squareup.square.models

Class ListLocationCustomAttributesRequest

java.lang.Object

com.squareup.square.models.ListLocationCustomAttributesRequest

public class ListLocationCustomAttributesRequest
extends Object

This is a model class for ListLocationCustomAttributesRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	ListLocationCustomAttributesRequest(String visibilityFilter, Integer limit, String cursor, Boolean withDefinitions) Initialization constructor.
protected	ListLocationCustomAttributesRequest(String visibilityFilter, io.apimatic.core.types.OptionalNullable<Integer> limit, io.apimatic.core.types.OptionalNullable<String> cursor, io.apimatic.core.types.OptionalNullable<Boolean> withDefinitions) Internal initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCursor() Getter for Cursor.
Integer	getLimit() Getter for Limit.
String	getVisibilityFilter() Getter for VisibilityFilter.
Boolean	getWithDefinitions() Getter for WithDefinitions.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCursor() Internal Getter for Cursor.
protected io.apimatic.core.types.OptionalNullable<Integer>	internalGetLimit() Internal Getter for Limit.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetWithDefinitions() Internal Getter for WithDefinitions.
ListLocationCustomAttributesRequest.Builder	toBuilder() Builds a new ListLocationCustomAttributesRequest.Builder object.
String	toString() Converts this ListLocationCustomAttributesRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListLocationCustomAttributesRequest

public ListLocationCustomAttributesRequest(String visibilityFilter,
                                           Integer limit,
                                           String cursor,
                                           Boolean withDefinitions)

Initialization constructor.

Parameters:

visibilityFilter - String value for visibilityFilter.

limit - Integer value for limit.

cursor - String value for cursor.

withDefinitions - Boolean value for withDefinitions.

ListLocationCustomAttributesRequest

protected ListLocationCustomAttributesRequest(String visibilityFilter,
                                              io.apimatic.core.types.OptionalNullable<Integer> limit,
                                              io.apimatic.core.types.OptionalNullable<String> cursor,
                                              io.apimatic.core.types.OptionalNullable<Boolean> withDefinitions)

Internal initialization constructor.

Method Detail

getVisibilityFilter

public String getVisibilityFilter()

Getter for VisibilityFilter. Enumeration of visibility-filter values used to set the ability to view custom attributes or custom attribute definitions.

Returns:

Returns the String

internalGetLimit

protected io.apimatic.core.types.OptionalNullable<Integer> internalGetLimit()

Internal Getter for Limit. The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the Internal Integer

getLimit

public Integer getLimit()

Getter for Limit. The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the Integer

internalGetCursor

protected io.apimatic.core.types.OptionalNullable<String> internalGetCursor()

Internal Getter for Cursor. The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the Internal String

getCursor

public String getCursor()

Getter for Cursor. The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the String

internalGetWithDefinitions

protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetWithDefinitions()

Internal Getter for WithDefinitions. Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each custom attribute. Set this parameter to `true` to get the name and description of each custom attribute, information about the data type, or other definition details. The default value is `false`.

Returns:

Returns the Internal Boolean

getWithDefinitions

public Boolean getWithDefinitions()

Getter for WithDefinitions. Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each custom attribute. Set this parameter to `true` to get the name and description of each custom attribute, information about the data type, or other definition details. The default value is `false`.

Returns:

Returns the Boolean

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 ListLocationCustomAttributesRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ListLocationCustomAttributesRequest.Builder toBuilder()

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

Returns:

a new ListLocationCustomAttributesRequest.Builder object