com.box.sdkgen.schemas.metadataquery

Class MetadataQuery

Object

NullableFieldTracker

SerializableObject

MetadataQuery

All Implemented Interfaces:

Serializable

public class MetadataQuery
extends SerializableObject

Create a search using SQL-like syntax to return items that match specific metadata.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetadataQuery.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected String	ancestorFolderId The ID of the folder that you are restricting the query to.
protected List<String>	fields By default, this endpoint returns only the most basic info about the items for which the query matches.
protected String	from Specifies the template used in the query.
protected Long	limit A value between 0 and 100 that indicates the maximum number of results to return for a single request.
protected String	marker Marker to use for requesting the next page.
protected List<MetadataQueryOrderByField>	orderBy A list of template fields and directions to sort the metadata query results by.
protected String	query The query to perform.
protected Map<String,Object>	queryParams Set of arguments corresponding to the parameters specified in the `query`.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetadataQuery(MetadataQuery.Builder builder)
	MetadataQuery(String from, String ancestorFolderId)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getAncestorFolderId()
List<String>	getFields()
String	getFrom()
Long	getLimit()
String	getMarker()
List<MetadataQueryOrderByField>	getOrderBy()
String	getQuery()
Map<String,Object>	getQueryParams()
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

from

protected final String from

Specifies the template used in the query. Must be in the form `scope.templateKey`. Not all templates can be used in this field, most notably the built-in, Box-provided classification templates can not be used in a query.

query

protected String query

The query to perform. A query is a logical expression that is very similar to a SQL `SELECT` statement. Values in the search query can be turned into parameters specified in the `query_param` arguments list to prevent having to manually insert search values into the query string.

For example, a value of `:amount` would represent the `amount` value in `query_params` object.

queryParams

protected Map<String,Object> queryParams

Set of arguments corresponding to the parameters specified in the `query`. The type of each parameter used in the `query_params` must match the type of the corresponding metadata template field.

ancestorFolderId

protected final String ancestorFolderId

The ID of the folder that you are restricting the query to. A value of zero will return results from all folders you have access to. A non-zero value will only return results found in the folder corresponding to the ID or in any of its subfolders.

orderBy

protected List<MetadataQueryOrderByField> orderBy

A list of template fields and directions to sort the metadata query results by.

The ordering `direction` must be the same for each item in the array.

limit

protected Long limit

A value between 0 and 100 that indicates the maximum number of results to return for a single request. This only specifies a maximum boundary and will not guarantee the minimum number of results returned.

marker

protected String marker

Marker to use for requesting the next page.

fields

protected List<String> fields

By default, this endpoint returns only the most basic info about the items for which the query matches. This attribute can be used to specify a list of additional attributes to return for any item, including its metadata.

This attribute takes a list of item fields, metadata template identifiers, or metadata template field identifiers.

For example:

* `created_by` will add the details of the user who created the item to the response. * `metadata.<scope>.<templateKey>` will return the mini-representation of the metadata instance identified by the `scope` and `templateKey`. * `metadata.<scope>.<templateKey>.<field>` will return all the mini-representation of the metadata instance identified by the `scope` and `templateKey` plus the field specified by the `field` name. Multiple fields for the same `scope` and `templateKey` can be defined.

Constructor Detail

MetadataQuery

public MetadataQuery(String from,
                     String ancestorFolderId)

MetadataQuery

protected MetadataQuery(MetadataQuery.Builder builder)

Method Detail

getFrom

public String getFrom()

getQuery

public String getQuery()

getQueryParams

public Map<String,Object> getQueryParams()

getAncestorFolderId

public String getAncestorFolderId()

getOrderBy

public List<MetadataQueryOrderByField> getOrderBy()

getLimit

public Long getLimit()

getMarker

public String getMarker()

getFields

public List<String> getFields()

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