Package io.voucherify.client.model

Class LocationsListResponseBody

java.lang.Object

io.voucherify.client.model.LocationsListResponseBody

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class LocationsListResponseBody
extends Object

Response schema for listing locations using **GET** `v1/locations`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LocationsListResponseBody.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_DATA
static final String	SERIALIZED_NAME_DATA_REF
static final String	SERIALIZED_NAME_HAS_MORE
static final String	SERIALIZED_NAME_OBJECT
static final String	SERIALIZED_NAME_TOTAL

Constructor Summary

Constructors

Constructor	Description
LocationsListResponseBody()

Method Summary

Modifier and Type	Method	Description
LocationsListResponseBody	_object(String _object)
LocationsListResponseBody	addDataItem(Location dataItem)
LocationsListResponseBody	data(List<Location> data)
LocationsListResponseBody	dataRef(String dataRef)
boolean	equals(Object o)
static LocationsListResponseBody	fromJson(String jsonString)	Create an instance of LocationsListResponseBody given an JSON string
List<Location>	getData()	Array of location objects.
String	getDataRef()	Identifies the name of the attribute that contains the array of metadata schema objects.
Boolean	getHasMore()	As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters.
String	getObject()	The type of the object represented by JSON.
Integer	getTotal()	Total number of locations.
int	hashCode()
LocationsListResponseBody	hasMore(Boolean hasMore)
void	setData(List<Location> data)
void	setDataRef(String dataRef)
void	setHasMore(Boolean hasMore)
void	setObject(String _object)
void	setTotal(Integer total)
String	toJson()	Convert an instance of LocationsListResponseBody to an JSON string
String	toString()
LocationsListResponseBody	total(Integer total)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_OBJECT

public static final String SERIALIZED_NAME_OBJECT

See Also:

• Constant Field Values

SERIALIZED_NAME_DATA_REF

public static final String SERIALIZED_NAME_DATA_REF

See Also:

• Constant Field Values

SERIALIZED_NAME_DATA

public static final String SERIALIZED_NAME_DATA

See Also:

• Constant Field Values

SERIALIZED_NAME_TOTAL

public static final String SERIALIZED_NAME_TOTAL

See Also:

• Constant Field Values

SERIALIZED_NAME_HAS_MORE

public static final String SERIALIZED_NAME_HAS_MORE

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

LocationsListResponseBody

public LocationsListResponseBody()

Method Details

_object

public LocationsListResponseBody _object(String _object)

getObject

@Nullable
public String getObject()

The type of the object represented by JSON. This object stores information about locations in a dictionary.

Returns:

_object

setObject

public void setObject(String _object)

dataRef

public LocationsListResponseBody dataRef(String dataRef)

getDataRef

@Nullable
public String getDataRef()

Identifies the name of the attribute that contains the array of metadata schema objects.

Returns:

dataRef

setDataRef

public void setDataRef(String dataRef)

data

public LocationsListResponseBody data(List<Location> data)

addDataItem

public LocationsListResponseBody addDataItem(Location dataItem)

getData

@Nullable
public List<Location> getData()

Array of location objects.

Returns:

data

setData

public void setData(List<Location> data)

total

public LocationsListResponseBody total(Integer total)

getTotal

@Nullable
public Integer getTotal()

Total number of locations.

Returns:

total

setTotal

public void setTotal(Integer total)

hasMore

public LocationsListResponseBody hasMore(Boolean hasMore)

getHasMore

@Nullable
public Boolean getHasMore()

As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request (with a different end date filter) to get more records returned in the results.

Returns:

hasMore

setHasMore

public void setHasMore(Boolean hasMore)

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

fromJson

public static LocationsListResponseBody fromJson(String jsonString)
                                          throws IOException

Create an instance of LocationsListResponseBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of LocationsListResponseBody

Throws:

IOException - if the JSON string is invalid with respect to LocationsListResponseBody

toJson

public String toJson()

Convert an instance of LocationsListResponseBody to an JSON string

Returns:

JSON string