Package io.voucherify.client.model

Class TrashBinListResponseBody

java.lang.Object

io.voucherify.client.model.TrashBinListResponseBody

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

Retrieves a list of the resources moved the bin.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TrashBinListResponseBody.CustomTypeAdapterFactory
static enum	TrashBinListResponseBody.DataRefEnum	Identifies the name of the attribute that contains the array of bin entry objects.
static enum	TrashBinListResponseBody.ObjectEnum	The type of the object represented by JSON.

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_MORE_STARTING_AFTER
static final String	SERIALIZED_NAME_OBJECT
static final String	SERIALIZED_NAME_TOTAL

Constructor Summary

Constructors

Constructor	Description
TrashBinListResponseBody()

Method Summary

Modifier and Type	Method	Description
TrashBinListResponseBody	_object(TrashBinListResponseBody.ObjectEnum _object)
TrashBinListResponseBody	addDataItem(TrashBinItem dataItem)
TrashBinListResponseBody	data(List<TrashBinItem> data)
TrashBinListResponseBody	dataRef(TrashBinListResponseBody.DataRefEnum dataRef)
boolean	equals(Object o)
static TrashBinListResponseBody	fromJson(String jsonString)	Create an instance of TrashBinListResponseBody given an JSON string
List<TrashBinItem>	getData()	Array of bin entry objects.
TrashBinListResponseBody.DataRefEnum	getDataRef()	Identifies the name of the attribute that contains the array of bin entry 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	getMoreStartingAfter()	If `has_more` is `true`, it returns an ID that can be used to return another page of results.
TrashBinListResponseBody.ObjectEnum	getObject()	The type of the object represented by JSON.
Integer	getTotal()	The total number of bin entries.
int	hashCode()
TrashBinListResponseBody	hasMore(Boolean hasMore)
TrashBinListResponseBody	moreStartingAfter(String moreStartingAfter)
void	setData(List<TrashBinItem> data)
void	setDataRef(TrashBinListResponseBody.DataRefEnum dataRef)
void	setHasMore(Boolean hasMore)
void	setMoreStartingAfter(String moreStartingAfter)
void	setObject(TrashBinListResponseBody.ObjectEnum _object)
void	setTotal(Integer total)
String	toJson()	Convert an instance of TrashBinListResponseBody to an JSON string
String	toString()
TrashBinListResponseBody	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

SERIALIZED_NAME_MORE_STARTING_AFTER

public static final String SERIALIZED_NAME_MORE_STARTING_AFTER

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

TrashBinListResponseBody

public TrashBinListResponseBody()

Method Details

_object

public TrashBinListResponseBody _object(TrashBinListResponseBody.ObjectEnum _object)

getObject

@Nullable
public TrashBinListResponseBody.ObjectEnum getObject()

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

Returns:

_object

setObject

public void setObject(TrashBinListResponseBody.ObjectEnum _object)

dataRef

public TrashBinListResponseBody dataRef(TrashBinListResponseBody.DataRefEnum dataRef)

getDataRef

@Nullable
public TrashBinListResponseBody.DataRefEnum getDataRef()

Identifies the name of the attribute that contains the array of bin entry objects.

Returns:

dataRef

setDataRef

public void setDataRef(TrashBinListResponseBody.DataRefEnum dataRef)

data

public TrashBinListResponseBody data(List<TrashBinItem> data)

addDataItem

public TrashBinListResponseBody addDataItem(TrashBinItem dataItem)

getData

@Nullable
public List<TrashBinItem> getData()

Array of bin entry objects.

Returns:

data

setData

public void setData(List<TrashBinItem> data)

total

public TrashBinListResponseBody total(Integer total)

getTotal

@Nullable
public Integer getTotal()

The total number of bin entries. This is the number of the entries returned in the array, not the number of all matching results or all resources currently moved to the bin.

Returns:

total

setTotal

public void setTotal(Integer total)

hasMore

public TrashBinListResponseBody 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 `starting_after_id` query or a different limit to get more records returned in the results.

Returns:

hasMore

setHasMore

public void setHasMore(Boolean hasMore)

moreStartingAfter

public TrashBinListResponseBody moreStartingAfter(String moreStartingAfter)

getMoreStartingAfter

@Nullable
public String getMoreStartingAfter()

If `has_more` is `true`, it returns an ID that can be used to return another page of results. Use the ID in the `starting_after_id` query parameter to display another page of the results occuring after the field with that ID.

Returns:

moreStartingAfter

setMoreStartingAfter

public void setMoreStartingAfter(String moreStartingAfter)

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 TrashBinListResponseBody fromJson(String jsonString)
                                         throws IOException

Create an instance of TrashBinListResponseBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of TrashBinListResponseBody

Throws:

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

toJson

public String toJson()

Convert an instance of TrashBinListResponseBody to an JSON string

Returns:

JSON string