Enum Index.QueryScope (3.12.0)

public enum Index.QueryScope extends Enum<Index.QueryScope> implements ProtocolMessageEnum

Query Scope defines the scope at which a query is run. This is specified on a StructuredQuery's from field.

Protobuf enum google.firestore.admin.v1.Index.QueryScope

Implements

ProtocolMessageEnum

Static Fields

NameDescription
COLLECTION

Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the collection id specified by the index.

COLLECTION = 1;

COLLECTION_GROUP

Indexes with a collection group query scope specified allow queries against all collections that has the collection id specified by the index.

COLLECTION_GROUP = 2;

COLLECTION_GROUP_VALUE

Indexes with a collection group query scope specified allow queries against all collections that has the collection id specified by the index.

COLLECTION_GROUP = 2;

COLLECTION_RECURSIVE

Include all the collections's ancestor in the index. Only available for Datastore Mode databases.

COLLECTION_RECURSIVE = 3;

COLLECTION_RECURSIVE_VALUE

Include all the collections's ancestor in the index. Only available for Datastore Mode databases.

COLLECTION_RECURSIVE = 3;

COLLECTION_VALUE

Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the collection id specified by the index.

COLLECTION = 1;

QUERY_SCOPE_UNSPECIFIED

The query scope is unspecified. Not a valid option.

QUERY_SCOPE_UNSPECIFIED = 0;

QUERY_SCOPE_UNSPECIFIED_VALUE

The query scope is unspecified. Not a valid option.

QUERY_SCOPE_UNSPECIFIED = 0;

UNRECOGNIZED

Static Methods

NameDescription
forNumber(int value)
getDescriptor()
internalGetValueMap()
valueOf(Descriptors.EnumValueDescriptor desc)
valueOf(int value)

Deprecated. Use #forNumber(int) instead.

valueOf(String name)
values()

Methods

NameDescription
getDescriptorForType()
getNumber()
getValueDescriptor()