com.box.sdkgen.managers.folders

Class GetFolderItemsQueryParams

Object

GetFolderItemsQueryParams

public class GetFolderItemsQueryParams
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetFolderItemsQueryParams.Builder

Field Summary

Fields

Modifier and Type	Field and Description
EnumWrapper<GetFolderItemsQueryParamsDirectionField>	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<GetFolderItemsQueryParamsSortField>	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
	GetFolderItemsQueryParams()
protected	GetFolderItemsQueryParams(GetFolderItemsQueryParams.Builder builder)

Method Summary

Modifier and Type	Method and Description
EnumWrapper<GetFolderItemsQueryParamsDirectionField>	getDirection()
List<String>	getFields()
Long	getLimit()
String	getMarker()
Long	getOffset()
EnumWrapper<GetFolderItemsQueryParamsSortField>	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.

Additionally this field can be used to query any metadata applied to the file by specifying the `metadata` field as well as the scope and key of the template to retrieve, for example `?fields=metadata.enterprise_12345.contractTemplate`.

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`.

offset

public Long offset

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

Offset-based pagination is not guaranteed to work reliably for high offset values and may fail for large datasets. In those cases, use marker-based pagination by setting `usemarker` to `true`.

limit

public Long limit

The maximum number of items to return per page.

sort

public EnumWrapper<GetFolderItemsQueryParamsSortField> sort

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

The folder type affects the way the items are sorted:

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

* **Root folder**: This parameter is not supported for marker-based pagination on the root folder

(the folder with an `id` of `0`).

* **Shared folder with parent path to the associated folder visible to the collaborator**: Items are always sorted by their `type` first, with folders listed before files, and files listed before web links.

direction

public EnumWrapper<GetFolderItemsQueryParamsDirectionField> direction

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

Constructor Detail

GetFolderItemsQueryParams

public GetFolderItemsQueryParams()

GetFolderItemsQueryParams

protected GetFolderItemsQueryParams(GetFolderItemsQueryParams.Builder builder)

Method Detail

getFields

public List<String> getFields()

getUsemarker

public Boolean getUsemarker()

getMarker

public String getMarker()

getOffset

public Long getOffset()

getLimit

public Long getLimit()

getSort

public EnumWrapper<GetFolderItemsQueryParamsSortField> getSort()

getDirection

public EnumWrapper<GetFolderItemsQueryParamsDirectionField> getDirection()