com.box.sdkgen.managers.folders

Class GetFolderByIdQueryParams

Object

GetFolderByIdQueryParams

public class GetFolderByIdQueryParams
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetFolderByIdQueryParams.Builder

Field Summary

Fields

Modifier and Type	Field and Description
EnumWrapper<GetFolderByIdQueryParamsDirectionField>	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.
Long	offset The offset of the item at which to begin the response.
EnumWrapper<GetFolderByIdQueryParamsSortField>	sort Defines the **second** attribute by which items are sorted.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
EnumWrapper<GetFolderByIdQueryParamsDirectionField>	getDirection()
List<String>	getFields()
Long	getLimit()
Long	getOffset()
EnumWrapper<GetFolderByIdQueryParamsSortField>	getSort()

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

sort

public EnumWrapper<GetFolderByIdQueryParamsSortField> 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<GetFolderByIdQueryParamsDirectionField> direction

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

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, reduce the number of items in the folder (for example, by restructuring the folder into smaller subfolders) before retrying the request.

limit

public Long limit

The maximum number of items to return per page.

Constructor Detail

GetFolderByIdQueryParams

public GetFolderByIdQueryParams()

GetFolderByIdQueryParams

protected GetFolderByIdQueryParams(GetFolderByIdQueryParams.Builder builder)

Method Detail

getFields

public List<String> getFields()

getSort

public EnumWrapper<GetFolderByIdQueryParamsSortField> getSort()

getDirection

public EnumWrapper<GetFolderByIdQueryParamsDirectionField> getDirection()

getOffset

public Long getOffset()

getLimit

public Long getLimit()