Uses of Class
edu.byu.hbll.box.BoxQuery
-
Packages that use BoxQuery Package Description edu.byu.hbll.box edu.byu.hbll.box.client edu.byu.hbll.box.internal.core edu.byu.hbll.box.internal.util -
-
Uses of BoxQuery in edu.byu.hbll.box
Methods in edu.byu.hbll.box that return BoxQuery Modifier and Type Method Description BoxQuery
BoxQuery. addFacet(Facet facet)
Adds filter facets.BoxQuery
BoxQuery. addFacet(String name, String value)
Adds a filter facet.BoxQuery
BoxQuery. addFacets(Facet... facets)
Adds filter facets.BoxQuery
BoxQuery. addFacets(Collection<? extends Facet> facets)
Adds filter facets.BoxQuery
BoxQuery. addField(String field)
Limit the document to only these fields.BoxQuery
BoxQuery. addFields(String... fields)
Limit the document to only these fields.BoxQuery
BoxQuery. addFields(Collection<String> fields)
Limit the document to only these fields.BoxQuery
BoxQuery. addId(String id)
Adds an id to this query.BoxQuery
BoxQuery. addIds(String... ids)
Adds ids to this query.BoxQuery
BoxQuery. addIds(Collection<String> ids)
Adds ids to this query.BoxQuery
BoxQuery. addStatus(BoxDocument.Status status)
Queries by these document statuses.BoxQuery
BoxQuery. addStatuses(BoxDocument.Status... statuses)
Queries by these document statuses.BoxQuery
BoxQuery. addStatuses(Collection<BoxDocument.Status> statuses)
Queries by these document statuses.BoxQuery
BoxQuery. clearFacets()
Clears all the facets.BoxQuery
BoxQuery. clearFields()
Clears all the fields.BoxQuery
BoxQuery. clearIds()
Clears all the ids.BoxQuery
BoxQuery. clearStatuses()
Clears all the statuses.BoxQuery
BoxQuery. setCursor(long cursor)
Sets the cursor.BoxQuery
BoxQuery. setCursor(Long cursor)
Sets the cursor.BoxQuery
BoxQuery. setDocumentOnly()
Clears any set fields and adds the document field.BoxQuery
BoxQuery. setFacets(Collection<? extends Facet> facets)
Adds filter facets.BoxQuery
BoxQuery. setFields(Collection<String> fields)
Limit the document to only these fields.BoxQuery
BoxQuery. setLimit(long limit)
Limits the number of documents returned to no more than this number.BoxQuery
BoxQuery. setLimit(Long limit)
Limits the number of documents returned to no more than this number.BoxQuery
BoxQuery. setMetadataOnly()
Clears any set fields and adds the box metadata field.BoxQuery
BoxQuery. setProcess(Boolean process)
Whether or not to ask Box to (re)process the document now and return the result.BoxQuery
BoxQuery. setStatuses(Collection<BoxDocument.Status> statuses)
Sets statuses to be queried.BoxQuery
BoxQuery. setUnlimited()
Sets the limit to UNLIMITED.BoxQuery
BoxQuery. setWait(Boolean wait)
Whether or not to wait for Box to process the document before returning.Methods in edu.byu.hbll.box with parameters of type BoxQuery Modifier and Type Method Description QueryResult
QueryResult. updateNextCursor(BoxQuery query)
Updates nextCursor according to the last document in the query result.Constructors in edu.byu.hbll.box with parameters of type BoxQuery Constructor Description BoxQuery(BoxQuery query)
Copy constructor. -
Uses of BoxQuery in edu.byu.hbll.box.client
Methods in edu.byu.hbll.box.client with parameters of type BoxQuery Modifier and Type Method Description QueryResult
AbstractHttpBoxClient. collect(BoxQuery query)
default QueryResult
BoxClient. collect(BoxQuery query)
Collects and returns all documents found according to the given query.Iterable<BoxDocument>
AbstractHttpBoxClient. find(BoxQuery query)
Iterable<BoxDocument>
BoxClient. find(BoxQuery query)
Returns documents found according to the given query in the form of anIterable
.default Stream<BoxDocument>
BoxClient. stream(BoxQuery query)
Returns documents found according to the given query in the form of aStream
. -
Uses of BoxQuery in edu.byu.hbll.box.internal.core
Constructors in edu.byu.hbll.box.internal.core with parameters of type BoxQuery Constructor Description DocumentIterable(BoxQuery query, int batchSize, Function<BoxQuery,QueryResult> retriever)
Creates a newDocumentIterable
.DocumentIterable(BoxQuery query, Function<BoxQuery,QueryResult> retriever)
Creates a newDocumentIterable
with default batch size.Constructor parameters in edu.byu.hbll.box.internal.core with type arguments of type BoxQuery Constructor Description DocumentIterable(BoxQuery query, int batchSize, Function<BoxQuery,QueryResult> retriever)
Creates a newDocumentIterable
.DocumentIterable(BoxQuery query, Function<BoxQuery,QueryResult> retriever)
Creates a newDocumentIterable
with default batch size. -
Uses of BoxQuery in edu.byu.hbll.box.internal.util
Methods in edu.byu.hbll.box.internal.util with parameters of type BoxQuery Modifier and Type Method Description static URI
BoxUriBuilder. buildQuery(URI uri, BoxQuery query)
Builds a finalURI
given the base uri and query.
-