Index (Google Cloud Firestore 0.30.0-beta API)

A B C D E F G H I L M N O P Q R S T U V W

A

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.
applyToAllUnaryMethods(ApiFunction<UnaryCallSettings.Builder<?, ?>, Void>) - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings.Builder: Applies the given settings updater function to all of the unary API methods in this service.
awaitTermination(long, TimeUnit) - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient
awaitTermination(long, TimeUnit) - Method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub

B

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.v1beta1.FirestoreRpc: Gets multiple documents.
batchGetDocumentsCallable() - Method in class com.google.cloud.firestore.spi.v1beta1.GrpcFirestoreRpc
batchGetDocumentsCallable() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Gets multiple documents.
batchGetDocumentsCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.FirestoreStub
batchGetDocumentsCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
batchGetDocumentsSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: Returns the object with the settings used for calls to batchGetDocuments.
batchGetDocumentsSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings.Builder: Returns the builder for the settings used for calls to batchGetDocuments.
beginTransaction(String) - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Starts a new transaction.
beginTransaction(BeginTransactionRequest) - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Starts a new transaction.
beginTransactionCallable() - Method in interface com.google.cloud.firestore.spi.v1beta1.FirestoreRpc: Starts a new transaction.
beginTransactionCallable() - Method in class com.google.cloud.firestore.spi.v1beta1.GrpcFirestoreRpc
beginTransactionCallable() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Starts a new transaction.
beginTransactionCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.FirestoreStub
beginTransactionCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
beginTransactionSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: Returns the object with the settings used for calls to beginTransaction.
beginTransactionSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings.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.FirestoreOptions.Builder
build() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings.Builder

C

close() - Method in class com.google.cloud.firestore.spi.v1beta1.GrpcFirestoreRpc
close() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient
close() - Method in class com.google.cloud.firestore.v1beta1.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: Gets a CollectionReference that refers to the collection at the specified path.
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.spi.v1beta1 - package com.google.cloud.firestore.spi.v1beta1
com.google.cloud.firestore.v1beta1 - package com.google.cloud.firestore.v1beta1: A client to Google Cloud Firestore API.
com.google.cloud.firestore.v1beta1.stub - package com.google.cloud.firestore.v1beta1.stub
commit(String, List<Write>) - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Commits a transaction, while optionally updating documents.
commit(CommitRequest) - Method in class com.google.cloud.firestore.v1beta1.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.v1beta1.FirestoreRpc: Commits a transaction, while optionally updating documents.
commitCallable() - Method in class com.google.cloud.firestore.spi.v1beta1.GrpcFirestoreRpc
commitCallable() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Commits a transaction, while optionally updating documents.
commitCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.FirestoreStub
commitCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
commitSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings.Builder: Returns the builder for the settings used for calls to commit.
commitSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: Returns the object with the settings used for calls to commit.
compareTo(FieldPath) - Method in class com.google.cloud.firestore.FieldPath
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.
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 a default set of options with a custom number of retry attempts.
create(Executor) - Static method in class com.google.cloud.firestore.TransactionOptions: Create a default set of options with a custom executor.
create(Executor, int) - Static method in class com.google.cloud.firestore.TransactionOptions: Create a default set of options with a custom executor and a custom number of retry attempts.
create() - Static method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Constructs an instance of FirestoreClient with default settings.
create(FirestoreSettings) - Static method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Constructs an instance of FirestoreClient, using the given settings.
create(FirestoreStub) - Static method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Constructs an instance of FirestoreClient, using the given stub for making calls.
create(FirestoreSettings) - Static method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
create(ClientContext) - Static method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
createAsync(PageContext<ListCollectionIdsRequest, ListCollectionIdsResponse, String>, ApiFuture<ListCollectionIdsResponse>) - Static method in class com.google.cloud.firestore.v1beta1.PagedResponseWrappers.ListCollectionIdsPagedResponse
createAsync(PageContext<ListDocumentsRequest, ListDocumentsResponse, Document>, ApiFuture<ListDocumentsResponse>) - Static method in class com.google.cloud.firestore.v1beta1.PagedResponseWrappers.ListDocumentsPagedResponse
createCollection(List<PagedResponseWrappers.ListCollectionIdsPage>, int) - Method in class com.google.cloud.firestore.v1beta1.PagedResponseWrappers.ListCollectionIdsFixedSizeCollection
createCollection(List<PagedResponseWrappers.ListDocumentsPage>, int) - Method in class com.google.cloud.firestore.v1beta1.PagedResponseWrappers.ListDocumentsFixedSizeCollection
createDocument(CreateDocumentRequest) - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Creates a new document.
createDocumentCallable() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Creates a new document.
createDocumentCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.FirestoreStub
createDocumentCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
createDocumentSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings.Builder: Returns the builder for the settings used for calls to createDocument.
createDocumentSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: Returns the object with the settings used for calls to createDocument.
createPage(PageContext<ListCollectionIdsRequest, ListCollectionIdsResponse, String>, ListCollectionIdsResponse) - Method in class com.google.cloud.firestore.v1beta1.PagedResponseWrappers.ListCollectionIdsPage
createPage(PageContext<ListDocumentsRequest, ListDocumentsResponse, Document>, ListDocumentsResponse) - Method in class com.google.cloud.firestore.v1beta1.PagedResponseWrappers.ListDocumentsPage
createPageAsync(PageContext<ListCollectionIdsRequest, ListCollectionIdsResponse, String>, ApiFuture<ListCollectionIdsResponse>) - Method in class com.google.cloud.firestore.v1beta1.PagedResponseWrappers.ListCollectionIdsPage
createPageAsync(PageContext<ListDocumentsRequest, ListDocumentsResponse, Document>, ApiFuture<ListDocumentsResponse>) - Method in class com.google.cloud.firestore.v1beta1.PagedResponseWrappers.ListDocumentsPage
createStub() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings

D

defaultApiClientHeaderProviderBuilder() - Static method in class com.google.cloud.firestore.v1beta1.FirestoreSettings
defaultCredentialsProviderBuilder() - Static method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: Returns a builder for the default credentials for this service.
defaultExecutorProviderBuilder() - Static method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: 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.v1beta1.FirestoreSettings: Returns a builder for the default ChannelProvider for this service.
defaultTransportChannelProvider() - Static method in class com.google.cloud.firestore.v1beta1.FirestoreSettings
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.
deleteDocument(String) - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Deletes a document.
deleteDocument(DeleteDocumentRequest) - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Deletes a document.
deleteDocumentCallable() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Deletes a document.
deleteDocumentCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.FirestoreStub
deleteDocumentCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
deleteDocumentSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings.Builder: Returns the builder for the settings used for calls to deleteDocument.
deleteDocumentSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: 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: Gets a DocumentReference that refers to the document at the specified path.
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.

E

endAt(Object...) - Method in class com.google.cloud.firestore.Query: Creates and returns a new Query that ends at the provided fields relative to the order of the query.
endBefore(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
equals(Object) - Method in class com.google.cloud.firestore.DocumentReference
equals(Object) - Method in class com.google.cloud.firestore.DocumentSnapshot
equals(Object) - Method in class com.google.cloud.firestore.FirestoreOptions
equals(Object) - Method in class com.google.cloud.firestore.GeoPoint
equals(Object) - Method in class com.google.cloud.firestore.Precondition
equals(Object) - Method in class com.google.cloud.firestore.Query
equals(Object) - Method in class com.google.cloud.firestore.QuerySnapshot
equals(Object) - Method in class com.google.cloud.firestore.SetOptions
Exclude - Annotation Type in com.google.cloud.firestore.annotation: Marks a field as excluded from the Database.
exists() - Method in class com.google.cloud.firestore.DocumentSnapshot: Returns whether the backing document exists in Firestore.

F

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
FirestoreClient - Class in com.google.cloud.firestore.v1beta1: Service Description: The Cloud Firestore service.
FirestoreClient(FirestoreSettings) - Constructor for class com.google.cloud.firestore.v1beta1.FirestoreClient: Constructs an instance of FirestoreClient, using the given settings.
FirestoreClient(FirestoreStub) - Constructor for class com.google.cloud.firestore.v1beta1.FirestoreClient
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
FirestoreRpc - Interface in com.google.cloud.firestore.spi.v1beta1: 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.v1beta1: Settings class to configure an instance of FirestoreClient.
FirestoreSettings.Builder - Class in com.google.cloud.firestore.v1beta1: Builder for FirestoreSettings.
FirestoreStub - Class in com.google.cloud.firestore.v1beta1.stub: Base stub class for Google Cloud Firestore API.
FirestoreStub() - Constructor for class com.google.cloud.firestore.v1beta1.stub.FirestoreStub
formatAnyPathName(String, String, String, String) - Static method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Formats a string containing the fully-qualified path to represent a any_path resource.
formatDatabaseRootName(String, String) - Static method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Formats a string containing the fully-qualified path to represent a database_root resource.
formatDocumentPathName(String, String, String) - Static method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Formats a string containing the fully-qualified path to represent a document_path resource.
formatDocumentRootName(String, String) - Static method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Formats a string containing the fully-qualified path to represent a document_root resource.
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.

G

GeoPoint - Class in com.google.cloud.firestore: Immutable class representing a geographic location in Firestore
GeoPoint(double, double) - Constructor for class com.google.cloud.firestore.GeoPoint: Construct a new GeoPoint using the provided latitude and longitude values.
get() - Method in class com.google.cloud.firestore.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(FieldPath) - Method in class com.google.cloud.firestore.DocumentSnapshot: Returns the value at the field or null if the field 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.
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.
getCollections() - Method in class com.google.cloud.firestore.DocumentReference: Fetches the subcollections that are direct children of this document.
getCollections() - Method in interface com.google.cloud.firestore.Firestore: Fetches the root collections that are associated with this Firestore database.
getCreateTime() - Method in class com.google.cloud.firestore.DocumentSnapshot: Returns the time at which this document was created.
getData() - Method in class com.google.cloud.firestore.DocumentSnapshot: 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.
getDefaultEndpoint() - Static method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: Returns the default service endpoint.
getDefaultGrpcTransportOptions() - Static method in class com.google.cloud.firestore.FirestoreOptions
getDefaultHost() - Method in class com.google.cloud.firestore.FirestoreOptions
getDefaultInstance() - Static method in class com.google.cloud.firestore.FirestoreOptions: Returns a default FirestoreOptions instance.
getDefaultServiceScopes() - Static method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: Returns the default service scopes.
getDocument(GetDocumentRequest) - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Gets a single document.
getDocumentCallable() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Gets a single document.
getDocumentCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.FirestoreStub
getDocumentCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
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.v1beta1.FirestoreSettings.Builder: Returns the builder for the settings used for calls to getDocument.
getDocumentSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: 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.
getExecutor() - Method in interface com.google.cloud.firestore.spi.v1beta1.FirestoreRpc: Returns the executor used by the GAPIC client.
getExecutor() - Method in class com.google.cloud.firestore.spi.v1beta1.GrpcFirestoreRpc
getExecutor() - Method in class com.google.cloud.firestore.TransactionOptions
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.
getLatitude() - Method in class com.google.cloud.firestore.GeoPoint: Returns the latitude.
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.
getNumberOfAttempts() - Method in class com.google.cloud.firestore.TransactionOptions
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.
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).
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.
getReference() - Method in class com.google.cloud.firestore.DocumentSnapshot: Gets the reference to the document.
getScopes() - Method in class com.google.cloud.firestore.FirestoreOptions
getSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient
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.v1beta1.FirestoreClient
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.
GrpcFirestoreRpc - Class in com.google.cloud.firestore.spi.v1beta1: GRPC client implementation of the Firestore RPC methods.
GrpcFirestoreRpc(FirestoreOptions) - Constructor for class com.google.cloud.firestore.spi.v1beta1.GrpcFirestoreRpc
GrpcFirestoreStub - Class in com.google.cloud.firestore.v1beta1.stub: gRPC stub implementation for Google Cloud Firestore API.
GrpcFirestoreStub(FirestoreSettings, ClientContext) - Constructor for class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub: Constructs an instance of GrpcFirestoreStub, using the given settings.

H

hashCode() - Method in class com.google.cloud.firestore.Blob
hashCode() - Method in class com.google.cloud.firestore.DocumentReference
hashCode() - Method in class com.google.cloud.firestore.DocumentSnapshot
hashCode() - Method in class com.google.cloud.firestore.FirestoreOptions
hashCode() - Method in class com.google.cloud.firestore.GeoPoint
hashCode() - Method in class com.google.cloud.firestore.Precondition
hashCode() - Method in class com.google.cloud.firestore.Query
hashCode() - Method in class com.google.cloud.firestore.QuerySnapshot
hashCode() - Method in class com.google.cloud.firestore.SetOptions

I

IgnoreExtraProperties - Annotation Type in com.google.cloud.firestore.annotation: Properties that don't map to class fields are ignored when serializing to a class annotated with this annotation.
isEmpty() - Method in class com.google.cloud.firestore.QuerySnapshot: Returns true if there are no documents in the QuerySnapshot.
isShutdown() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient
isShutdown() - Method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
isTerminated() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient
isTerminated() - Method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
iterator() - Method in class com.google.cloud.firestore.QuerySnapshot

L

limit(int) - Method in class com.google.cloud.firestore.Query: Creates and returns a new Query that's additionally limited to only return up to the specified number of documents.
listCollectionIds(String) - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Lists all the collection IDs underneath a document.
listCollectionIds(ListCollectionIdsRequest) - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Lists all the collection IDs underneath a document.
listCollectionIdsCallable() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Lists all the collection IDs underneath a document.
listCollectionIdsCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.FirestoreStub
listCollectionIdsCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
listCollectionIdsPagedCallable() - Method in interface com.google.cloud.firestore.spi.v1beta1.FirestoreRpc: Returns a list of collections IDs.
listCollectionIdsPagedCallable() - Method in class com.google.cloud.firestore.spi.v1beta1.GrpcFirestoreRpc
listCollectionIdsPagedCallable() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Lists all the collection IDs underneath a document.
listCollectionIdsPagedCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.FirestoreStub
listCollectionIdsPagedCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
listCollectionIdsSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings.Builder: Returns the builder for the settings used for calls to listCollectionIds.
listCollectionIdsSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: Returns the object with the settings used for calls to listCollectionIds.
listDocuments(ListDocumentsRequest) - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Lists documents.
listDocumentsCallable() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Lists documents.
listDocumentsCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.FirestoreStub
listDocumentsCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
listDocumentsPagedCallable() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Lists documents.
listDocumentsPagedCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.FirestoreStub
listDocumentsPagedCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
listDocumentsSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings.Builder: Returns the builder for the settings used for calls to listDocuments.
listDocumentsSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: Returns the object with the settings used for calls to listDocuments.
listenCallable() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Listens to changes.
listenCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.FirestoreStub
listenCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
listenSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings.Builder: Returns the builder for the settings used for calls to listen.
listenSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: Returns the object with the settings used for calls to listen.

M

merge() - Static method in class com.google.cloud.firestore.SetOptions: Changes the behavior of set() calls to only replace the values specified in its data argument.
mergeFieldPaths(List<FieldPath>) - Static method in class com.google.cloud.firestore.SetOptions: Changes the behavior of set() calls to only replace the fields under fieldPaths.
mergeFields(List<String>) - Static method in class com.google.cloud.firestore.SetOptions: Changes the behavior of set() calls to only replace the fields under fieldPaths.
mergeFields(String...) - Static method in class com.google.cloud.firestore.SetOptions: Changes the behavior of set() calls to only replace the fields under fieldPaths.

N

newBuilder() - Static method in class com.google.cloud.firestore.FirestoreOptions
newBuilder() - Static method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: Returns a new builder for this class.
newBuilder(ClientContext) - Static method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: Returns a new builder for this class.
NONE - Static variable in class com.google.cloud.firestore.Precondition: An empty Precondition that adds no enforcements

O

of(String...) - Static method in class com.google.cloud.firestore.FieldPath: Creates a FieldPath from the provided field names.
offset(int) - Method in class com.google.cloud.firestore.Query: Creates and returns a new Query that skips the first n results.
orderBy(String) - Method in class com.google.cloud.firestore.Query: Creates and returns a new Query that's additionally sorted by the specified field.
orderBy(FieldPath) - Method in class com.google.cloud.firestore.Query: Creates and returns a new Query that's additionally sorted by the specified field.
orderBy(String, Query.Direction) - Method in class com.google.cloud.firestore.Query: Creates and returns a new Query that's additionally sorted by the specified field, optionally in descending order instead of ascending.
orderBy(FieldPath, Query.Direction) - Method in class com.google.cloud.firestore.Query: Creates and returns a new Query that's additionally sorted by the specified field, optionally in descending order instead of ascending.

P

PagedResponseWrappers - Class in com.google.cloud.firestore.v1beta1: Wrapper class to contain paged response types for page streaming methods.
PagedResponseWrappers() - Constructor for class com.google.cloud.firestore.v1beta1.PagedResponseWrappers
PagedResponseWrappers.ListCollectionIdsFixedSizeCollection - Class in com.google.cloud.firestore.v1beta1
PagedResponseWrappers.ListCollectionIdsPage - Class in com.google.cloud.firestore.v1beta1
PagedResponseWrappers.ListCollectionIdsPagedResponse - Class in com.google.cloud.firestore.v1beta1
PagedResponseWrappers.ListDocumentsFixedSizeCollection - Class in com.google.cloud.firestore.v1beta1
PagedResponseWrappers.ListDocumentsPage - Class in com.google.cloud.firestore.v1beta1
PagedResponseWrappers.ListDocumentsPagedResponse - Class in com.google.cloud.firestore.v1beta1
parseAnyPathFromAnyPathName(String) - Static method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Parses the any_path from the given fully-qualified path which represents a any_path resource.
parseDatabaseFromAnyPathName(String) - Static method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Parses the database from the given fully-qualified path which represents a any_path resource.
parseDatabaseFromDatabaseRootName(String) - Static method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Parses the database from the given fully-qualified path which represents a database_root resource.
parseDatabaseFromDocumentPathName(String) - Static method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Parses the database from the given fully-qualified path which represents a document_path resource.
parseDatabaseFromDocumentRootName(String) - Static method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Parses the database from the given fully-qualified path which represents a document_root resource.
parseDocumentFromAnyPathName(String) - Static method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Parses the document from the given fully-qualified path which represents a any_path resource.
parseDocumentPathFromDocumentPathName(String) - Static method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Parses the document_path from the given fully-qualified path which represents a document_path resource.
parseProjectFromAnyPathName(String) - Static method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Parses the project from the given fully-qualified path which represents a any_path resource.
parseProjectFromDatabaseRootName(String) - Static method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Parses the project from the given fully-qualified path which represents a database_root resource.
parseProjectFromDocumentPathName(String) - Static method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Parses the project from the given fully-qualified path which represents a document_path resource.
parseProjectFromDocumentRootName(String) - Static method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Parses the project from the given fully-qualified path which represents a document_root resource.
Precondition - Class in com.google.cloud.firestore: Preconditions that can be used to restrict update() calls.
projectIdRequired() - Method in class com.google.cloud.firestore.FirestoreOptions
PropertyName - Annotation Type in com.google.cloud.firestore.annotation: Marks a field to be renamed when serialized.

Q

Query - Class in com.google.cloud.firestore: A Query which you can read or listen to.
Query.Direction - Enum in com.google.cloud.firestore: The direction of a sort.
QuerySnapshot - Class in com.google.cloud.firestore: A QuerySnapshot contains the results of a query.

R

rollback(String, ByteString) - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Rolls back a transaction.
rollback(RollbackRequest) - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Rolls back a transaction.
rollbackCallable() - Method in interface com.google.cloud.firestore.spi.v1beta1.FirestoreRpc: Rolls back a transaction.
rollbackCallable() - Method in class com.google.cloud.firestore.spi.v1beta1.GrpcFirestoreRpc
rollbackCallable() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Rolls back a transaction.
rollbackCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.FirestoreStub
rollbackCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
rollbackSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings.Builder: Returns the builder for the settings used for calls to rollback.
rollbackSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: Returns the object with the settings used for calls to rollback.
runQueryCallable() - Method in interface com.google.cloud.firestore.spi.v1beta1.FirestoreRpc: Runs a query.
runQueryCallable() - Method in class com.google.cloud.firestore.spi.v1beta1.GrpcFirestoreRpc
runQueryCallable() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Runs a query.
runQueryCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.FirestoreStub
runQueryCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
runQuerySettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings.Builder: Returns the builder for the settings used for calls to runQuery.
runQuerySettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: Returns the object with the settings used for calls to runQuery.
runTransaction(Transaction.Function<T>) - Method in interface com.google.cloud.firestore.Firestore: Executes the given updateFunction and then attempts to commit the changes applied within the transaction.
runTransaction(Transaction.Function<T>, TransactionOptions) - Method in interface com.google.cloud.firestore.Firestore: Executes the given updateFunction and then attempts to commit the changes applied within the transaction.

S

select(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 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(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.
setDatabaseId(String) - Method in class com.google.cloud.firestore.FirestoreOptions.Builder
SetOptions - Class in com.google.cloud.firestore: An options object that configures the behavior of set() calls.
setTransportOptions(TransportOptions) - Method in class com.google.cloud.firestore.FirestoreOptions.Builder
shutdown() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient
shutdown() - Method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
shutdownNow() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient
shutdownNow() - Method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
size() - Method in class com.google.cloud.firestore.QuerySnapshot: Returns the number of documents in the QuerySnapshot.
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(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.

T

ThrowOnExtraProperties - Annotation Type in com.google.cloud.firestore.annotation: Properties that don't map to class fields when serializing to a class annotated with this annotation cause an exception to be thrown.
toBuilder() - Method in class com.google.cloud.firestore.FirestoreOptions
toBuilder() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: Returns a builder containing all the values of this settings class.
toBytes() - Method in class com.google.cloud.firestore.Blob: Returns a copy of the underlying bytes as a byte[] array.
toByteString() - Method in class com.google.cloud.firestore.Blob: Returns the backing data as a ByteString.
toObject(Class<T>) - Method in class com.google.cloud.firestore.DocumentSnapshot: Returns the contents of the document converted to a POJO.
toObjects(Class<T>) - Method in class com.google.cloud.firestore.QuerySnapshot: Returns the contents of the documents in the QuerySnapshot, converted to the provided class, as a list.
toString() - Method in class com.google.cloud.firestore.DocumentReference
toString() - Method in class com.google.cloud.firestore.FieldPath
toString() - Method in class com.google.cloud.firestore.GeoPoint
Transaction - Class in com.google.cloud.firestore: A Transaction is passed to a Function to provide the methods to read and write data within the transaction context.
Transaction.Function<T> - Interface in com.google.cloud.firestore: User callback that takes a Firestore Transaction
TransactionOptions - Class in com.google.cloud.firestore: Options specifying the behavior of Firestore Transactions.

U

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.
updateCallback(Transaction) - Method in interface com.google.cloud.firestore.Transaction.Function
updatedAt(Instant) - 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.v1beta1.FirestoreClient: Updates or inserts a document.
updateDocument(UpdateDocumentRequest) - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Updates or inserts a document.
updateDocumentCallable() - Method in class com.google.cloud.firestore.v1beta1.FirestoreClient: Updates or inserts a document.
updateDocumentCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.FirestoreStub
updateDocumentCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.GrpcFirestoreStub
updateDocumentSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings.Builder: Returns the builder for the settings used for calls to updateDocument.
updateDocumentSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: Returns the object with the settings used for calls to updateDocument.

V

valueOf(String) - Static method in enum com.google.cloud.firestore.Query.Direction: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.google.cloud.firestore.Query.Direction: Returns an array containing the constants of this enum type, in the order they are declared.

W

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.
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.
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.v1beta1.FirestoreClient: Streams batches of document updates and deletes, in order.
writeCallable() - Method in class com.google.cloud.firestore.v1beta1.stub.FirestoreStub
writeCallable() - Method in class com.google.cloud.firestore.v1beta1.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.v1beta1.FirestoreSettings.Builder: Returns the builder for the settings used for calls to write.
writeSettings() - Method in class com.google.cloud.firestore.v1beta1.FirestoreSettings: Returns the object with the settings used for calls to write.

A B C D E F G H I L M N O P Q R S T U V W