com.box.sdkgen.schemas.searchresults

Class SearchResults

Object

NullableFieldTracker

SerializableObject

SearchResults

All Implemented Interfaces:

Serializable

public class SearchResults
extends SerializableObject

A list of files, folders and web links that matched the search query.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchResults.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected List<SearchResultItem>	entries The search results for the query provided.
protected Long	limit The limit that was used for this search.
protected Long	offset The 0-based offset of the first entry in this set.
protected Long	totalCount One greater than the offset of the last entry in the search results.
protected EnumWrapper<SearchResultsTypeField>	type Specifies the response as search result items without shared links.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<SearchResultItem>	getEntries()
Long	getLimit()
Long	getOffset()
Long	getTotalCount()
EnumWrapper<SearchResultsTypeField>	getType()
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

totalCount

protected Long totalCount

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

limit

protected Long limit

The limit that was used for this search. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed.

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

type

protected EnumWrapper<SearchResultsTypeField> type

Specifies the response as search result items without shared links.

entries

protected List<SearchResultItem> entries

The search results for the query provided.

Constructor Detail

SearchResults

public SearchResults()

SearchResults

protected SearchResults(SearchResults.Builder builder)

Method Detail

getTotalCount

public Long getTotalCount()

getLimit

public Long getLimit()

getOffset

public Long getOffset()

getType

public EnumWrapper<SearchResultsTypeField> getType()

getEntries

public List<SearchResultItem> 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