com.box.sdkgen.managers.trasheditems

Class GetTrashedItemsQueryParams

Object

GetTrashedItemsQueryParams

public class GetTrashedItemsQueryParams
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetTrashedItemsQueryParams.Builder

Field Summary

Fields

Modifier and Type	Field and Description
EnumWrapper<GetTrashedItemsQueryParamsDirectionField>	direction The direction to sort results in.
List<String>	fields A comma-separated list of attributes to include in the response.
Long	limit The maximum number of items to return per page.
String	marker Defines the position marker at which to begin returning results.
Long	offset The offset of the item at which to begin the response.
EnumWrapper<GetTrashedItemsQueryParamsSortField>	sort Defines the **second** attribute by which items are sorted.
Boolean	usemarker Specifies whether to use marker-based pagination instead of offset-based pagination.

Constructor Summary

Constructors

Modifier	Constructor and Description
	GetTrashedItemsQueryParams()
protected	GetTrashedItemsQueryParams(GetTrashedItemsQueryParams.Builder builder)

Method Summary

Modifier and Type	Method and Description
EnumWrapper<GetTrashedItemsQueryParamsDirectionField>	getDirection()
List<String>	getFields()
Long	getLimit()
String	getMarker()
Long	getOffset()
EnumWrapper<GetTrashedItemsQueryParamsSortField>	getSort()
Boolean	getUsemarker()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

fields

public List<String> fields

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

limit

public Long limit

The maximum number of items to return per page.

offset

public Long offset

The offset of the item at which to begin the response.

Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.

usemarker

public Boolean usemarker

Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time.

By setting this value to true, the API will return a `marker` field that can be passed as a parameter to this endpoint to get the next page of the response.

marker

public String marker

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires `usemarker` to be set to `true`.

direction

public EnumWrapper<GetTrashedItemsQueryParamsDirectionField> direction

The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order.

sort

public EnumWrapper<GetTrashedItemsQueryParamsSortField> sort

Defines the **second** attribute by which items are sorted.

Items are always sorted by their `type` first, with folders listed before files, and files listed before web links.

This parameter is not supported when using marker-based pagination.

Constructor Detail

GetTrashedItemsQueryParams

public GetTrashedItemsQueryParams()

GetTrashedItemsQueryParams

protected GetTrashedItemsQueryParams(GetTrashedItemsQueryParams.Builder builder)

Method Detail

getFields

public List<String> getFields()

getLimit

public Long getLimit()

getOffset

public Long getOffset()

getUsemarker

public Boolean getUsemarker()

getMarker

public String getMarker()

getDirection

public EnumWrapper<GetTrashedItemsQueryParamsDirectionField> getDirection()

getSort

public EnumWrapper<GetTrashedItemsQueryParamsSortField> getSort()