- 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.
- 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(DocumentSnapshot) - Method in class com.google.cloud.firestore.FirestoreBundle.Builder
-
Adds a Firestore document snapshot to the bundle.
- add(String, QuerySnapshot) - Method in class com.google.cloud.firestore.FirestoreBundle.Builder
-
Adds a Firestore query snapshot to the bundle.
- addSnapshotListener(Executor, EventListener<DocumentSnapshot>) - Method in class com.google.cloud.firestore.DocumentReference
-
Starts listening to the document referenced by this DocumentReference.
- 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<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.
- 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.
- 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.
- autoBuild() - Method in class com.google.cloud.firestore.BulkWriterOptions.Builder
-
- autoId() - Static method in class com.google.cloud.firestore.Internal
-
- 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
-
- 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
-
- 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
-
- 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(String) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Starts a new transaction.
- beginTransaction(BeginTransactionRequest) - 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
-
- 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.
- 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.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() - Constructor for class com.google.cloud.firestore.BulkWriterOptions.Builder
-
- Builder() - Constructor for class com.google.cloud.firestore.collection.ImmutableSortedMap.Builder
-
- Builder(Executor) - Constructor for class com.google.cloud.firestore.TransactionOptions.Builder
-
- Builder() - Constructor for class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
- Builder(ClientContext) - Constructor for class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
- Builder(FirestoreSettings) - Constructor for class com.google.cloud.firestore.v1.FirestoreSettings.Builder
-
- Builder(FirestoreStubSettings.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.stub.FirestoreStubSettings.Builder
-
- Builder(FirestoreStubSettings) - Constructor for class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.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 - Class in com.google.cloud.firestore
-
A Firestore BulkWriter that can be used to perform a large number of writes in parallel.
- 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.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
-
- bundleBuilder(String) - Method in interface com.google.cloud.firestore.Firestore
-
- 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
-
- 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
-
- 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.
- 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}.
- 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
-
The interfaces provided are listed below, along with usage samples.
- com.google.cloud.firestore.v1.stub - package com.google.cloud.firestore.v1.stub
-
- commit(String, List<Write>) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Commits a transaction, while optionally updating documents.
- commit(CommitRequest) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Commits a transaction, while optionally updating documents.
- commit() - Method in class com.google.cloud.firestore.WriteBatch
-
Applies the current WriteBatch and returns an array with WriteResults.
- 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
-
- 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
-
- compare(A, A) - Method in class com.google.cloud.firestore.collection.StandardComparator
-
- compareTo(B) - Method in class com.google.cloud.firestore.BasePath
-
Compare the current path lexicographically against another Path object.
- contains(T) - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet
-
- contains(String) - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns whether or not the field exists in the document.
- contains(FieldPath) - Method in class com.google.cloud.firestore.DocumentSnapshot
-
Returns whether or not the field exists in the document.
- 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<K, V>, LLRBNode<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBBlackValueNode
-
- 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<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
-
- copy(K, V, LLRBNode.Color, LLRBNode<K, V>, LLRBNode<K, V>) - Method in class com.google.cloud.firestore.collection.LLRBValueNode
-
- create(DocumentReference, Map<String, 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.BulkWriter
-
Create a document with the provided data.
- create(Map<String, Object>) - Method in class com.google.cloud.firestore.DocumentReference
-
Creates a new Document at the DocumentReference's Location.
- create(Object) - Method in class com.google.cloud.firestore.DocumentReference
-
Creates a new Document at the DocumentReference location.
- create(FirestoreOptions) - Method in class com.google.cloud.firestore.FirestoreOptions.DefaultFirestoreFactory
-
- create(FirestoreOptions) - Method in class com.google.cloud.firestore.FirestoreOptions.DefaultFirestoreRpcFactory
-
- create() - Static method in class com.google.cloud.firestore.TransactionOptions
-
Create a default set of options suitable for most use cases.
- create(int) - Static method in class com.google.cloud.firestore.TransactionOptions
-
- create(Executor) - Static method in class com.google.cloud.firestore.TransactionOptions
-
- create(Executor, int) - Static method in class com.google.cloud.firestore.TransactionOptions
-
- create(DocumentReference, Map<String, Object>) - Method in class com.google.cloud.firestore.UpdateBuilder
-
Creates a new Document at the DocumentReference's location.
- create(DocumentReference, Object) - Method in class com.google.cloud.firestore.UpdateBuilder
-
Creates a new Document at the DocumentReference location.
- create() - Static method in class com.google.cloud.firestore.v1.FirestoreClient
-
Constructs an instance of FirestoreClient with default settings.
- 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(ClientContext) - Static method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
-
- create(ClientContext, GrpcStubCallableFactory) - Static method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- defaultGrpcTransportProviderBuilder() - Static method in class com.google.cloud.firestore.v1.FirestoreSettings
-
Returns a builder for the default ChannelProvider for this service.
- defaultGrpcTransportProviderBuilder() - Static method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings
-
Returns a builder for the default 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(DocumentReference) - Method in class com.google.cloud.firestore.BulkWriter
-
Delete a document from the database.
- delete(DocumentReference, Precondition) - Method in class com.google.cloud.firestore.BulkWriter
-
Delete a document from the database.
- delete(Precondition) - Method in class com.google.cloud.firestore.DocumentReference
-
Deletes the document referred to by this DocumentReference.
- 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, Precondition) - Method in class com.google.cloud.firestore.UpdateBuilder
-
Deletes the document referred to by this DocumentReference.
- delete(DocumentReference) - Method in class com.google.cloud.firestore.UpdateBuilder
-
Deletes the document referred to by this DocumentReference.
- deleteDocument(String) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Deletes a document.
- deleteDocument(DeleteDocumentRequest) - 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
-
- 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.
- 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
-
- 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 - Annotation Type in com.google.cloud.firestore.annotation
-
- documentId() - Static method in class com.google.cloud.firestore.FieldPath
-
A special sentinel to refer to the ID of a document.
- 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.
- 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(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.
- endAt(DocumentSnapshot) - Method in class com.google.cloud.firestore.Query
-
Creates and returns a new Query that ends at the provided document (inclusive).
- 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.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.
- 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.
- 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.
- 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().
- 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
-
- 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
-
- 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<K, V>, Comparator<K>) - Static method in class com.google.cloud.firestore.collection.ArraySortedMap
-
- 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
-
- 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.
- 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(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
-
- get() - Method in class com.google.cloud.firestore.DocumentReference
-
Reads the document referenced by this DocumentReference.
- get(FieldMask) - Method in class com.google.cloud.firestore.DocumentReference
-
Reads the document referenced by this DocumentReference.
- 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(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() - Method in class com.google.cloud.firestore.Query
-
Executes the query and returns the results as QuerySnapshot.
- get(DocumentReference) - Method in class com.google.cloud.firestore.Transaction
-
Reads the document referred to by the provided DocumentReference.
- get(Query) - Method in class com.google.cloud.firestore.Transaction
-
Returns the result set from the provided query.
- getAll(DocumentReference...) - Method in interface com.google.cloud.firestore.Firestore
-
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, 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.
- getAll(DocumentReference...) - Method in class com.google.cloud.firestore.Transaction
-
Retrieves multiple documents from Firestore.
- 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.
- 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
-
- getComparator(Class<T>) - Static method in class com.google.cloud.firestore.collection.StandardComparator
-
- 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.
- 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
-
- 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(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.
- 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, e.g.
- 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, e.g.
- 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.
- 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(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
-
- 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 (i.e.
- 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
(i.e.
- getOperationsStub() - Method in class com.google.cloud.firestore.v1.stub.GrpcFirestoreStub
-
- getOperationType() - Method in exception com.google.cloud.firestore.BulkWriterException
-
- 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, ApiStreamObserver<QueryPartition>) - Method in class com.google.cloud.firestore.CollectionGroup
-
- getPartitions(long) - Method in class com.google.cloud.firestore.CollectionGroup
-
- 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).
- 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.QuerySnapshot
-
Returns the query for the snapshot.
- 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
-
- 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
-
- getSettings() - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
- 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
-
- 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.
- 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(String) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Lists all the collection IDs underneath a document.
- listCollectionIds(ListCollectionIdsRequest) - 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- RBTreeSortedMap<K,V> - Class in com.google.cloud.firestore.collection
-
This is a red-black tree backed implementation of ImmutableSortedMap.
- 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.
- 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(K) - Method in class com.google.cloud.firestore.collection.ArraySortedMap
-
- remove(K) - Method in class com.google.cloud.firestore.collection.ImmutableSortedMap
-
- remove() - Method in class com.google.cloud.firestore.collection.ImmutableSortedMapIterator
-
- remove(T) - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet
-
- 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(K) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap
-
- remove() - Method in interface com.google.cloud.firestore.ListenerRegistration
-
Removes the listener being tracked by this ListenerRegistration.
- 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(T) - Method in class com.google.cloud.firestore.collection.ImmutableSortedSet
-
- reverseIteratorFrom(K) - Method in class com.google.cloud.firestore.collection.RBTreeSortedMap
-
- rollback(String, ByteString) - Method in class com.google.cloud.firestore.v1.FirestoreClient
-
Rolls back a transaction.
- rollback(RollbackRequest) - 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
-
- 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
-
- 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
-
- 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.
- 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.
- 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.
- ServerTimestamp - Annotation Type in com.google.cloud.firestore.annotation
-
Annotation used to mark a timestamp field as being populated via Server Timestamps.
- 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.
- 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>, 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.BulkWriter
-
Write to the document referred to by the provided DocumentReference.
- set(DocumentReference, Object) - Method in class com.google.cloud.firestore.BulkWriter
-
Write to the document referred to by the provided 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.
- 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(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.UpdateBuilder
-
Overwrites the document referred to by this 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.UpdateBuilder
-
Overwrites the document referred to by this DocumentReference.
- 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(ScheduledExecutorService) - Method in class com.google.cloud.firestore.BulkWriterOptions.Builder
-
Set the executor that the BulkWriter instance schedules operations on.
- setExecutor(Executor) - Method in class com.google.cloud.firestore.TransactionOptions.Builder
-
- 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
-
- 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
-
- 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
-
- StandardComparator<A extends Comparable<A>> - Class in com.google.cloud.firestore.collection
-
- 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.
- unaryMethodSettingsBuilders() - Method in class com.google.cloud.firestore.v1.stub.FirestoreStubSettings.Builder
-
- update(DocumentReference, Map<String, Object>) - Method in class com.google.cloud.firestore.BulkWriter
-
- update(DocumentReference, Map<String, Object>, Precondition) - Method in class com.google.cloud.firestore.BulkWriter
-
- update(DocumentReference, String, Object, Object...) - Method in class com.google.cloud.firestore.BulkWriter
-
- update(DocumentReference, FieldPath, Object, Object...) - Method in class com.google.cloud.firestore.BulkWriter
-
- update(DocumentReference, Precondition, String, Object, Object...) - Method in class com.google.cloud.firestore.BulkWriter
-
- update(DocumentReference, Precondition, FieldPath, Object, Object...) - Method in class com.google.cloud.firestore.BulkWriter
-
- 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.
- update(String, Object, Object...) - Method in class com.google.cloud.firestore.DocumentReference
-
Updates the 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, String, 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(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.UpdateBuilder
-
Updates fields in the document referred to by this 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, 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.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.UpdateBuilder
-
Updates the fields in the document referred to by this DocumentReference.
- UpdateBuilder<T> - Class in com.google.cloud.firestore
-
- 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
-
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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
-
- 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.