com.box.sdkgen.managers.listcollaborations

Class GetCollaborationsQueryParams

Object

GetCollaborationsQueryParams

public class GetCollaborationsQueryParams
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetCollaborationsQueryParams.Builder

Field Summary

Fields

Modifier and Type	Field and Description
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<GetCollaborationsQueryParamsStatusField>	status The status of the collaborations to retrieve.

Constructor Summary

Constructors

Modifier	Constructor and Description
	GetCollaborationsQueryParams(EnumWrapper<GetCollaborationsQueryParamsStatusField> status)
protected	GetCollaborationsQueryParams(GetCollaborationsQueryParams.Builder builder)
	GetCollaborationsQueryParams(GetCollaborationsQueryParamsStatusField status)

Method Summary

Modifier and Type	Method and Description
List<String>	getFields()
Long	getLimit()
Long	getOffset()
EnumWrapper<GetCollaborationsQueryParamsStatusField>	getStatus()

Methods inherited from class Object

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

Field Detail

status

public final EnumWrapper<GetCollaborationsQueryParamsStatusField> status

The status of the collaborations to retrieve.

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.

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.

limit

public Long limit

The maximum number of items to return per page.

Constructor Detail

GetCollaborationsQueryParams

public GetCollaborationsQueryParams(GetCollaborationsQueryParamsStatusField status)

GetCollaborationsQueryParams

public GetCollaborationsQueryParams(EnumWrapper<GetCollaborationsQueryParamsStatusField> status)

GetCollaborationsQueryParams

protected GetCollaborationsQueryParams(GetCollaborationsQueryParams.Builder builder)

Method Detail

getStatus

public EnumWrapper<GetCollaborationsQueryParamsStatusField> getStatus()

getFields

public List<String> getFields()

getOffset

public Long getOffset()

getLimit

public Long getLimit()