com.box.sdkgen.schemas.users

Class Users

Object

NullableFieldTracker

SerializableObject

Users

All Implemented Interfaces:

Serializable

public class Users
extends SerializableObject

A list of users.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Users.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected List<UserFull>	entries A list of users.
protected Long	limit The limit that was used for these entries.
protected String	nextMarker The marker for the start of the next page of results.
protected Long	offset The 0-based offset of the first entry in this set.
protected List<UsersOrderField>	order The order by which items are returned.
protected String	prevMarker The marker for the start of the previous page of results.
protected Long	totalCount One greater than the offset of the last entry in the entire collection.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<UserFull>	getEntries()
Long	getLimit()
String	getNextMarker()
Long	getOffset()
List<UsersOrderField>	getOrder()
String	getPrevMarker()
Long	getTotalCount()
int	hashCode()
String	toString()

Methods inherited from class SerializableObject

getRawData, setRawData

Methods inherited from class NullableFieldTracker

getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

limit

protected Long limit

The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.

nextMarker

protected String nextMarker

The marker for the start of the next page of results.

prevMarker

protected String prevMarker

The marker for the start of the previous page of results.

totalCount

protected Long totalCount

One greater than the offset of the last entry in the entire collection. The total number of entries in the collection may be less than `total_count`.

This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.

offset

protected Long offset

The 0-based offset of the first entry in this set. This will be the same as the `offset` query parameter.

This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.

order

protected List<UsersOrderField> order

The order by which items are returned.

This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.

entries

protected List<UserFull> entries

A list of users.

Constructor Detail

Users

public Users()

Users

protected Users(Users.Builder builder)

Method Detail

getLimit

public Long getLimit()

getNextMarker

public String getNextMarker()

getPrevMarker

public String getPrevMarker()

getTotalCount

public Long getTotalCount()

getOffset

public Long getOffset()

getOrder

public List<UsersOrderField> getOrder()

getEntries

public List<UserFull> getEntries()

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