Index

A B C D E F G H I L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

add(DocumentSnapshot) - Method in class com.google.cloud.firestore.FirestoreBundle.Builder

Adds a Firestore document snapshot to the bundle.

add(Object) - Method in class com.google.cloud.firestore.CollectionReference

Adds a new document to this collection with the specified POJO as contents, assigning it a document ID automatically.

add(String, QuerySnapshot) - Method in class com.google.cloud.firestore.FirestoreBundle.Builder

Adds a Firestore query snapshot to the bundle.

add(Map<String, Object>) - Method in class com.google.cloud.firestore.CollectionReference

Adds a new document to this collection with the specified data, assigning it a document ID automatically.

ADDED - Enum constant in enum com.google.cloud.firestore.DocumentChange.Type

Indicates a new document was added to the set of documents matching the query.

addSnapshotListener(EventListener<DocumentSnapshot>) - Method in class com.google.cloud.firestore.DocumentReference

Starts listening to the document referenced by this DocumentReference.

addSnapshotListener(EventListener<QuerySnapshot>) - Method in class com.google.cloud.firestore.Query

Starts listening to this query.

addSnapshotListener(Executor, EventListener<DocumentSnapshot>) - Method in class com.google.cloud.firestore.DocumentReference

Starts listening to the document referenced by this DocumentReference.

addSnapshotListener(Executor, EventListener<QuerySnapshot>) - Method in class com.google.cloud.firestore.Query

Starts listening to this query.

addWriteErrorListener(BulkWriter.WriteErrorCallback) - Method in class com.google.cloud.firestore.BulkWriter

Attaches an error handler listener that is run every time a BulkWriter operation fails.

addWriteErrorListener(Executor, BulkWriter.WriteErrorCallback) - Method in class com.google.cloud.firestore.BulkWriter

Attaches an error handler listener that is run every time a BulkWriter operation fails.

addWriteResultListener(BulkWriter.WriteResultCallback) - Method in class com.google.cloud.firestore.BulkWriter

Attaches a listener that is run every time a BulkWriter operation successfully completes.

addWriteResultListener(Executor, BulkWriter.WriteResultCallback) - Method in class com.google.cloud.firestore.BulkWriter

Attaches a listener that is run every time a BulkWriter operation successfully completes.

aggregate(AggregateField, AggregateField...) - Method in class com.google.cloud.firestore.Query

Calculates the specified aggregations over the documents in the result set of the given query without actually downloading the documents.

AggregateField - Class in com.google.cloud.firestore

Represents an aggregation that can be performed by Firestore.

AggregateField() - Constructor for class com.google.cloud.firestore.AggregateField

AggregateField.AverageAggregateField - Class in com.google.cloud.firestore

Represents an "average" aggregation that can be performed by Firestore.

AggregateField.CountAggregateField - Class in com.google.cloud.firestore

Represents a "count" aggregation that can be performed by Firestore.

AggregateField.SumAggregateField - Class in com.google.cloud.firestore

Represents a "sum" aggregation that can be performed by Firestore.

AggregateQuery - Class in com.google.cloud.firestore

A query that calculates aggregations over an underlying query.

AggregateQuerySnapshot - Class in com.google.cloud.firestore

The results of executing an AggregateQuery.

and(Filter...) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter that is a conjunction of the given filters.

applyToAllUnaryMethods(ApiFunction<UnaryCallSettings.Builder<?, ?>, Void>) - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Applies the given settings updater function to all of the unary API methods in this service.

applyToAllUnaryMethods(ApiFunction<UnaryCallSettings.Builder<?, ?>, Void>) - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Applies the given settings updater function to all of the unary API methods in this service.

arrayContains(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given array field contains the given value.

arrayContains(String, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given array field contains the given value.

arrayContainsAny(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given array field contains any of the given values.

arrayContainsAny(String, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given array field contains any of the given values.

arrayRemove(Object...) - Static method in class com.google.cloud.firestore.FieldValue

Returns a special value that can be used with set(), create() or update() that tells the server to remove the given elements from any array value that already exists on the server.

ArraySortedMap<K,V> - Class in com.google.cloud.firestore.collection

This is an array backed implementation of ImmutableSortedMap.

ArraySortedMap(Comparator<K>) - Constructor for class com.google.cloud.firestore.collection.ArraySortedMap

arrayUnion(Object...) - Static method in class com.google.cloud.firestore.FieldValue

Returns a special value that can be used with set(), create() or update() that tells the server to union the given elements with any array value that already exists on the server.

ASCENDING - Enum constant in enum com.google.cloud.firestore.Query.Direction

autoBuild() - Method in class com.google.cloud.firestore.BulkWriterOptions.Builder

autoId() - Static method in class com.google.cloud.firestore.Internal

average(FieldPath) - Static method in class com.google.cloud.firestore.AggregateField

Create an AggregateField.AverageAggregateField object that can be used to compute the average of a specified field over a range of documents in the result set of a query.

average(String) - Static method in class com.google.cloud.firestore.AggregateField

Create an AggregateField.AverageAggregateField object that can be used to compute the average of a specified field over a range of documents in the result set of a query.

awaitTermination(long, TimeUnit) - Method in class com.google.cloud.firestore.v1.FirestoreClient

awaitTermination(long, TimeUnit) - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

awaitTermination(long, TimeUnit) - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

B

BasePath<B extends BasePath<B>> - Class in com.google.cloud.firestore

BasePath represents a path sequence in the Firestore database.

BasePath() - Constructor for class com.google.cloud.firestore.BasePath

batch() - Method in interface com.google.cloud.firestore.Firestore

Gets a Firestore WriteBatch instance that can be used to combine multiple writes.

batchGetDocumentsCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc

Gets multiple documents.

batchGetDocumentsCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc

batchGetDocumentsCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient

Gets multiple documents.

batchGetDocumentsCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

batchGetDocumentsCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

batchGetDocumentsCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

batchGetDocumentsSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns the object with the settings used for calls to batchGetDocuments.

batchGetDocumentsSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Returns the builder for the settings used for calls to batchGetDocuments.

batchGetDocumentsSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the object with the settings used for calls to batchGetDocuments.

batchGetDocumentsSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Returns the builder for the settings used for calls to batchGetDocuments.

batchWrite(BatchWriteRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient

Applies a batch of write operations.

batchWriteCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc

batchWriteCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc

batchWriteCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient

Applies a batch of write operations.

batchWriteCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

batchWriteCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

batchWriteCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

batchWriteSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns the object with the settings used for calls to batchWrite.

batchWriteSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Returns the builder for the settings used for calls to batchWrite.

batchWriteSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the object with the settings used for calls to batchWrite.

batchWriteSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Returns the builder for the settings used for calls to batchWrite.

beginTransaction(BeginTransactionRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient

Starts a new transaction.

beginTransaction(String) - Method in class com.google.cloud.firestore.v1.FirestoreClient

Starts a new transaction.

beginTransactionCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc

Starts a new transaction.

beginTransactionCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc

beginTransactionCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient

Starts a new transaction.

beginTransactionCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

beginTransactionCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

beginTransactionCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

beginTransactionSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns the object with the settings used for calls to beginTransaction.

beginTransactionSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Returns the builder for the settings used for calls to beginTransaction.

beginTransactionSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the object with the settings used for calls to beginTransaction.

beginTransactionSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Returns the builder for the settings used for calls to beginTransaction.

BLACK - Enum constant in enum com.google.cloud.firestore.collection.LLRBNode.Color

Blob - Class in com.google.cloud.firestore

Immutable class representing an array of bytes in Firestore.

build() - Method in class com.google.cloud.firestore.BulkWriterOptions.Builder

build() - Method in class com.google.cloud.firestore.ExplainOptions.Builder

build() - Method in class com.google.cloud.firestore.FirestoreBundle.Builder

build() - Method in class com.google.cloud.firestore.FirestoreOptions.Builder

build() - Method in class com.google.cloud.firestore.TransactionOptions.Builder

build() - Method in class com.google.cloud.firestore.TransactionOptions.ReadOnlyOptionsBuilder

build() - Method in class com.google.cloud.firestore.TransactionOptions.ReadWriteOptionsBuilder

build() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder

build() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

builder() - Static method in class com.google.cloud.firestore.BulkWriterOptions

builder() - Static method in class com.google.cloud.firestore.ExplainOptions

Builder() - Constructor for class com.google.cloud.firestore.BulkWriterOptions.Builder

Builder() - Constructor for class com.google.cloud.firestore.collection.ImmutableSortedMap.Builder

Builder() - Constructor for class com.google.cloud.firestore.ExplainOptions.Builder

Builder() - Constructor for class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Builder() - Constructor for class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Builder(ClientContext) - Constructor for class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Builder(ClientContext) - Constructor for class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Builder(FirestoreSettings) - Constructor for class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Builder(FirestoreStubSettings) - Constructor for class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Builder(FirestoreStubSettings.Builder) - Constructor for class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Builder(Executor) - Constructor for class com.google.cloud.firestore.TransactionOptions.Builder

buildFrom(List<A>, Map<B, C>, ImmutableSortedMap.Builder.KeyTranslator<A, B>, Comparator<A>) - Static method in class com.google.cloud.firestore.collection.ArraySortedMap

buildFrom(List<A>, Map<B, C>, ImmutableSortedMap.Builder.KeyTranslator<A, B>, Comparator<A>) - Static method in class com.google.cloud.firestore.collection.ImmutableSortedMap.Builder

buildFrom(List<A>, Map<B, C>, ImmutableSortedMap.Builder.KeyTranslator<A, B>, Comparator<A>) - Static method in class com.google.cloud.firestore.collection.RBTreeSortedMap

bulkWriter() - Method in interface com.google.cloud.firestore.Firestore

Creates a BulkWriter instance, used for performing multiple writes in parallel.

bulkWriter(BulkWriterOptions) - Method in interface com.google.cloud.firestore.Firestore

Creates a BulkWriter instance, used for performing multiple writes in parallel.

BulkWriter - Class in com.google.cloud.firestore

A Firestore BulkWriter that can be used to perform a large number of writes in parallel.

BulkWriter.WriteErrorCallback - Interface in com.google.cloud.firestore

A callback set by `addWriteErrorListener()` to be run every time an operation fails and determines if an operation should be retried.

BulkWriter.WriteResultCallback - Interface in com.google.cloud.firestore

A callback set by `addWriteResultListener()` to be run every time an operation successfully completes.

BulkWriterException - Exception in com.google.cloud.firestore

The error thrown when a BulkWriter operation fails.

BulkWriterException(Status, String, DocumentReference, BulkWriter.OperationType, int) - Constructor for exception com.google.cloud.firestore.BulkWriterException

BulkWriterOptions - Class in com.google.cloud.firestore

Options used to configure request throttling in BulkWriter.

BulkWriterOptions() - Constructor for class com.google.cloud.firestore.BulkWriterOptions

BulkWriterOptions.Builder - Class in com.google.cloud.firestore

bundleBuilder() - Method in interface com.google.cloud.firestore.Firestore

Returns a FirestoreBundle.Builder FirestoreBundle.Builder instance using an automatically generated bundle ID.

bundleBuilder(String) - Method in interface com.google.cloud.firestore.Firestore

Returns a FirestoreBundle.Builder FirestoreBundle.Builder instance for the given bundle ID.

C

className() - Method in class com.google.cloud.firestore.Transaction

className() - Method in class com.google.cloud.firestore.UpdateBuilder

close() - Method in class com.google.cloud.firestore.BulkWriter

Commits all enqueued writes and marks the BulkWriter instance as closed.

close() - Method in interface com.google.cloud.firestore.Firestore

Closes the gRPC channels associated with this instance and frees up their resources.

close() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc

close() - Method in class com.google.cloud.firestore.v1.FirestoreClient

close() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

close() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

close() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

collection(String) - Method in class com.google.cloud.firestore.DocumentReference

Gets a CollectionReference instance that refers to the collection that is a child of this document.

collection(String) - Method in interface com.google.cloud.firestore.Firestore

Gets a CollectionReference that refers to the collection at the specified path.

collectionGroup(String) - Method in interface com.google.cloud.firestore.Firestore

Creates and returns a new CollectionGroup that includes all documents in the database that are contained in a collection or subcollection with the given @code{collectionId}.

CollectionGroup - Class in com.google.cloud.firestore

A Collection Group query matches all documents that are contained in a collection or subcollection with a specific collection ID.

CollectionReference - Class in com.google.cloud.firestore

A CollectionReference can be used for adding documents, getting document references, and querying for documents (using the methods inherited from Query).

com.google.cloud.firestore - package com.google.cloud.firestore

com.google.cloud.firestore.annotation - package com.google.cloud.firestore.annotation

com.google.cloud.firestore.collection - package com.google.cloud.firestore.collection

com.google.cloud.firestore.spi.v1 - package com.google.cloud.firestore.spi.v1

com.google.cloud.firestore.v1 - package com.google.cloud.firestore.v1

A client to Cloud Firestore API

com.google.cloud.firestore.v1.stub - package com.google.cloud.firestore.v1.stub

commit() - Method in class com.google.cloud.firestore.WriteBatch

Applies the current WriteBatch and returns an array with WriteResults.

commit(CommitRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient

Commits a transaction, while optionally updating documents.

commit(String, List<Write>) - Method in class com.google.cloud.firestore.v1.FirestoreClient

Commits a transaction, while optionally updating documents.

commitCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc

Commits a transaction, while optionally updating documents.

commitCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc

commitCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient

Commits a transaction, while optionally updating documents.

commitCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

commitCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

commitCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

commitSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Returns the builder for the settings used for calls to commit.

commitSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns the object with the settings used for calls to commit.

commitSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Returns the builder for the settings used for calls to commit.

commitSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the object with the settings used for calls to commit.

committed - Variable in class com.google.cloud.firestore.UpdateBuilder

compareTo(B) - Method in class com.google.cloud.firestore.BasePath

Compare the current path lexicographically against another Path object.

contains(FieldPath) - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns whether or not the field exists in the document.

contains(String) - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns whether or not the field exists in the document.

contains(T) - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet

containsKey(K) - Method in class com.google.cloud.firestore.collection.ArraySortedMap

containsKey(K) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

containsKey(K) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap

copy(K, V, LLRBNode.Color, LLRBNode<K, V>, LLRBNode<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode

copy(K, V, LLRBNode.Color, LLRBNode<K, V>, LLRBNode<K, V>) - Method in interface com.google.cloud.firestore.collection.LLRBNode

copy(K, V, LLRBNode.Color, LLRBNode<K, V>, LLRBNode<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBValueNode

copy(K, V, LLRBNode<K, V>, LLRBNode<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBBlackValueNode

copy(K, V, LLRBNode<K, V>, LLRBNode<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBRedValueNode

copy(K, V, LLRBNode<K, V>, LLRBNode<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBValueNode

count() - Static method in class com.google.cloud.firestore.AggregateField

Create a AggregateField.CountAggregateField object that can be used to compute the count of documents in the result set of a query.

count() - Method in class com.google.cloud.firestore.Query

Returns a query that counts the documents in the result set of this query.

create() - Static method in class com.google.cloud.firestore.TransactionOptions

Create a default set of options suitable for most use cases.

create() - Static method in class com.google.cloud.firestore.v1.FirestoreClient

Constructs an instance of FirestoreClient with default settings.

create(int) - Static method in class com.google.cloud.firestore.TransactionOptions

Deprecated.

as of 2.0.0, replaced by TransactionOptions.ReadWriteOptionsBuilder.setNumberOfAttempts(int)

create(ClientContext) - Static method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

create(ClientContext) - Static method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

create(ClientContext, GrpcStubCallableFactory) - Static method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

create(ClientContext, HttpJsonStubCallableFactory) - Static method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

create(DocumentReference, Object) - Method in class com.google.cloud.firestore.BulkWriter

Create a document with the provided data.

create(DocumentReference, Object) - Method in class com.google.cloud.firestore.UpdateBuilder

Creates a new Document at the DocumentReference location.

create(DocumentReference, Map<String, Object>) - Method in class com.google.cloud.firestore.BulkWriter

Create a document with the provided data.

create(DocumentReference, Map<String, Object>) - Method in class com.google.cloud.firestore.UpdateBuilder

Creates a new Document at the DocumentReference's location.

create(FirestoreOptions) - Method in class com.google.cloud.firestore.FirestoreOptions.DefaultFirestoreFactory

create(FirestoreOptions) - Method in class com.google.cloud.firestore.FirestoreOptions.DefaultFirestoreRpcFactory

create(FirestoreSettings) - Static method in class com.google.cloud.firestore.v1.FirestoreClient

Constructs an instance of FirestoreClient, using the given settings.

create(FirestoreStub) - Static method in class com.google.cloud.firestore.v1.FirestoreClient

Constructs an instance of FirestoreClient, using the given stub for making calls.

create(FirestoreStubSettings) - Static method in class com.google.cloud.firestore.v1.FirestoreSettings

create(FirestoreStubSettings) - Static method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

create(FirestoreStubSettings) - Static method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

create(Object) - Method in class com.google.cloud.firestore.DocumentReference

Creates a new Document at the DocumentReference location.

create(Executor) - Static method in class com.google.cloud.firestore.TransactionOptions

Deprecated.

as of 2.0.0, replaced by TransactionOptions.Builder.setExecutor(Executor)

create(Executor, int) - Static method in class com.google.cloud.firestore.TransactionOptions

Deprecated.

as of 2.0.0, replaced by TransactionOptions.Builder.setExecutor(Executor) and TransactionOptions.ReadWriteOptionsBuilder.setNumberOfAttempts(int)

create(Map<String, Object>) - Method in class com.google.cloud.firestore.DocumentReference

Creates a new Document at the DocumentReference's Location.

createAsync(PageContext<ListCollectionIdsRequest, ListCollectionIdsResponse, String>, ApiFuture<ListCollectionIdsResponse>) - Static method in class com.google.cloud.firestore.v1.FirestoreClient.ListCollectionIdsPagedResponse

createAsync(PageContext<ListDocumentsRequest, ListDocumentsResponse, Document>, ApiFuture<ListDocumentsResponse>) - Static method in class com.google.cloud.firestore.v1.FirestoreClient.ListDocumentsPagedResponse

createAsync(PageContext<PartitionQueryRequest, PartitionQueryResponse, Cursor>, ApiFuture<PartitionQueryResponse>) - Static method in class com.google.cloud.firestore.v1.FirestoreClient.PartitionQueryPagedResponse

createBatchingCallable(GrpcCallSettings<RequestT, ResponseT>, BatchingCallSettings<RequestT, ResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreCallableFactory

createBatchingCallable(HttpJsonCallSettings<RequestT, ResponseT>, BatchingCallSettings<RequestT, ResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreCallableFactory

createBidiStreamingCallable(GrpcCallSettings<RequestT, ResponseT>, StreamingCallSettings<RequestT, ResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreCallableFactory

createClientStreamingCallable(GrpcCallSettings<RequestT, ResponseT>, StreamingCallSettings<RequestT, ResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreCallableFactory

createCollection(List<FirestoreClient.ListCollectionIdsPage>, int) - Method in class com.google.cloud.firestore.v1.FirestoreClient.ListCollectionIdsFixedSizeCollection

createCollection(List<FirestoreClient.ListDocumentsPage>, int) - Method in class com.google.cloud.firestore.v1.FirestoreClient.ListDocumentsFixedSizeCollection

createCollection(List<FirestoreClient.PartitionQueryPage>, int) - Method in class com.google.cloud.firestore.v1.FirestoreClient.PartitionQueryFixedSizeCollection

createDocument(CreateDocumentRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient

Creates a new document.

createDocumentCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient

Creates a new document.

createDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

createDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

createDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

createDocumentSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Returns the builder for the settings used for calls to createDocument.

createDocumentSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns the object with the settings used for calls to createDocument.

createDocumentSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Returns the builder for the settings used for calls to createDocument.

createDocumentSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the object with the settings used for calls to createDocument.

createOperationCallable(GrpcCallSettings<RequestT, Operation>, OperationCallSettings<RequestT, ResponseT, MetadataT>, ClientContext, OperationsStub) - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreCallableFactory

createOperationCallable(HttpJsonCallSettings<RequestT, Operation>, OperationCallSettings<RequestT, ResponseT, MetadataT>, ClientContext, OperationsStub) - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreCallableFactory

createPage(PageContext<ListCollectionIdsRequest, ListCollectionIdsResponse, String>, ListCollectionIdsResponse) - Method in class com.google.cloud.firestore.v1.FirestoreClient.ListCollectionIdsPage

createPage(PageContext<ListDocumentsRequest, ListDocumentsResponse, Document>, ListDocumentsResponse) - Method in class com.google.cloud.firestore.v1.FirestoreClient.ListDocumentsPage

createPage(PageContext<PartitionQueryRequest, PartitionQueryResponse, Cursor>, PartitionQueryResponse) - Method in class com.google.cloud.firestore.v1.FirestoreClient.PartitionQueryPage

createPageAsync(PageContext<ListCollectionIdsRequest, ListCollectionIdsResponse, String>, ApiFuture<ListCollectionIdsResponse>) - Method in class com.google.cloud.firestore.v1.FirestoreClient.ListCollectionIdsPage

createPageAsync(PageContext<ListDocumentsRequest, ListDocumentsResponse, Document>, ApiFuture<ListDocumentsResponse>) - Method in class com.google.cloud.firestore.v1.FirestoreClient.ListDocumentsPage

createPageAsync(PageContext<PartitionQueryRequest, PartitionQueryResponse, Cursor>, ApiFuture<PartitionQueryResponse>) - Method in class com.google.cloud.firestore.v1.FirestoreClient.PartitionQueryPage

createPagedCallable(GrpcCallSettings<RequestT, ResponseT>, PagedCallSettings<RequestT, ResponseT, PagedListResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreCallableFactory

createPagedCallable(HttpJsonCallSettings<RequestT, ResponseT>, PagedCallSettings<RequestT, ResponseT, PagedListResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreCallableFactory

createQuery() - Method in class com.google.cloud.firestore.QueryPartition

Returns a query that only returns the documents for this partition.

createReadOnlyOptionsBuilder() - Static method in class com.google.cloud.firestore.TransactionOptions

createReadWriteOptionsBuilder() - Static method in class com.google.cloud.firestore.TransactionOptions

createServerStreamingCallable(GrpcCallSettings<RequestT, ResponseT>, ServerStreamingCallSettings<RequestT, ResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreCallableFactory

createServerStreamingCallable(HttpJsonCallSettings<RequestT, ResponseT>, ServerStreamingCallSettings<RequestT, ResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreCallableFactory

createStub() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

createUnaryCallable(GrpcCallSettings<RequestT, ResponseT>, UnaryCallSettings<RequestT, ResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreCallableFactory

createUnaryCallable(HttpJsonCallSettings<RequestT, ResponseT>, UnaryCallSettings<RequestT, ResponseT>, ClientContext) - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreCallableFactory

D

defaultApiClientHeaderProviderBuilder() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings

defaultApiClientHeaderProviderBuilder() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

defaultCredentialsProviderBuilder() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns a builder for the default credentials for this service.

defaultCredentialsProviderBuilder() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns a builder for the default credentials for this service.

defaultExecutorProviderBuilder() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns a builder for the default ExecutorProvider for this service.

defaultExecutorProviderBuilder() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns a builder for the default ExecutorProvider for this service.

DefaultFirestoreFactory() - Constructor for class com.google.cloud.firestore.FirestoreOptions.DefaultFirestoreFactory

DefaultFirestoreRpcFactory() - Constructor for class com.google.cloud.firestore.FirestoreOptions.DefaultFirestoreRpcFactory

defaultGrpcApiClientHeaderProviderBuilder() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

defaultGrpcTransportProviderBuilder() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns a builder for the default gRPC ChannelProvider for this service.

defaultGrpcTransportProviderBuilder() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns a builder for the default gRPC ChannelProvider for this service.

defaultHttpJsonApiClientHeaderProviderBuilder() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

defaultHttpJsonTransportProviderBuilder() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns a builder for the default REST ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns a builder for the default REST ChannelProvider for this service.

defaultTransportChannelProvider() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings

defaultTransportChannelProvider() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

delete() - Method in class com.google.cloud.firestore.DocumentReference

Deletes the document referred to by this DocumentReference.

delete() - Static method in class com.google.cloud.firestore.FieldValue

Returns a sentinel used with update() to mark a field for deletion.

delete(DocumentReference) - Method in class com.google.cloud.firestore.BulkWriter

Delete a document from the database.

delete(DocumentReference) - Method in class com.google.cloud.firestore.UpdateBuilder

Deletes the document referred to by this DocumentReference.

delete(DocumentReference, Precondition) - Method in class com.google.cloud.firestore.BulkWriter

Delete a document from the database.

delete(DocumentReference, Precondition) - Method in class com.google.cloud.firestore.UpdateBuilder

Deletes the document referred to by this DocumentReference.

delete(Precondition) - Method in class com.google.cloud.firestore.DocumentReference

Deletes the document referred to by this DocumentReference.

deleteDocument(DeleteDocumentRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient

Deletes a document.

deleteDocument(String) - Method in class com.google.cloud.firestore.v1.FirestoreClient

Deletes a document.

deleteDocumentCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient

Deletes a document.

deleteDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

deleteDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

deleteDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

deleteDocumentSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Returns the builder for the settings used for calls to deleteDocument.

deleteDocumentSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns the object with the settings used for calls to deleteDocument.

deleteDocumentSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Returns the builder for the settings used for calls to deleteDocument.

deleteDocumentSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the object with the settings used for calls to deleteDocument.

DESCENDING - Enum constant in enum com.google.cloud.firestore.Query.Direction

document() - Method in class com.google.cloud.firestore.CollectionReference

Returns a DocumentReference pointing to a new document with an auto-generated ID within this collection.

document(String) - Method in class com.google.cloud.firestore.CollectionReference

Gets a DocumentReference instance that refers to the document that is a child of this Collection.

document(String) - Method in interface com.google.cloud.firestore.Firestore

Gets a DocumentReference that refers to the document at the specified path.

DocumentChange - Class in com.google.cloud.firestore

A DocumentChange represents a change to the documents matching a query.

DocumentChange.Type - Enum in com.google.cloud.firestore

An enumeration of snapshot diff types.

documentId() - Static method in class com.google.cloud.firestore.FieldPath

A special sentinel to refer to the ID of a document.

DocumentId - Annotation Type in com.google.cloud.firestore.annotation

Annotation used to mark a POJO property to be automatically populated with the document's ID when the POJO is created from a Cloud Firestore document (for example, via DocumentSnapshot.toObject(java.lang.Class<T>)).

DocumentReference - Class in com.google.cloud.firestore

A DocumentReference refers to a document location in a Firestore database and can be used to write, read, or listen to the location.

DocumentSnapshot - Class in com.google.cloud.firestore

A DocumentSnapshot contains data read from a document in a Firestore database.

E

emptyMap(Comparator<K>) - Static method in class com.google.cloud.firestore.collection.ImmutableSortedMap.Builder

EmulatorCredentials() - Constructor for class com.google.cloud.firestore.FirestoreOptions.EmulatorCredentials

endAt(DocumentSnapshot) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query that ends at the provided document (inclusive).

endAt(Object...) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query that ends at the provided fields relative to the order of the query.

endBefore(DocumentSnapshot) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query that ends before the provided document (exclusive).

endBefore(Object...) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query that ends before the provided fields relative to the order of the query.

equals(Object) - Method in class com.google.cloud.firestore.AggregateField

Returns true if the given object is equal to this object.

equals(Object) - Method in class com.google.cloud.firestore.AggregateQuery

Compares this object with the given object for equality.

equals(Object) - Method in class com.google.cloud.firestore.AggregateQuerySnapshot

Compares this object with the given object for equality.

equals(Object) - Method in class com.google.cloud.firestore.Blob

Returns true if this Blob is equal to the provided object.

equals(Object) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

equals(Object) - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet

equals(Object) - Method in class com.google.cloud.firestore.DocumentChange

Returns true if this DocumentChange is equal to the provided object.

equals(Object) - Method in class com.google.cloud.firestore.DocumentReference

Returns true if this DocumentReference is equal to the provided object.

equals(Object) - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns true if the document's data and path in this DocumentSnapshot equals the provided snapshot.

equals(Object) - Method in class com.google.cloud.firestore.FieldValue

Returns true if this FieldValue is equal to the provided object.

equals(Object) - Method in class com.google.cloud.firestore.FirestoreOptions

equals(Object) - Method in class com.google.cloud.firestore.GeoPoint

Returns true if this GeoPoint is equal to the provided object.

equals(Object) - Method in class com.google.cloud.firestore.Precondition

Returns true if this Precondition is equal to the provided object.

equals(Object) - Method in class com.google.cloud.firestore.Query

Returns true if this Query is equal to the provided object.

equals(Object) - Method in class com.google.cloud.firestore.QueryPartition

equals(Object) - Method in class com.google.cloud.firestore.QuerySnapshot

Returns true if the document data in this QuerySnapshot equals the provided snapshot.

equals(Object) - Method in class com.google.cloud.firestore.SetOptions

Returns true if this SetOptions is equal to the provided object.

equals(Object) - Method in class com.google.cloud.firestore.WriteResult

Returns true if this WriteResult is equal to the provided object.

equalTo(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given field is equal to the given value.

equalTo(String, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given field is equal to the given value.

EventListener<T> - Interface in com.google.cloud.firestore

An interface for event listeners.

Exclude - Annotation Type in com.google.cloud.firestore.annotation

Marks a field as excluded from the Database.

ExecutionStats - Class in com.google.cloud.firestore

A ExecutionStats contains information about the execution of a query.

executor - Variable in class com.google.cloud.firestore.TransactionOptions.Builder

exists() - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns whether or not the field exists in the document.

explain(ExplainOptions) - Method in class com.google.cloud.firestore.AggregateQuery

Plans and optionally executes this query.

explain(ExplainOptions) - Method in class com.google.cloud.firestore.Query

Plans and optionally executes this query.

ExplainMetrics - Class in com.google.cloud.firestore

ExplainMetrics contains information about planning and execution of a query.

ExplainOptions - Class in com.google.cloud.firestore

Options used to configure explain queries.

ExplainOptions() - Constructor for class com.google.cloud.firestore.ExplainOptions

ExplainOptions.Builder - Class in com.google.cloud.firestore

ExplainResults<T> - Class in com.google.cloud.firestore

ExplainResults contains information about planning, execution, and results of a query.

explainStream(ExplainOptions, ApiStreamObserver<DocumentSnapshot>) - Method in class com.google.cloud.firestore.Query

Executes the query, streams the results as a StreamObserver of DocumentSnapshots, and returns an ApiFuture that will be resolved with the associated ExplainMetrics.

F

FieldMask - Class in com.google.cloud.firestore

A FieldMask can be used to limit the number of fields returned by a `getAll()` call.

FieldPath - Class in com.google.cloud.firestore

A FieldPath refers to a field in a document.

FieldPath() - Constructor for class com.google.cloud.firestore.FieldPath

FieldValue - Class in com.google.cloud.firestore

Sentinel values that can be used when writing document fields with set() or update().

Filter - Class in com.google.cloud.firestore

Filter() - Constructor for class com.google.cloud.firestore.Filter

Firestore - Interface in com.google.cloud.firestore

Represents a Firestore Database and is the entry point for all Firestore operations

FirestoreBundle - Class in com.google.cloud.firestore

Represents a Firestore data bundle with results from the given document and query snapshots.

FirestoreBundle.Builder - Class in com.google.cloud.firestore

Builds a Firestore data bundle with results from the given document and query snapshots.

FirestoreClient - Class in com.google.cloud.firestore.v1

Service Description: The Cloud Firestore service.

FirestoreClient(FirestoreSettings) - Constructor for class com.google.cloud.firestore.v1.FirestoreClient

Constructs an instance of FirestoreClient, using the given settings.

FirestoreClient(FirestoreStub) - Constructor for class com.google.cloud.firestore.v1.FirestoreClient

FirestoreClient.ListCollectionIdsFixedSizeCollection - Class in com.google.cloud.firestore.v1

FirestoreClient.ListCollectionIdsPage - Class in com.google.cloud.firestore.v1

FirestoreClient.ListCollectionIdsPagedResponse - Class in com.google.cloud.firestore.v1

FirestoreClient.ListDocumentsFixedSizeCollection - Class in com.google.cloud.firestore.v1

FirestoreClient.ListDocumentsPage - Class in com.google.cloud.firestore.v1

FirestoreClient.ListDocumentsPagedResponse - Class in com.google.cloud.firestore.v1

FirestoreClient.PartitionQueryFixedSizeCollection - Class in com.google.cloud.firestore.v1

FirestoreClient.PartitionQueryPage - Class in com.google.cloud.firestore.v1

FirestoreClient.PartitionQueryPagedResponse - Class in com.google.cloud.firestore.v1

FirestoreException - Exception in com.google.cloud.firestore

A Firestore Service exception.

FirestoreFactory - Interface in com.google.cloud.firestore

An interface for Firestore factories.

FirestoreOptions - Class in com.google.cloud.firestore

A Factory class to create new Firestore instances.

FirestoreOptions(FirestoreOptions.Builder) - Constructor for class com.google.cloud.firestore.FirestoreOptions

FirestoreOptions.Builder - Class in com.google.cloud.firestore

FirestoreOptions.DefaultFirestoreFactory - Class in com.google.cloud.firestore

FirestoreOptions.DefaultFirestoreRpcFactory - Class in com.google.cloud.firestore

FirestoreOptions.EmulatorCredentials - Class in com.google.cloud.firestore

FirestoreRpc - Interface in com.google.cloud.firestore.spi.v1

Contains the RPC stubs used by the manual Cloud Firestore client.

FirestoreRpcFactory - Interface in com.google.cloud.firestore

An interface for Firestore RPC factory.

FirestoreSettings - Class in com.google.cloud.firestore.v1

Settings class to configure an instance of FirestoreClient.

FirestoreSettings(FirestoreSettings.Builder) - Constructor for class com.google.cloud.firestore.v1.FirestoreSettings

FirestoreSettings.Builder - Class in com.google.cloud.firestore.v1

Builder for FirestoreSettings.

FirestoreStub - Class in com.google.cloud.firestore.v1.stub

Base stub class for the Firestore service API.

FirestoreStub() - Constructor for class com.google.cloud.firestore.v1.stub.FirestoreStub

FirestoreStubSettings - Class in com.google.cloud.firestore.v1.stub

Settings class to configure an instance of FirestoreStub.

FirestoreStubSettings(FirestoreStubSettings.Builder) - Constructor for class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

FirestoreStubSettings.Builder - Class in com.google.cloud.firestore.v1.stub

Builder for FirestoreStubSettings.

flush() - Method in class com.google.cloud.firestore.BulkWriter

Commits all writes that have been enqueued up to this point in parallel.

forApiException(ApiException) - Static method in exception com.google.cloud.firestore.FirestoreException

Creates a FirestoreException from an ApiException.

forApiException(ApiException, String) - Static method in exception com.google.cloud.firestore.FirestoreException

Creates a FirestoreException from an ApiException.

forInvalidArgument(String, Object...) - Static method in exception com.google.cloud.firestore.FirestoreException

Creates a FirestoreException with an INVALID_ARGUMENT status code and the provided message in a nested exception.

forIOException(IOException, boolean) - Static method in exception com.google.cloud.firestore.FirestoreException

Creates a FirestoreException from an IOException.

forServerRejection(Status, String, Object...) - Static method in exception com.google.cloud.firestore.FirestoreException

Creates a FirestoreException with the provided GRPC Status code and message in a nested exception.

forServerRejection(Status, Throwable, String, Object...) - Static method in exception com.google.cloud.firestore.FirestoreException

Creates a FirestoreException with the provided GRPC Status code and message in a nested exception.

fromBytes(byte[]) - Static method in class com.google.cloud.firestore.Blob

Creates a new Blob instance from the provided bytes.

fromByteString(ByteString) - Static method in class com.google.cloud.firestore.Blob

Creates a new Blob instance from the provided ByteString.

fromMap(Map<A, B>, Comparator<A>) - Static method in class com.google.cloud.firestore.collection.ImmutableSortedMap.Builder

fromMap(Map<A, B>, Comparator<A>) - Static method in class com.google.cloud.firestore.collection.RBTreeSortedMap

fromMap(Map<K, V>, Comparator<K>) - Static method in class com.google.cloud.firestore.collection.ArraySortedMap

fromProto(Firestore, RunAggregationQueryRequest) - Static method in class com.google.cloud.firestore.AggregateQuery

Returns an AggregateQuery instance that can be used to execute the provided RunAggregationQueryRequest.

fromProto(Firestore, RunQueryRequest) - Static method in class com.google.cloud.firestore.Query

Returns a Query instance that can be used to execute the provided RunQueryRequest.

fromServerFormat(String) - Static method in class com.google.cloud.firestore.FieldPath

Creates a FieldPath from a server-encoded field path.

G

GeoPoint - Class in com.google.cloud.firestore

Immutable class representing a geographic location in Firestore

GeoPoint(double, double) - Constructor for class com.google.cloud.firestore.GeoPoint

Construct a new GeoPoint using the provided latitude and longitude values.

get() - Method in class com.google.cloud.firestore.AggregateQuery

Executes this query.

get() - Method in class com.google.cloud.firestore.DocumentReference

Reads the document referenced by this DocumentReference.

get() - Method in class com.google.cloud.firestore.Query

Executes the query and returns the results as QuerySnapshot.

get(AggregateField) - Method in class com.google.cloud.firestore.AggregateQuerySnapshot

Returns the result of the given aggregation from the server without coercion of data types.

get(AggregateField.AverageAggregateField) - Method in class com.google.cloud.firestore.AggregateQuerySnapshot

Returns the result of the given average aggregation.

get(AggregateField.CountAggregateField) - Method in class com.google.cloud.firestore.AggregateQuerySnapshot

Returns the number of documents in the result set of the underlying query.

get(AggregateQuery) - Method in class com.google.cloud.firestore.Transaction

Returns the result from the provided aggregate query.

get(DocumentReference) - Method in class com.google.cloud.firestore.Transaction

Reads the document referred to by the provided DocumentReference.

get(FieldMask) - Method in class com.google.cloud.firestore.DocumentReference

Reads the document referenced by this DocumentReference.

get(FieldPath) - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns the value at the field or null if the field doesn't exist.

get(FieldPath, Class<T>) - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns the value at the field, converted to a POJO, or null if the field or document doesn't exist.

get(Query) - Method in class com.google.cloud.firestore.Transaction

Returns the result set from the provided query.

get(String) - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns the value at the field or null if the field doesn't exist.

get(String, Class<T>) - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns the value at the field, converted to a POJO, or null if the field or document doesn't exist.

get(K) - Method in class com.google.cloud.firestore.collection.ArraySortedMap

get(K) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

get(K) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap

getAll(DocumentReference...) - Method in interface com.google.cloud.firestore.Firestore

Retrieves multiple documents from Firestore.

getAll(DocumentReference...) - Method in class com.google.cloud.firestore.Transaction

Retrieves multiple documents from Firestore.

getAll(DocumentReference[], FieldMask) - Method in interface com.google.cloud.firestore.Firestore

Retrieves multiple documents from Firestore, while optionally applying a field mask to reduce the amount of data transmitted.

getAll(DocumentReference[], FieldMask) - Method in class com.google.cloud.firestore.Transaction

Retrieves multiple documents from Firestore, while optionally applying a field mask to reduce the amount of data transmitted from the backend.

getAll(DocumentReference[], FieldMask, ApiStreamObserver<DocumentSnapshot>) - Method in interface com.google.cloud.firestore.Firestore

Retrieves multiple documents from Firestore while optionally applying a field mask to reduce the amount of data transmitted.

getAnalyze() - Method in class com.google.cloud.firestore.ExplainOptions

Returns whether analyzing the query is enabled.

getAuthenticationType() - Method in class com.google.cloud.firestore.FirestoreOptions.EmulatorCredentials

getBlob(String) - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns the value of the field as a Blob.

getBoolean(String) - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns the value of the field as a boolean.

getColor() - Method in class com.google.cloud.firestore.collection.LLRBBlackValueNode

getColor() - Method in class com.google.cloud.firestore.collection.LLRBRedValueNode

getColor() - Method in class com.google.cloud.firestore.collection.LLRBValueNode

getComparator() - Method in class com.google.cloud.firestore.collection.ArraySortedMap

getComparator() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

getComparator() - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap

getCount() - Method in class com.google.cloud.firestore.AggregateQuerySnapshot

Returns the number of documents in the result set of the underlying query.

getCreateTime() - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns the time at which this document was created.

getCredentialsProvider() - Method in class com.google.cloud.firestore.FirestoreOptions

getData() - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns the fields of the document as a Map or null if the document doesn't exist.

getData() - Method in class com.google.cloud.firestore.QueryDocumentSnapshot

Returns the fields of the document as a Map.

getDatabaseId() - Method in class com.google.cloud.firestore.FirestoreOptions

getDate(String) - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns the value of the field as a Date.

getDebugStats() - Method in class com.google.cloud.firestore.ExecutionStats

Returns a map that contains additional statistics related to query execution.

getDefaultCredentialsProviderBuilder() - Static method in class com.google.cloud.firestore.FirestoreOptions

getDefaultEndpoint() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns the default service endpoint.

getDefaultEndpoint() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the default service endpoint.

getDefaultHost() - Method in class com.google.cloud.firestore.FirestoreOptions

getDefaultInstance() - Static method in class com.google.cloud.firestore.FirestoreOptions

Returns a default FirestoreOptions instance.

getDefaultMtlsEndpoint() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the default mTLS service endpoint.

getDefaultServiceScopes() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns the default service scopes.

getDefaultServiceScopes() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the default service scopes.

getDefaultTransportChannelProviderBuilder() - Static method in class com.google.cloud.firestore.FirestoreOptions

getDefaultTransportOptionsBuilder() - Static method in class com.google.cloud.firestore.FirestoreOptions

getDocument() - Method in class com.google.cloud.firestore.DocumentChange

Returns the newly added or modified document if this DocumentChange is for an updated document.

getDocument(GetDocumentRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient

Gets a single document.

getDocumentCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient

Gets a single document.

getDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

getDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

getDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

getDocumentChanges() - Method in class com.google.cloud.firestore.QuerySnapshot

Returns the list of documents that changed since the last snapshot.

getDocumentReference() - Method in exception com.google.cloud.firestore.BulkWriterException

getDocuments() - Method in class com.google.cloud.firestore.QuerySnapshot

Returns the documents in this QuerySnapshot as a List in order of the query.

getDocumentSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Returns the builder for the settings used for calls to getDocument.

getDocumentSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns the object with the settings used for calls to getDocument.

getDocumentSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Returns the builder for the settings used for calls to getDocument.

getDocumentSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the object with the settings used for calls to getDocument.

getDouble(AggregateField) - Method in class com.google.cloud.firestore.AggregateQuerySnapshot

Returns the result of the given aggregation as a double.

getDouble(String) - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns the value of the field as a double.

getEmulatorHost() - Method in class com.google.cloud.firestore.FirestoreOptions

getEndBefore() - Method in class com.google.cloud.firestore.QueryPartition

The cursor that defines the first result after this partition.

getEndpoint() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Returns the endpoint set by the user or the the service's default endpoint.

getEndpoint() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the endpoint set by the user or the the service's default endpoint.

getExecutionDuration() - Method in class com.google.cloud.firestore.ExecutionStats

Returns the total execution time of the query.

getExecutionStats() - Method in class com.google.cloud.firestore.ExplainMetrics

Returns the information about the execution of the query, or null if the query was not executed.

getExecutor() - Method in class com.google.cloud.firestore.BulkWriterOptions

getExecutor() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc

Returns the executor used by the GAPIC client.

getExecutor() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc

getExecutor() - Method in class com.google.cloud.firestore.TransactionOptions.Builder

getExecutor() - Method in class com.google.cloud.firestore.TransactionOptions

getFailedAttempts() - Method in exception com.google.cloud.firestore.BulkWriterException

getFirestore() - Method in class com.google.cloud.firestore.DocumentReference

getFirestore() - Method in class com.google.cloud.firestore.Query

Gets the Firestore instance associated with this query.

getGeoPoint(String) - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns the value of the field as a GeoPoint.

getId() - Method in class com.google.cloud.firestore.CollectionReference

The id of a collection refers to the last component of path pointing to a collection, for example "collection-id" in "projects/project-id/databases/database-id/documents/collection-id".

getId() - Method in class com.google.cloud.firestore.DocumentReference

The id of a document refers to the last component of path pointing to a document, for example "document-id" in "projects/project-id/databases/database-id/document-id".

getId() - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns the ID of the document contained in this snapshot.

getId() - Method in class com.google.cloud.firestore.FirestoreBundle.Builder

Returns the ID for this bundle.

getIndexesUsed() - Method in class com.google.cloud.firestore.PlanSummary

getInitialOpsPerSecond() - Method in class com.google.cloud.firestore.BulkWriterOptions

Returns the initial maximum number of operations per second allowed by the throttler.

getInstance() - Static method in class com.google.cloud.firestore.collection.LLRBEmptyNode

getKey() - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode

getKey() - Method in interface com.google.cloud.firestore.collection.LLRBNode

getKey() - Method in class com.google.cloud.firestore.collection.LLRBValueNode

getLatitude() - Method in class com.google.cloud.firestore.GeoPoint

Returns the latitude.

getLeft() - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode

getLeft() - Method in interface com.google.cloud.firestore.collection.LLRBNode

getLeft() - Method in class com.google.cloud.firestore.collection.LLRBValueNode

getLong(AggregateField) - Method in class com.google.cloud.firestore.AggregateQuerySnapshot

Returns the result of the given aggregation as a long.

getLong(String) - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns the value of the field as a long.

getLongitude() - Method in class com.google.cloud.firestore.GeoPoint

Returns the longitude.

getMax() - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode

getMax() - Method in interface com.google.cloud.firestore.collection.LLRBNode

getMax() - Method in class com.google.cloud.firestore.collection.LLRBValueNode

getMaxEntry() - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet

getMaxKey() - Method in class com.google.cloud.firestore.collection.ArraySortedMap

getMaxKey() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

getMaxKey() - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap

getMaxOpsPerSecond() - Method in class com.google.cloud.firestore.BulkWriterOptions

Returns the maximum number of operations per second allowed by the throttler.

getMessage() - Method in exception com.google.cloud.firestore.BulkWriterException

getMethodDescriptors() - Static method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

getMetrics() - Method in class com.google.cloud.firestore.ExplainResults

Returns the information about planning and execution (if any) of the query.

getMin() - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode

getMin() - Method in interface com.google.cloud.firestore.collection.LLRBNode

getMin() - Method in class com.google.cloud.firestore.collection.LLRBValueNode

getMinEntry() - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet

getMinKey() - Method in class com.google.cloud.firestore.collection.ArraySortedMap

getMinKey() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

getMinKey() - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap

getMutationsSize() - Method in class com.google.cloud.firestore.UpdateBuilder

Get the number of writes.

getNewIndex() - Method in class com.google.cloud.firestore.DocumentChange

The index of the changed document in the result set immediately after this DocumentChange (specifically, supposing that all prior DocumentChange objects and the current DocumentChange object have been applied).

getNumberOfAttempts() - Method in class com.google.cloud.firestore.TransactionOptions

Returns the maximum number of times a transaction will be attempted before resulting in an error.

getNumberOfAttempts() - Method in class com.google.cloud.firestore.TransactionOptions.ReadWriteOptionsBuilder

Specify the max number of attempts a transaction will be attempted before resulting in an error.

getOldIndex() - Method in class com.google.cloud.firestore.DocumentChange

The index of the changed document in the result set immediately prior to this DocumentChange (specifically, supposing that all prior DocumentChange objects have been applied).

getOperationsStub() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

getOperationType() - Method in exception com.google.cloud.firestore.BulkWriterException

getOperator() - Method in class com.google.cloud.firestore.AggregateField.AverageAggregateField

getOperator() - Method in class com.google.cloud.firestore.AggregateField.CountAggregateField

getOperator() - Method in class com.google.cloud.firestore.AggregateField.SumAggregateField

getParent() - Method in class com.google.cloud.firestore.CollectionReference

Returns a DocumentReference to the containing Document if this is a subcollection, else null.

getParent() - Method in class com.google.cloud.firestore.DocumentReference

A reference to the Collection to which this DocumentReference belongs to.

getPartitions(long) - Method in class com.google.cloud.firestore.CollectionGroup

getPartitions(long, ApiStreamObserver<QueryPartition>) - Method in class com.google.cloud.firestore.CollectionGroup

Deprecated.

Please use CollectionGroup.getPartitions(long) instead. All cursors will be loaded before any value will be provided to observer.

getPath() - Method in class com.google.cloud.firestore.CollectionReference

A string representing the path of the referenced collection (relative to the root of the database).

getPath() - Method in class com.google.cloud.firestore.DocumentReference

A string representing the path of the referenced document (relative to the root of the database).

getPlanSummary() - Method in class com.google.cloud.firestore.ExplainMetrics

Returns the information about the query plan.

getPredecessorEntry(T) - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet

getPredecessorKey(K) - Method in class com.google.cloud.firestore.collection.ArraySortedMap

getPredecessorKey(K) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

getPredecessorKey(K) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap

getQuery() - Method in class com.google.cloud.firestore.AggregateQuery

Returns the query whose aggregations will be calculated by this object.

getQuery() - Method in class com.google.cloud.firestore.AggregateQuerySnapshot

Returns the query that was executed to produce this result.

getQuery() - Method in class com.google.cloud.firestore.QuerySnapshot

Returns the query for the snapshot.

getReadOperations() - Method in class com.google.cloud.firestore.ExecutionStats

Returns the number of read operations that occurred when executing the query.

getReadTime() - Method in class com.google.cloud.firestore.AggregateQuerySnapshot

Returns the time at which this snapshot was read.

getReadTime() - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns the time at which this snapshot was read.

getReadTime() - Method in class com.google.cloud.firestore.QuerySnapshot

Returns the time at which this snapshot was read.

getReadTime() - Method in class com.google.cloud.firestore.TransactionOptions

A Timestamp specifying the time documents are to be read at.

getReadTime() - Method in class com.google.cloud.firestore.TransactionOptions.ReadOnlyOptionsBuilder

getReference() - Method in class com.google.cloud.firestore.DocumentSnapshot

Gets the reference to the document.

getRequestMetadata(URI) - Method in class com.google.cloud.firestore.FirestoreOptions.EmulatorCredentials

getResultsReturned() - Method in class com.google.cloud.firestore.ExecutionStats

Returns the number of query results.

getRight() - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode

getRight() - Method in interface com.google.cloud.firestore.collection.LLRBNode

getRight() - Method in class com.google.cloud.firestore.collection.LLRBValueNode

getScopes() - Method in class com.google.cloud.firestore.FirestoreOptions

getServiceName() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the default service name.

getSettings() - Method in class com.google.cloud.firestore.v1.FirestoreClient

getSnapshot() - Method in class com.google.cloud.firestore.ExplainResults

Returns the snapshot that contains the results of executing the query, or null if the query was not executed.

getStartAt() - Method in class com.google.cloud.firestore.QueryPartition

The cursor that defines the first result for this partition.

getStatus() - Method in exception com.google.cloud.firestore.BulkWriterException

getStatus() - Method in exception com.google.cloud.firestore.FirestoreException

getString(String) - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns the value of the field as a String.

getStub() - Method in class com.google.cloud.firestore.v1.FirestoreClient

getStubSettingsBuilder() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder

getSuccessorKey(K) - Method in class com.google.cloud.firestore.collection.ArraySortedMap

getSuccessorKey(K) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

getSuccessorKey(K) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap

getThrottlingEnabled() - Method in class com.google.cloud.firestore.BulkWriterOptions

Return whether throttling is enabled.

getTimestamp(String) - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns the value of the field as a Timestamp.

getTransportChannelProvider() - Method in class com.google.cloud.firestore.FirestoreOptions

getType() - Method in class com.google.cloud.firestore.DocumentChange

getType() - Method in class com.google.cloud.firestore.TransactionOptions

A type flag indicating the type of transaction represented.

getUpdateTime() - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns the time at which this document was last updated.

getUpdateTime() - Method in class com.google.cloud.firestore.WriteResult

The update time as exposed by the server.

getValue() - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode

getValue() - Method in interface com.google.cloud.firestore.collection.LLRBNode

getValue() - Method in class com.google.cloud.firestore.collection.LLRBValueNode

greaterThan(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given field is greater than the given value.

greaterThan(String, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given field is greater than the given value.

greaterThanOrEqualTo(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given field is greater than or equal to the given value.

greaterThanOrEqualTo(String, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given field is greater than or equal to the given value.

GrpcFirestoreCallableFactory - Class in com.google.cloud.firestore.v1.stub

gRPC callable factory implementation for the Firestore service API.

GrpcFirestoreCallableFactory() - Constructor for class com.google.cloud.firestore.v1.stub.GrpcFirestoreCallableFactory

GrpcFirestoreRpc - Class in com.google.cloud.firestore.spi.v1

GRPC client implementation of the Firestore RPC methods.

GrpcFirestoreRpc(FirestoreOptions) - Constructor for class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc

GrpcFirestoreStub - Class in com.google.cloud.firestore.v1.stub

gRPC stub implementation for the Firestore service API.

GrpcFirestoreStub(FirestoreStubSettings, ClientContext) - Constructor for class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

Constructs an instance of GrpcFirestoreStub, using the given settings.

GrpcFirestoreStub(FirestoreStubSettings, ClientContext, GrpcStubCallableFactory) - Constructor for class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

Constructs an instance of GrpcFirestoreStub, using the given settings.

H

hashCode() - Method in class com.google.cloud.firestore.AggregateField

Calculates and returns the hash code for this object.

hashCode() - Method in class com.google.cloud.firestore.AggregateQuery

Calculates and returns the hash code for this object.

hashCode() - Method in class com.google.cloud.firestore.AggregateQuerySnapshot

Calculates and returns the hash code for this object.

hashCode() - Method in class com.google.cloud.firestore.Blob

hashCode() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

hashCode() - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet

hashCode() - Method in class com.google.cloud.firestore.DocumentChange

hashCode() - Method in class com.google.cloud.firestore.DocumentReference

hashCode() - Method in class com.google.cloud.firestore.DocumentSnapshot

hashCode() - Method in class com.google.cloud.firestore.FieldValue

hashCode() - Method in class com.google.cloud.firestore.FirestoreOptions

hashCode() - Method in class com.google.cloud.firestore.GeoPoint

hashCode() - Method in class com.google.cloud.firestore.Precondition

hashCode() - Method in class com.google.cloud.firestore.Query

hashCode() - Method in class com.google.cloud.firestore.QueryPartition

hashCode() - Method in class com.google.cloud.firestore.QuerySnapshot

hashCode() - Method in class com.google.cloud.firestore.SetOptions

hashCode() - Method in class com.google.cloud.firestore.WriteResult

hasNext() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMapIterator

hasRequestMetadata() - Method in class com.google.cloud.firestore.FirestoreOptions.EmulatorCredentials

hasRequestMetadataOnly() - Method in class com.google.cloud.firestore.FirestoreOptions.EmulatorCredentials

hasTransactionId() - Method in class com.google.cloud.firestore.Transaction

HttpJsonFirestoreCallableFactory - Class in com.google.cloud.firestore.v1.stub

REST callable factory implementation for the Firestore service API.

HttpJsonFirestoreCallableFactory() - Constructor for class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreCallableFactory

HttpJsonFirestoreStub - Class in com.google.cloud.firestore.v1.stub

REST stub implementation for the Firestore service API.

HttpJsonFirestoreStub(FirestoreStubSettings, ClientContext) - Constructor for class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

Constructs an instance of HttpJsonFirestoreStub, using the given settings.

HttpJsonFirestoreStub(FirestoreStubSettings, ClientContext, HttpJsonStubCallableFactory) - Constructor for class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

Constructs an instance of HttpJsonFirestoreStub, using the given settings.

I

identityTranslator() - Static method in class com.google.cloud.firestore.collection.ImmutableSortedMap.Builder

IgnoreExtraProperties - Annotation Type in com.google.cloud.firestore.annotation

Properties that don't map to class fields are ignored when serializing to a class annotated with this annotation.

ImmutableSortedMap<K,V> - Class in com.google.cloud.firestore.collection

ImmutableSortedMap() - Constructor for class com.google.cloud.firestore.collection.ImmutableSortedMap

ImmutableSortedMap.Builder - Class in com.google.cloud.firestore.collection

ImmutableSortedMap.Builder.KeyTranslator<C,D> - Interface in com.google.cloud.firestore.collection

ImmutableSortedMapIterator<K,V> - Class in com.google.cloud.firestore.collection

ImmutableSortedSet<T> - Class in com.google.cloud.firestore.collection

ImmutableSortedSet(List<T>, Comparator<T>) - Constructor for class com.google.cloud.firestore.collection.ImmutableSortedSet

inArray(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given field equals any of the given values.

inArray(String, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given field equals any of the given values.

increment(double) - Static method in class com.google.cloud.firestore.FieldValue

Returns a special value that can be used with set(), create() or update() that tells the server to increment the field's current value by the given value.

increment(long) - Static method in class com.google.cloud.firestore.FieldValue

Returns a special value that can be used with set(), create() or update() that tells the server to increment the field's current value by the given value.

indexOf(K) - Method in class com.google.cloud.firestore.collection.ArraySortedMap

indexOf(K) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

indexOf(K) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap

indexOf(T) - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet

inOrderTraversal(LLRBNode.NodeVisitor<K, V>) - Method in class com.google.cloud.firestore.collection.ArraySortedMap

inOrderTraversal(LLRBNode.NodeVisitor<K, V>) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

inOrderTraversal(LLRBNode.NodeVisitor<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode

inOrderTraversal(LLRBNode.NodeVisitor<K, V>) - Method in interface com.google.cloud.firestore.collection.LLRBNode

inOrderTraversal(LLRBNode.NodeVisitor<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBValueNode

inOrderTraversal(LLRBNode.NodeVisitor<K, V>) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap

insert(K, V) - Method in class com.google.cloud.firestore.collection.ArraySortedMap

insert(K, V) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

insert(K, V) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap

insert(K, V, Comparator<K>) - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode

insert(K, V, Comparator<K>) - Method in interface com.google.cloud.firestore.collection.LLRBNode

insert(K, V, Comparator<K>) - Method in class com.google.cloud.firestore.collection.LLRBValueNode

insert(T) - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet

Internal - Class in com.google.cloud.firestore

Internal(FirestoreImpl) - Constructor for class com.google.cloud.firestore.Internal

Internal(FirestoreOptions, FirestoreRpc) - Constructor for class com.google.cloud.firestore.Internal

isEmpty() - Method in class com.google.cloud.firestore.collection.ArraySortedMap

isEmpty() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

isEmpty() - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet

isEmpty() - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode

isEmpty() - Method in interface com.google.cloud.firestore.collection.LLRBNode

isEmpty() - Method in class com.google.cloud.firestore.collection.LLRBValueNode

isEmpty() - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap

isEmpty() - Method in class com.google.cloud.firestore.QuerySnapshot

Returns true if there are no documents in the QuerySnapshot.

isRed() - Method in class com.google.cloud.firestore.collection.LLRBBlackValueNode

isRed() - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode

isRed() - Method in interface com.google.cloud.firestore.collection.LLRBNode

isRed() - Method in class com.google.cloud.firestore.collection.LLRBRedValueNode

isShutdown() - Method in class com.google.cloud.firestore.v1.FirestoreClient

isShutdown() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

isShutdown() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

isTerminated() - Method in class com.google.cloud.firestore.v1.FirestoreClient

isTerminated() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

isTerminated() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

iterator() - Method in class com.google.cloud.firestore.collection.ArraySortedMap

iterator() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

iterator() - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet

iterator() - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap

iterator() - Method in class com.google.cloud.firestore.QuerySnapshot

iteratorFrom(K) - Method in class com.google.cloud.firestore.collection.ArraySortedMap

iteratorFrom(K) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

iteratorFrom(K) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap

iteratorFrom(T) - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet

L

lessThan(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given field is less than the given value.

lessThan(String, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given field is less than the given value.

lessThanOrEqualTo(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given field is less than or equal to the given value.

lessThanOrEqualTo(String, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given field is less than or equal to the given value.

limit(int) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query that only returns the first matching documents.

limitToLast(int) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query that only returns the last matching documents.

listCollectionIds(ListCollectionIdsRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient

Lists all the collection IDs underneath a document.

listCollectionIds(String) - Method in class com.google.cloud.firestore.v1.FirestoreClient

Lists all the collection IDs underneath a document.

listCollectionIdsCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient

Lists all the collection IDs underneath a document.

listCollectionIdsCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

listCollectionIdsCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

listCollectionIdsCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

listCollectionIdsPagedCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc

Returns a list of collections IDs.

listCollectionIdsPagedCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc

listCollectionIdsPagedCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient

Lists all the collection IDs underneath a document.

listCollectionIdsPagedCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

listCollectionIdsPagedCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

listCollectionIdsPagedCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

listCollectionIdsSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Returns the builder for the settings used for calls to listCollectionIds.

listCollectionIdsSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns the object with the settings used for calls to listCollectionIds.

listCollectionIdsSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Returns the builder for the settings used for calls to listCollectionIds.

listCollectionIdsSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the object with the settings used for calls to listCollectionIds.

listCollections() - Method in class com.google.cloud.firestore.DocumentReference

Fetches the subcollections that are direct children of this document.

listCollections() - Method in interface com.google.cloud.firestore.Firestore

Fetches the root collections that are associated with this Firestore database.

listDocuments() - Method in class com.google.cloud.firestore.CollectionReference

Retrieves the list of documents in this collection.

listDocuments(ListDocumentsRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient

Lists documents.

listDocumentsCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient

Lists documents.

listDocumentsCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

listDocumentsCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

listDocumentsCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

listDocumentsPagedCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc

Returns a list of documents.

listDocumentsPagedCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc

listDocumentsPagedCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient

Lists documents.

listDocumentsPagedCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

listDocumentsPagedCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

listDocumentsPagedCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

listDocumentsSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Returns the builder for the settings used for calls to listDocuments.

listDocumentsSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns the object with the settings used for calls to listDocuments.

listDocumentsSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Returns the builder for the settings used for calls to listDocuments.

listDocumentsSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the object with the settings used for calls to listDocuments.

listenCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc

Returns a bi-directional watch stream.

listenCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc

listenCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient

Listens to changes.

listenCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

listenCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

listenCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

ListenerRegistration - Interface in com.google.cloud.firestore

Represents a listener that can be removed by calling remove().

listenSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Returns the builder for the settings used for calls to listen.

listenSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns the object with the settings used for calls to listen.

listenSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Returns the builder for the settings used for calls to listen.

listenSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the object with the settings used for calls to listen.

LLRBBlackValueNode<K,V> - Class in com.google.cloud.firestore.collection

LLRBEmptyNode<K,V> - Class in com.google.cloud.firestore.collection

LLRBNode<K,V> - Interface in com.google.cloud.firestore.collection

LLRBNode.Color - Enum in com.google.cloud.firestore.collection

LLRBNode.NodeVisitor<K,V> - Class in com.google.cloud.firestore.collection

LLRBNode.ShortCircuitingNodeVisitor<K,V> - Interface in com.google.cloud.firestore.collection

LLRBRedValueNode<K,V> - Class in com.google.cloud.firestore.collection

LLRBValueNode<K,V> - Class in com.google.cloud.firestore.collection

M

MAX_BATCH_SIZE - Static variable in class com.google.cloud.firestore.BulkWriter

The maximum number of writes that can be in a single batch.

MAX_PENDING_OPS - Static variable in class com.google.cloud.firestore.RecursiveDelete

The query limit used for recursive deletes when fetching all descendants of the specified reference to delete.

MAX_RETRY_ATTEMPTS - Static variable in class com.google.cloud.firestore.BulkWriter

The maximum number of retries that will be attempted with backoff before stopping all retry attempts.

merge() - Static method in class com.google.cloud.firestore.SetOptions

Changes the behavior of set() calls to only replace the values specified in its data argument.

mergeFieldPaths(List<FieldPath>) - Static method in class com.google.cloud.firestore.SetOptions

Changes the behavior of set() calls to only replace the fields under fieldPaths.

mergeFields(String...) - Static method in class com.google.cloud.firestore.SetOptions

Changes the behavior of set() calls to only replace the fields under fieldPaths.

mergeFields(List<String>) - Static method in class com.google.cloud.firestore.SetOptions

Changes the behavior of set() calls to only replace the fields under fieldPaths.

MIN_PENDING_OPS - Static variable in class com.google.cloud.firestore.RecursiveDelete

The number of pending BulkWriter operations at which RecursiveDelete starts the next limit query to fetch descendants.

MODIFIED - Enum constant in enum com.google.cloud.firestore.DocumentChange.Type

Indicates a document within the query was modified.

N

newBuilder() - Static method in class com.google.cloud.firestore.FirestoreOptions

newBuilder() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns a new gRPC builder for this class.

newBuilder() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns a new gRPC builder for this class.

newBuilder(ClientContext) - Static method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns a new builder for this class.

newBuilder(ClientContext) - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns a new builder for this class.

newHttpJsonBuilder() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns a new REST builder for this class.

newHttpJsonBuilder() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns a new REST builder for this class.

next() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMapIterator

NodeVisitor() - Constructor for class com.google.cloud.firestore.collection.LLRBNode.NodeVisitor

NONE - Static variable in class com.google.cloud.firestore.Precondition

An empty Precondition that adds no enforcements

notEqualTo(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given field is not equal to the given value.

notEqualTo(String, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given field is not equal to the given value.

notInArray(FieldPath, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given field does not equal any of the given values.

notInArray(String, Object) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter for checking that the given field does not equal any of the given values.

O

of(FieldPath...) - Static method in class com.google.cloud.firestore.FieldMask

Creates a FieldMask from the provided field paths.

of(String...) - Static method in class com.google.cloud.firestore.FieldMask

Creates a FieldMask from the provided field paths.

of(String...) - Static method in class com.google.cloud.firestore.FieldPath

Creates a FieldPath from the provided field names.

offset(int) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query that skips the first n results.

onError(BulkWriterException) - Method in interface com.google.cloud.firestore.BulkWriter.WriteErrorCallback

onEvent(T, FirestoreException) - Method in interface com.google.cloud.firestore.EventListener

onEvent will be called with the new value or the error if an error occurred.

onResult(DocumentReference, WriteResult) - Method in interface com.google.cloud.firestore.BulkWriter.WriteResultCallback

or(Filter...) - Static method in class com.google.cloud.firestore.Filter

Creates a new filter that is a disjunction of the given filters.

orderBy(FieldPath) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query that's additionally sorted by the specified field.

orderBy(FieldPath, Query.Direction) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query that's additionally sorted by the specified field, optionally in descending order instead of ascending.

orderBy(String) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query that's additionally sorted by the specified field.

orderBy(String, Query.Direction) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query that's additionally sorted by the specified field, optionally in descending order instead of ascending.

P

partitionQuery(PartitionQueryRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient

Partitions a query by returning partition cursors that can be used to run the query in parallel.

partitionQueryCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient

Partitions a query by returning partition cursors that can be used to run the query in parallel.

partitionQueryCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

partitionQueryCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

partitionQueryCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

partitionQueryPagedCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc

partitionQueryPagedCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc

partitionQueryPagedCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient

Partitions a query by returning partition cursors that can be used to run the query in parallel.

partitionQueryPagedCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

partitionQueryPagedCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

partitionQueryPagedCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

partitionQuerySettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Returns the builder for the settings used for calls to partitionQuery.

partitionQuerySettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns the object with the settings used for calls to partitionQuery.

partitionQuerySettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Returns the builder for the settings used for calls to partitionQuery.

partitionQuerySettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the object with the settings used for calls to partitionQuery.

PlanSummary - Class in com.google.cloud.firestore

A Plan contains information about the planning stage of a query.

Precondition - Class in com.google.cloud.firestore

Preconditions that can be used to restrict update() calls.

projectIdRequired() - Method in class com.google.cloud.firestore.FirestoreOptions

PropertyName - Annotation Type in com.google.cloud.firestore.annotation

Marks a field to be renamed when serialized.

protoFromSnapshot(DocumentSnapshot) - Method in class com.google.cloud.firestore.Internal

Q

Query - Class in com.google.cloud.firestore

A Query which you can read or listen to.

Query(FirestoreRpcContext<?>, Query.QueryOptions) - Constructor for class com.google.cloud.firestore.Query

Query.Direction - Enum in com.google.cloud.firestore

The direction of a sort.

QueryDocumentSnapshot - Class in com.google.cloud.firestore

A QueryDocumentSnapshot contains data read from a document in a Firestore database as part of a query.

QueryPartition - Class in com.google.cloud.firestore

A split point that can be used in a query as a starting and/or end point for the query results.

QueryPartition(Query, Object[], Object[]) - Constructor for class com.google.cloud.firestore.QueryPartition

QuerySnapshot - Class in com.google.cloud.firestore

A QuerySnapshot contains the results of a query.

QuerySnapshot(Query, Timestamp) - Constructor for class com.google.cloud.firestore.QuerySnapshot

R

RBTreeSortedMap<K,V> - Class in com.google.cloud.firestore.collection

This is a red-black tree backed implementation of ImmutableSortedMap.

READ_ONLY - Enum constant in enum com.google.cloud.firestore.TransactionOptions.TransactionOptionsType

READ_WRITE - Enum constant in enum com.google.cloud.firestore.TransactionOptions.TransactionOptionsType

recursiveDelete(CollectionReference) - Method in interface com.google.cloud.firestore.Firestore

Recursively deletes all documents and subcollections at and under the specified level.

recursiveDelete(CollectionReference, BulkWriter) - Method in interface com.google.cloud.firestore.Firestore

Recursively deletes all documents and subcollections at and under the specified level.

recursiveDelete(DocumentReference) - Method in interface com.google.cloud.firestore.Firestore

Recursively deletes all documents and subcollections at and under the specified level.

recursiveDelete(DocumentReference, BulkWriter) - Method in interface com.google.cloud.firestore.Firestore

Recursively deletes all documents and subcollections at and under the specified level.

RecursiveDelete - Class in com.google.cloud.firestore

Class used to store state required for running a recursive delete operation.

RED - Enum constant in enum com.google.cloud.firestore.collection.LLRBNode.Color

REFERENCE_NAME_MIN_ID - Static variable in class com.google.cloud.firestore.RecursiveDelete

Datastore allowed numeric IDs where Firestore only allows strings.

refresh() - Method in class com.google.cloud.firestore.FirestoreOptions.EmulatorCredentials

remove() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMapIterator

remove() - Method in interface com.google.cloud.firestore.ListenerRegistration

Removes the listener being tracked by this ListenerRegistration.

remove(K) - Method in class com.google.cloud.firestore.collection.ArraySortedMap

remove(K) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

remove(K) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap

remove(K, Comparator<K>) - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode

remove(K, Comparator<K>) - Method in interface com.google.cloud.firestore.collection.LLRBNode

remove(K, Comparator<K>) - Method in class com.google.cloud.firestore.collection.LLRBValueNode

remove(T) - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet

REMOVED - Enum constant in enum com.google.cloud.firestore.DocumentChange.Type

Indicates a document within the query was removed (either deleted or no longer matches the query.

RETRY_MAX_BATCH_SIZE - Static variable in class com.google.cloud.firestore.BulkWriter

The maximum number of writes that can be in a batch containing retries.

reverseIterator() - Method in class com.google.cloud.firestore.collection.ArraySortedMap

reverseIterator() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

reverseIterator() - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet

reverseIterator() - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap

reverseIteratorFrom(K) - Method in class com.google.cloud.firestore.collection.ArraySortedMap

reverseIteratorFrom(K) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

reverseIteratorFrom(K) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap

reverseIteratorFrom(T) - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet

rollback(RollbackRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient

Rolls back a transaction.

rollback(String, ByteString) - Method in class com.google.cloud.firestore.v1.FirestoreClient

Rolls back a transaction.

rollbackCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc

Rolls back a transaction.

rollbackCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc

rollbackCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient

Rolls back a transaction.

rollbackCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

rollbackCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

rollbackCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

rollbackSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Returns the builder for the settings used for calls to rollback.

rollbackSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns the object with the settings used for calls to rollback.

rollbackSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Returns the builder for the settings used for calls to rollback.

rollbackSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the object with the settings used for calls to rollback.

run() - Method in class com.google.cloud.firestore.RecursiveDelete

runAggregationQueryCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc

Runs an aggregation query.

runAggregationQueryCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc

runAggregationQueryCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient

Runs an aggregation query.

runAggregationQueryCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

runAggregationQueryCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

runAggregationQueryCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

runAggregationQuerySettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Returns the builder for the settings used for calls to runAggregationQuery.

runAggregationQuerySettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns the object with the settings used for calls to runAggregationQuery.

runAggregationQuerySettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Returns the builder for the settings used for calls to runAggregationQuery.

runAggregationQuerySettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the object with the settings used for calls to runAggregationQuery.

runAsyncTransaction(Transaction.AsyncFunction<T>) - Method in interface com.google.cloud.firestore.Firestore

Executes the given updateFunction and then attempts to commit the changes applied within the transaction.

runAsyncTransaction(Transaction.AsyncFunction<T>, TransactionOptions) - Method in interface com.google.cloud.firestore.Firestore

Executes the given updateFunction and then attempts to commit the changes applied within the transaction.

runQueryCallable() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc

Runs a query.

runQueryCallable() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc

runQueryCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient

Runs a query.

runQueryCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

runQueryCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

runQueryCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

runQuerySettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Returns the builder for the settings used for calls to runQuery.

runQuerySettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns the object with the settings used for calls to runQuery.

runQuerySettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Returns the builder for the settings used for calls to runQuery.

runQuerySettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the object with the settings used for calls to runQuery.

runTransaction(Transaction.Function<T>) - Method in interface com.google.cloud.firestore.Firestore

Executes the given updateFunction and then attempts to commit the changes applied within the transaction.

runTransaction(Transaction.Function<T>, TransactionOptions) - Method in interface com.google.cloud.firestore.Firestore

Executes the given updateFunction and then attempts to commit the changes applied within the transaction.

S

select(FieldPath...) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query instance that applies a field mask to the result and returns the specified subset of fields.

select(String...) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query instance that applies a field mask to the result and returns the specified subset of fields.

serverTimestamp() - Static method in class com.google.cloud.firestore.FieldValue

Returns a sentinel used with set() or update() to include a server-generated timestamp in the written data.

ServerTimestamp - Annotation Type in com.google.cloud.firestore.annotation

Annotation used to mark a timestamp field as being populated via Server Timestamps.

set(DocumentReference, Object) - Method in class com.google.cloud.firestore.BulkWriter

Write to the document referred to by the provided DocumentReference.

set(DocumentReference, Object) - Method in class com.google.cloud.firestore.UpdateBuilder

Overwrites the document referred to by this DocumentReference.

set(DocumentReference, Object, SetOptions) - Method in class com.google.cloud.firestore.BulkWriter

Write to the document referred to by the provided DocumentReference.

set(DocumentReference, Object, SetOptions) - Method in class com.google.cloud.firestore.UpdateBuilder

Overwrites the document referred to by this DocumentReference.

set(DocumentReference, Map<String, Object>) - Method in class com.google.cloud.firestore.BulkWriter

Write to the document referred to by the provided DocumentReference.

set(DocumentReference, Map<String, Object>) - Method in class com.google.cloud.firestore.UpdateBuilder

Overwrites the document referred to by this DocumentReference.

set(DocumentReference, Map<String, Object>, SetOptions) - Method in class com.google.cloud.firestore.BulkWriter

Write to the document referred to by the provided DocumentReference.

set(DocumentReference, Map<String, Object>, SetOptions) - Method in class com.google.cloud.firestore.UpdateBuilder

Overwrites the document referred to by this DocumentReference.

set(Object) - Method in class com.google.cloud.firestore.DocumentReference

Overwrites the document referred to by this DocumentReference.

set(Object, SetOptions) - Method in class com.google.cloud.firestore.DocumentReference

Writes to the document referred to by this DocumentReference.

set(Map<String, Object>) - Method in class com.google.cloud.firestore.DocumentReference

Overwrites the document referred to by this DocumentReference.

set(Map<String, Object>, SetOptions) - Method in class com.google.cloud.firestore.DocumentReference

Writes to the document referred to by this DocumentReference.

setAnalyze(boolean) - Method in class com.google.cloud.firestore.ExplainOptions.Builder

Sets whether analyzing the query is enabled.

setChannelProvider(TransportChannelProvider) - Method in class com.google.cloud.firestore.FirestoreOptions.Builder

Sets the TransportChannelProvider to use with this Firestore client.

setCredentialsProvider(CredentialsProvider) - Method in class com.google.cloud.firestore.FirestoreOptions.Builder

Sets the CredentialsProvider to use with this Firestore client.

setDatabaseId(String) - Method in class com.google.cloud.firestore.FirestoreOptions.Builder

Sets the database ID to use with this Firestore client.

setEmulatorHost(String) - Method in class com.google.cloud.firestore.FirestoreOptions.Builder

Sets the emulator host to use with this Firestore client.

setExecutor(Executor) - Method in class com.google.cloud.firestore.TransactionOptions.Builder

setExecutor(ScheduledExecutorService) - Method in class com.google.cloud.firestore.BulkWriterOptions.Builder

Set the executor that the BulkWriter instance schedules operations on.

setInitialOpsPerSecond(int) - Method in class com.google.cloud.firestore.BulkWriterOptions.Builder

Set the initial maximum number of operations per second allowed by the throttler.

setMaxOpsPerSecond(int) - Method in class com.google.cloud.firestore.BulkWriterOptions.Builder

Set the maximum number of operations per second allowed by the throttler.

setNumberOfAttempts(int) - Method in class com.google.cloud.firestore.TransactionOptions.ReadWriteOptionsBuilder

Specify the max number of attempts a transaction will be attempted before resulting in an error.

SetOptions - Class in com.google.cloud.firestore

An options object that configures the behavior of set() calls.

setReadTime(TimestampOrBuilder) - Method in class com.google.cloud.firestore.TransactionOptions.ReadOnlyOptionsBuilder

Specify to read documents at the given time.

setThrottlingEnabled(boolean) - Method in class com.google.cloud.firestore.BulkWriterOptions.Builder

Sets whether throttling should be enabled.

setTransportOptions(TransportOptions) - Method in class com.google.cloud.firestore.FirestoreOptions.Builder

Sets the TransportOptions to use with this Firestore client.

shortCircuitingInOrderTraversal(LLRBNode.ShortCircuitingNodeVisitor<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode

shortCircuitingInOrderTraversal(LLRBNode.ShortCircuitingNodeVisitor<K, V>) - Method in interface com.google.cloud.firestore.collection.LLRBNode

shortCircuitingInOrderTraversal(LLRBNode.ShortCircuitingNodeVisitor<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBValueNode

shortCircuitingReverseOrderTraversal(LLRBNode.ShortCircuitingNodeVisitor<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode

shortCircuitingReverseOrderTraversal(LLRBNode.ShortCircuitingNodeVisitor<K, V>) - Method in interface com.google.cloud.firestore.collection.LLRBNode

shortCircuitingReverseOrderTraversal(LLRBNode.ShortCircuitingNodeVisitor<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBValueNode

shouldContinue(K, V) - Method in class com.google.cloud.firestore.collection.LLRBNode.NodeVisitor

shouldContinue(K, V) - Method in interface com.google.cloud.firestore.collection.LLRBNode.ShortCircuitingNodeVisitor

shutdown() - Method in interface com.google.cloud.firestore.Firestore

Initiates an orderly shutdown in which previously submitted work is finished, but no new work will be accepted.

shutdown() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc

shutdown() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc

shutdown() - Method in class com.google.cloud.firestore.v1.FirestoreClient

shutdown() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

shutdown() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

shutdownNow() - Method in interface com.google.cloud.firestore.Firestore

Attempts to stop all actively executing work and halts the processing of waiting work.

shutdownNow() - Method in interface com.google.cloud.firestore.spi.v1.FirestoreRpc

shutdownNow() - Method in class com.google.cloud.firestore.spi.v1.GrpcFirestoreRpc

shutdownNow() - Method in class com.google.cloud.firestore.v1.FirestoreClient

shutdownNow() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

shutdownNow() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

size() - Method in class com.google.cloud.firestore.collection.ArraySortedMap

size() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

size() - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet

size() - Method in class com.google.cloud.firestore.collection.LLRBBlackValueNode

size() - Method in class com.google.cloud.firestore.collection.LLRBEmptyNode

size() - Method in interface com.google.cloud.firestore.collection.LLRBNode

size() - Method in class com.google.cloud.firestore.collection.LLRBRedValueNode

size() - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap

size() - Method in class com.google.cloud.firestore.QuerySnapshot

Returns the number of documents in the QuerySnapshot.

snapshotFromMap(String, Map<String, Object>) - Method in class com.google.cloud.firestore.Internal

snapshotFromObject(String, Object) - Method in class com.google.cloud.firestore.Internal

snapshotFromProto(Timestamp, Document) - Method in class com.google.cloud.firestore.Internal

startAfter(DocumentSnapshot) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query that starts after the provided document (exclusive).

startAfter(Object...) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query that starts after the provided fields relative to the order of the query.

startAt(DocumentSnapshot) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query that starts at the provided document (inclusive).

startAt(Object...) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query that starts at the provided fields relative to the order of the query.

stream(ApiStreamObserver<DocumentSnapshot>) - Method in class com.google.cloud.firestore.Query

Executes the query and streams the results as a StreamObserver of DocumentSnapshots.

sum(FieldPath) - Static method in class com.google.cloud.firestore.AggregateField

Create a AggregateField.SumAggregateField object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.

sum(String) - Static method in class com.google.cloud.firestore.AggregateField

Create a AggregateField.SumAggregateField object that can be used to compute the sum of a specified field over a range of documents in the result set of a query.

T

ThrowOnExtraProperties - Annotation Type in com.google.cloud.firestore.annotation

Properties that don't map to class fields when serializing to a class annotated with this annotation cause an exception to be thrown.

toBuilder() - Method in class com.google.cloud.firestore.BulkWriterOptions

toBuilder() - Method in class com.google.cloud.firestore.ExplainOptions

toBuilder() - Method in class com.google.cloud.firestore.FirestoreOptions

toBuilder() - Method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns a builder containing all the values of this settings class.

toBuilder() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns a builder containing all the values of this settings class.

toByteBuffer() - Method in class com.google.cloud.firestore.FirestoreBundle

Returns the bundle content as a readonly ByteBuffer.

toBytes() - Method in class com.google.cloud.firestore.Blob

Returns a copy of the underlying bytes as a byte[] array.

toByteString() - Method in class com.google.cloud.firestore.Blob

Returns the backing data as a ByteString.

toObject(Class<T>) - Method in class com.google.cloud.firestore.DocumentSnapshot

Returns the contents of the document converted to a POJO or null if the document doesn't exist.

toObject(Class<T>) - Method in class com.google.cloud.firestore.QueryDocumentSnapshot

Returns the contents of the document converted to a POJO.

toObjects(Class<T>) - Method in class com.google.cloud.firestore.QuerySnapshot

Returns the contents of the documents in the QuerySnapshot, converted to the provided class, as a list.

toProto() - Method in class com.google.cloud.firestore.AggregateQuery

Returns the RunAggregationQueryRequest that this AggregateQuery instance represents.

toProto() - Method in class com.google.cloud.firestore.ExplainOptions

toProto() - Method in class com.google.cloud.firestore.Query

Returns the RunQueryRequest that this Query instance represents.

toString() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap

toString() - Method in class com.google.cloud.firestore.DocumentReference

toString() - Method in class com.google.cloud.firestore.DocumentSnapshot

toString() - Method in class com.google.cloud.firestore.FieldPath

toString() - Method in class com.google.cloud.firestore.GeoPoint

toString() - Method in class com.google.cloud.firestore.UpdateBuilder

Transaction - Class in com.google.cloud.firestore

A Transaction is passed to a Function to provide the methods to read and write data within the transaction context.

Transaction(FirestoreImpl) - Constructor for class com.google.cloud.firestore.Transaction

Transaction.AsyncFunction<T> - Interface in com.google.cloud.firestore

User callback that takes a Firestore Async Transaction.

Transaction.Function<T> - Interface in com.google.cloud.firestore

User callback that takes a Firestore Transaction.

TransactionOptions - Class in com.google.cloud.firestore

Options specifying the behavior of Firestore Transactions.

TransactionOptions.Builder<B extends TransactionOptions.Builder<B>> - Class in com.google.cloud.firestore

TransactionOptions.ReadOnlyOptionsBuilder - Class in com.google.cloud.firestore

A typesafe builder class representing those options that are applicable when configuring a transaction to be read-only.

TransactionOptions.ReadWriteOptionsBuilder - Class in com.google.cloud.firestore

A typesafe builder class representing those options that are applicable when configuring a transaction to be read-write.

TransactionOptions.TransactionOptionsType - Enum in com.google.cloud.firestore

translate(C) - Method in interface com.google.cloud.firestore.collection.ImmutableSortedMap.Builder.KeyTranslator

U

unaryMethodSettingsBuilders() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

update(DocumentReference, FieldPath, Object, Object...) - Method in class com.google.cloud.firestore.BulkWriter

Update fields of the document referred to by the provided DocumentReference.

update(DocumentReference, FieldPath, Object, Object...) - Method in class com.google.cloud.firestore.UpdateBuilder

Updates the fields in the document referred to by this DocumentReference.

update(DocumentReference, Precondition, FieldPath, Object, Object...) - Method in class com.google.cloud.firestore.BulkWriter

Update fields of the document referred to by the provided DocumentReference.

update(DocumentReference, Precondition, FieldPath, Object, Object...) - Method in class com.google.cloud.firestore.UpdateBuilder

Updates the fields in the document referred to by this DocumentReference.

update(DocumentReference, Precondition, String, Object, Object...) - Method in class com.google.cloud.firestore.BulkWriter

Update fields of the document referred to by the provided DocumentReference.

update(DocumentReference, Precondition, String, Object, Object...) - Method in class com.google.cloud.firestore.UpdateBuilder

Updates the fields in the document referred to by this DocumentReference.

update(DocumentReference, String, Object, Object...) - Method in class com.google.cloud.firestore.BulkWriter

Update fields of the document referred to by the provided DocumentReference.

update(DocumentReference, String, Object, Object...) - Method in class com.google.cloud.firestore.UpdateBuilder

Updates the fields in the document referred to by this DocumentReference.

update(DocumentReference, Map<String, Object>) - Method in class com.google.cloud.firestore.BulkWriter

Update fields of the document referred to by the provided DocumentReference.

update(DocumentReference, Map<String, Object>) - Method in class com.google.cloud.firestore.UpdateBuilder

Updates fields in the document referred to by this DocumentReference.

update(DocumentReference, Map<String, Object>, Precondition) - Method in class com.google.cloud.firestore.BulkWriter

Update fields of the document referred to by the provided DocumentReference.

update(DocumentReference, Map<String, Object>, Precondition) - Method in class com.google.cloud.firestore.UpdateBuilder

Updates fields in the document referred to by this DocumentReference.

update(FieldPath, Object, Object...) - Method in class com.google.cloud.firestore.DocumentReference

Updates the fields in the document referred to by this DocumentReference.

update(Precondition, FieldPath, Object, Object...) - Method in class com.google.cloud.firestore.DocumentReference

Updates the fields in the document referred to by this DocumentReference.

update(Precondition, String, Object, Object...) - Method in class com.google.cloud.firestore.DocumentReference

Updates the fields in the document referred to by this DocumentReference.

update(String, Object, Object...) - Method in class com.google.cloud.firestore.DocumentReference

Updates the fields in the document referred to by this DocumentReference.

update(Map<String, Object>) - Method in class com.google.cloud.firestore.DocumentReference

Updates fields in the document referred to by this DocumentReference.

update(Map<String, Object>, Precondition) - Method in class com.google.cloud.firestore.DocumentReference

Updates fields in the document referred to by this DocumentReference.

UpdateBuilder<T> - Class in com.google.cloud.firestore

Abstract class that collects and bundles all write operations for Transaction and WriteBatch.

updateCallback(Transaction) - Method in interface com.google.cloud.firestore.Transaction.AsyncFunction

updateCallback(Transaction) - Method in interface com.google.cloud.firestore.Transaction.Function

updatedAt(Timestamp) - Static method in class com.google.cloud.firestore.Precondition

Creates a Precondition that enforces that the existing document was written at the specified time.

updateDocument(Document, DocumentMask) - Method in class com.google.cloud.firestore.v1.FirestoreClient

Updates or inserts a document.

updateDocument(UpdateDocumentRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient

Updates or inserts a document.

updateDocumentCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient

Updates or inserts a document.

updateDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

updateDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

updateDocumentCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

updateDocumentSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Returns the builder for the settings used for calls to updateDocument.

updateDocumentSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns the object with the settings used for calls to updateDocument.

updateDocumentSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Returns the builder for the settings used for calls to updateDocument.

updateDocumentSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the object with the settings used for calls to updateDocument.

V

value() - Element in annotation type com.google.cloud.firestore.annotation.PropertyName

valueOf(String) - Static method in enum com.google.cloud.firestore.collection.LLRBNode.Color

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.google.cloud.firestore.DocumentChange.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.google.cloud.firestore.Query.Direction

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.google.cloud.firestore.TransactionOptions.TransactionOptionsType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.google.cloud.firestore.collection.LLRBNode.Color

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.google.cloud.firestore.DocumentChange.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.google.cloud.firestore.Query.Direction

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.google.cloud.firestore.TransactionOptions.TransactionOptionsType

Returns an array containing the constants of this enum type, in the order they are declared.

visitEntry(K, V) - Method in class com.google.cloud.firestore.collection.LLRBNode.NodeVisitor

W

where(Filter) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter.

whereArrayContains(FieldPath, Object) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain the provided value.

whereArrayContains(String, Object) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain the provided value.

whereArrayContainsAny(FieldPath, List<? extends Object>) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain at least one value from the provided list.

whereArrayContainsAny(String, List<? extends Object>) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field, the value must be an array, and that the array must contain at least one value from the provided list.

whereEqualTo(FieldPath, Object) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be equal to the specified value.

whereEqualTo(String, Object) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be equal to the specified value.

whereGreaterThan(FieldPath, Object) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be greater than the specified value.

whereGreaterThan(String, Object) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be greater than the specified value.

whereGreaterThanOrEqualTo(FieldPath, Object) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be greater than or equal to the specified value.

whereGreaterThanOrEqualTo(String, Object) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be greater than or equal to the specified value.

whereIn(FieldPath, List<? extends Object>) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value must equal one of the values from the provided list.

whereIn(String, List<? extends Object>) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value must equal one of the values from the provided list.

whereLessThan(FieldPath, Object) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be less than the specified value.

whereLessThan(String, Object) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be less than the specified value.

whereLessThanOrEqualTo(FieldPath, Object) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be less or equal to the specified value.

whereLessThanOrEqualTo(String, Object) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should be less or equal to the specified value.

whereNotEqualTo(FieldPath, Object) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value does not equal the specified value.

whereNotEqualTo(String, Object) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field and its value does not equal the specified value.

whereNotIn(FieldPath, List<? extends Object>) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value does not equal any of the values from the provided list.

whereNotIn(String, List<? extends Object>) - Method in class com.google.cloud.firestore.Query

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value does not equal any of the values from the provided list.

withChanges(Query, Timestamp, DocumentSet, List<DocumentChange>) - Static method in class com.google.cloud.firestore.QuerySnapshot

Creates a new QuerySnapshot representing a snapshot of a Query with changed documents.

withDocuments(Query, Timestamp, List<QueryDocumentSnapshot>) - Static method in class com.google.cloud.firestore.QuerySnapshot

Creates a new QuerySnapshot representing the results of a Query with added documents.

WriteBatch - Class in com.google.cloud.firestore

A Firestore WriteBatch that can be used to atomically commit multiple write operations at once.

writeCallable() - Method in class com.google.cloud.firestore.v1.FirestoreClient

Streams batches of document updates and deletes, in order.

writeCallable() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStub

writeCallable() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub

writeCallable() - Method in class com.google.cloud.firestore.v1.stub.HttpJsonFirestoreStub

WriteResult - Class in com.google.cloud.firestore

A WriteResult exposes the update time set by the server.

writeSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings.Builder

Returns the builder for the settings used for calls to write.

writeSettings() - Method in class com.google.cloud.firestore.v1.FirestoreSettings

Returns the object with the settings used for calls to write.

writeSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder

Returns the builder for the settings used for calls to write.

writeSettings() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings

Returns the object with the settings used for calls to write.

A B C D E F G H I L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form