com.google.api.services.firestore.v1.model

Class StructuredQuery

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.firestore.v1.model.StructuredQuery

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class StructuredQuery
extends com.google.api.client.json.GenericJson

A Firestore query.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Firestore API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
StructuredQuery()

Method Summary

Modifier and Type	Method and Description
StructuredQuery	clone()
Cursor	getEndAt() A end point for the query results.
java.util.List<CollectionSelector>	getFrom() The collections to query.
java.lang.Integer	getLimit() The maximum number of results to return.
java.lang.Integer	getOffset() The number of results to skip.
java.util.List<Order>	getOrderBy() The order to apply to the query results.
Projection	getSelect() The projection to return.
Cursor	getStartAt() A starting point for the query results.
Filter	getWhere() The filter to apply.
StructuredQuery	set(java.lang.String fieldName, java.lang.Object value)
StructuredQuery	setEndAt(Cursor endAt) A end point for the query results.
StructuredQuery	setFrom(java.util.List<CollectionSelector> from) The collections to query.
StructuredQuery	setLimit(java.lang.Integer limit) The maximum number of results to return.
StructuredQuery	setOffset(java.lang.Integer offset) The number of results to skip.
StructuredQuery	setOrderBy(java.util.List<Order> orderBy) The order to apply to the query results.
StructuredQuery	setSelect(Projection select) The projection to return.
StructuredQuery	setStartAt(Cursor startAt) A starting point for the query results.
StructuredQuery	setWhere(Filter where) The filter to apply.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

StructuredQuery

public StructuredQuery()

Method Detail

getEndAt

public Cursor getEndAt()

A end point for the query results.

Returns:

value or null for none

setEndAt

public StructuredQuery setEndAt(Cursor endAt)

A end point for the query results.

Parameters:

endAt - endAt or null for none

getFrom

public java.util.List<CollectionSelector> getFrom()

The collections to query.

Returns:

value or null for none

setFrom

public StructuredQuery setFrom(java.util.List<CollectionSelector> from)

The collections to query.

Parameters:

from - from or null for none

getLimit

public java.lang.Integer getLimit()

The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified.

Returns:

value or null for none

setLimit

public StructuredQuery setLimit(java.lang.Integer limit)

The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified.

Parameters:

limit - limit or null for none

getOffset

public java.lang.Integer getOffset()

The number of results to skip. Applies before limit, but after all other constraints. Must be >= 0 if specified.

Returns:

value or null for none

setOffset

public StructuredQuery setOffset(java.lang.Integer offset)

The number of results to skip. Applies before limit, but after all other constraints. Must be >= 0 if specified.

Parameters:

offset - offset or null for none

getOrderBy

public java.util.List<Order> getOrderBy()

The order to apply to the query results. Firestore guarantees a stable ordering through the following rules: * Any field required to appear in `order_by`, that is not already specified in `order_by`, is appended to the order in field name order by default. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `SELECT * FROM Foo ORDER BY A` becomes `SELECT * FROM Foo ORDER BY A, __name__` * `SELECT * FROM Foo ORDER BY A DESC` becomes `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC` * `SELECT * FROM Foo WHERE A > 1` becomes `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__`

Returns:

value or null for none

setOrderBy

public StructuredQuery setOrderBy(java.util.List<Order> orderBy)

The order to apply to the query results. Firestore guarantees a stable ordering through the following rules: * Any field required to appear in `order_by`, that is not already specified in `order_by`, is appended to the order in field name order by default. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `SELECT * FROM Foo ORDER BY A` becomes `SELECT * FROM Foo ORDER BY A, __name__` * `SELECT * FROM Foo ORDER BY A DESC` becomes `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC` * `SELECT * FROM Foo WHERE A > 1` becomes `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__`

Parameters:

orderBy - orderBy or null for none

getSelect

public Projection getSelect()

The projection to return.

Returns:

value or null for none

setSelect

public StructuredQuery setSelect(Projection select)

The projection to return.

Parameters:

select - select or null for none

getStartAt

public Cursor getStartAt()

A starting point for the query results.

Returns:

value or null for none

setStartAt

public StructuredQuery setStartAt(Cursor startAt)

A starting point for the query results.

Parameters:

startAt - startAt or null for none

getWhere

public Filter getWhere()

The filter to apply.

Returns:

value or null for none

setWhere

public StructuredQuery setWhere(Filter where)

The filter to apply.

Parameters:

where - where or null for none

set

public StructuredQuery set(java.lang.String fieldName,
                           java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public StructuredQuery clone()

Overrides:

clone in class com.google.api.client.json.GenericJson