public class MetadataQuery extends SerializableObject
| Modifier and Type | Class and Description |
|---|---|
static class |
MetadataQuery.Builder |
| 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`.
|
explicitlySetNullableFields| Modifier | Constructor and Description |
|---|---|
protected |
MetadataQuery(MetadataQuery.Builder builder) |
|
MetadataQuery(String from,
String ancestorFolderId) |
| 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() |
getRawData, setRawDatagetExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSetprotected final String from
protected String query
For example, a value of `:amount` would represent the `amount` value in `query_params` object.
protected Map<String,Object> queryParams
protected final String ancestorFolderId
protected List<MetadataQueryOrderByField> orderBy
The ordering `direction` must be the same for each item in the array.
protected Long limit
protected List<String> fields
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.
public MetadataQuery(String from, String ancestorFolderId)
protected MetadataQuery(MetadataQuery.Builder builder)
public Map<String,Object> getQueryParams()
public String getAncestorFolderId()
public List<MetadataQueryOrderByField> getOrderBy()