Package com.google.firestore.v1 (3.4.0)

Classes

AnyPathName

AUTO-GENERATED DOCUMENTATION AND CLASS

AnyPathName.Builder

Builder for AnyPathName.

ArrayValue

An array value.

Protobuf type google.firestore.v1.ArrayValue

ArrayValue.Builder

An array value.

Protobuf type google.firestore.v1.ArrayValue

BatchGetDocumentsRequest

The request for Firestore.BatchGetDocuments.

Protobuf type google.firestore.v1.BatchGetDocumentsRequest

BatchGetDocumentsRequest.Builder

The request for Firestore.BatchGetDocuments.

Protobuf type google.firestore.v1.BatchGetDocumentsRequest

BatchGetDocumentsResponse

The streamed response for Firestore.BatchGetDocuments.

Protobuf type google.firestore.v1.BatchGetDocumentsResponse

BatchGetDocumentsResponse.Builder

The streamed response for Firestore.BatchGetDocuments.

Protobuf type google.firestore.v1.BatchGetDocumentsResponse

BatchWriteRequest

The request for Firestore.BatchWrite.

Protobuf type google.firestore.v1.BatchWriteRequest

BatchWriteRequest.Builder

The request for Firestore.BatchWrite.

Protobuf type google.firestore.v1.BatchWriteRequest

BatchWriteResponse

The response from Firestore.BatchWrite.

Protobuf type google.firestore.v1.BatchWriteResponse

BatchWriteResponse.Builder

The response from Firestore.BatchWrite.

Protobuf type google.firestore.v1.BatchWriteResponse

BeginTransactionRequest

The request for Firestore.BeginTransaction.

Protobuf type google.firestore.v1.BeginTransactionRequest

BeginTransactionRequest.Builder

The request for Firestore.BeginTransaction.

Protobuf type google.firestore.v1.BeginTransactionRequest

BeginTransactionResponse

The response for Firestore.BeginTransaction.

Protobuf type google.firestore.v1.BeginTransactionResponse

BeginTransactionResponse.Builder

The response for Firestore.BeginTransaction.

Protobuf type google.firestore.v1.BeginTransactionResponse

CommitRequest

The request for Firestore.Commit.

Protobuf type google.firestore.v1.CommitRequest

CommitRequest.Builder

The request for Firestore.Commit.

Protobuf type google.firestore.v1.CommitRequest

CommitResponse

The response for Firestore.Commit.

Protobuf type google.firestore.v1.CommitResponse

CommitResponse.Builder

The response for Firestore.Commit.

Protobuf type google.firestore.v1.CommitResponse

CommonProto

CreateDocumentRequest

The request for Firestore.CreateDocument.

Protobuf type google.firestore.v1.CreateDocumentRequest

CreateDocumentRequest.Builder

The request for Firestore.CreateDocument.

Protobuf type google.firestore.v1.CreateDocumentRequest

Cursor

A position in a query result set.

Protobuf type google.firestore.v1.Cursor

Cursor.Builder

A position in a query result set.

Protobuf type google.firestore.v1.Cursor

DatabaseRootName

AUTO-GENERATED DOCUMENTATION AND CLASS

DatabaseRootName.Builder

Builder for DatabaseRootName.

DeleteDocumentRequest

The request for Firestore.DeleteDocument.

Protobuf type google.firestore.v1.DeleteDocumentRequest

DeleteDocumentRequest.Builder

The request for Firestore.DeleteDocument.

Protobuf type google.firestore.v1.DeleteDocumentRequest

Document

A Firestore document. Must not exceed 1 MiB - 4 bytes.

Protobuf type google.firestore.v1.Document

Document.Builder

A Firestore document. Must not exceed 1 MiB - 4 bytes.

Protobuf type google.firestore.v1.Document

DocumentChange

A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected.

Protobuf type google.firestore.v1.DocumentChange

DocumentChange.Builder

A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected.

Protobuf type google.firestore.v1.DocumentChange

DocumentDelete

A Document has been deleted. May be the result of multiple writes, including updates, the last of which deleted the Document. Multiple DocumentDelete messages may be returned for the same logical delete, if multiple targets are affected.

Protobuf type google.firestore.v1.DocumentDelete

DocumentDelete.Builder

A Document has been deleted. May be the result of multiple writes, including updates, the last of which deleted the Document. Multiple DocumentDelete messages may be returned for the same logical delete, if multiple targets are affected.

Protobuf type google.firestore.v1.DocumentDelete

DocumentMask

A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a Document, and takes in account the dynamic nature of Value.

Protobuf type google.firestore.v1.DocumentMask

DocumentMask.Builder

A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a Document, and takes in account the dynamic nature of Value.

Protobuf type google.firestore.v1.DocumentMask

DocumentPathName

AUTO-GENERATED DOCUMENTATION AND CLASS

DocumentPathName.Builder

Builder for DocumentPathName.

DocumentProto

DocumentRemove

A Document has been removed from the view of the targets. Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document. Multiple DocumentRemove messages may be returned for the same logical write or delete, if multiple targets are affected.

Protobuf type google.firestore.v1.DocumentRemove

DocumentRemove.Builder

A Document has been removed from the view of the targets. Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document. Multiple DocumentRemove messages may be returned for the same logical write or delete, if multiple targets are affected.

Protobuf type google.firestore.v1.DocumentRemove

DocumentRootName

AUTO-GENERATED DOCUMENTATION AND CLASS

DocumentRootName.Builder

Builder for DocumentRootName.

DocumentTransform

A transformation of a document.

Protobuf type google.firestore.v1.DocumentTransform

DocumentTransform.Builder

A transformation of a document.

Protobuf type google.firestore.v1.DocumentTransform

DocumentTransform.FieldTransform

A transformation of a field of the document.

Protobuf type google.firestore.v1.DocumentTransform.FieldTransform

DocumentTransform.FieldTransform.Builder

A transformation of a field of the document.

Protobuf type google.firestore.v1.DocumentTransform.FieldTransform

ExistenceFilter

A digest of all the documents that match a given target.

Protobuf type google.firestore.v1.ExistenceFilter

ExistenceFilter.Builder

A digest of all the documents that match a given target.

Protobuf type google.firestore.v1.ExistenceFilter

FirestoreGrpc

The Cloud Firestore service. Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL document database that simplifies storing, syncing, and querying data for your mobile, web, and IoT apps at global scale. Its client libraries provide live synchronization and offline support, while its security features and integrations with Firebase and Google Cloud Platform (GCP) accelerate building truly serverless apps.

FirestoreGrpc.FirestoreBlockingStub

The Cloud Firestore service. Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL document database that simplifies storing, syncing, and querying data for your mobile, web, and IoT apps at global scale. Its client libraries provide live synchronization and offline support, while its security features and integrations with Firebase and Google Cloud Platform (GCP) accelerate building truly serverless apps.

FirestoreGrpc.FirestoreFutureStub

The Cloud Firestore service. Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL document database that simplifies storing, syncing, and querying data for your mobile, web, and IoT apps at global scale. Its client libraries provide live synchronization and offline support, while its security features and integrations with Firebase and Google Cloud Platform (GCP) accelerate building truly serverless apps.

FirestoreGrpc.FirestoreImplBase

The Cloud Firestore service. Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL document database that simplifies storing, syncing, and querying data for your mobile, web, and IoT apps at global scale. Its client libraries provide live synchronization and offline support, while its security features and integrations with Firebase and Google Cloud Platform (GCP) accelerate building truly serverless apps.

FirestoreGrpc.FirestoreStub

The Cloud Firestore service. Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL document database that simplifies storing, syncing, and querying data for your mobile, web, and IoT apps at global scale. Its client libraries provide live synchronization and offline support, while its security features and integrations with Firebase and Google Cloud Platform (GCP) accelerate building truly serverless apps.

FirestoreProto

GetDocumentRequest

The request for Firestore.GetDocument.

Protobuf type google.firestore.v1.GetDocumentRequest

GetDocumentRequest.Builder

The request for Firestore.GetDocument.

Protobuf type google.firestore.v1.GetDocumentRequest

ListCollectionIdsRequest

The request for Firestore.ListCollectionIds.

Protobuf type google.firestore.v1.ListCollectionIdsRequest

ListCollectionIdsRequest.Builder

The request for Firestore.ListCollectionIds.

Protobuf type google.firestore.v1.ListCollectionIdsRequest

ListCollectionIdsResponse

The response from Firestore.ListCollectionIds.

Protobuf type google.firestore.v1.ListCollectionIdsResponse

ListCollectionIdsResponse.Builder

The response from Firestore.ListCollectionIds.

Protobuf type google.firestore.v1.ListCollectionIdsResponse

ListDocumentsRequest

The request for Firestore.ListDocuments.

Protobuf type google.firestore.v1.ListDocumentsRequest

ListDocumentsRequest.Builder

The request for Firestore.ListDocuments.

Protobuf type google.firestore.v1.ListDocumentsRequest

ListDocumentsResponse

The response for Firestore.ListDocuments.

Protobuf type google.firestore.v1.ListDocumentsResponse

ListDocumentsResponse.Builder

The response for Firestore.ListDocuments.

Protobuf type google.firestore.v1.ListDocumentsResponse

ListenRequest

A request for Firestore.Listen

Protobuf type google.firestore.v1.ListenRequest

ListenRequest.Builder

A request for Firestore.Listen

Protobuf type google.firestore.v1.ListenRequest

ListenResponse

The response for Firestore.Listen.

Protobuf type google.firestore.v1.ListenResponse

ListenResponse.Builder

The response for Firestore.Listen.

Protobuf type google.firestore.v1.ListenResponse

MapValue

A map value.

Protobuf type google.firestore.v1.MapValue

MapValue.Builder

A map value.

Protobuf type google.firestore.v1.MapValue

PartitionQueryRequest

The request for Firestore.PartitionQuery.

Protobuf type google.firestore.v1.PartitionQueryRequest

PartitionQueryRequest.Builder

The request for Firestore.PartitionQuery.

Protobuf type google.firestore.v1.PartitionQueryRequest

PartitionQueryResponse

The response for Firestore.PartitionQuery.

Protobuf type google.firestore.v1.PartitionQueryResponse

PartitionQueryResponse.Builder

The response for Firestore.PartitionQuery.

Protobuf type google.firestore.v1.PartitionQueryResponse

Precondition

A precondition on a document, used for conditional operations.

Protobuf type google.firestore.v1.Precondition

Precondition.Builder

A precondition on a document, used for conditional operations.

Protobuf type google.firestore.v1.Precondition

QueryProto

RollbackRequest

The request for Firestore.Rollback.

Protobuf type google.firestore.v1.RollbackRequest

RollbackRequest.Builder

The request for Firestore.Rollback.

Protobuf type google.firestore.v1.RollbackRequest

RunQueryRequest

The request for Firestore.RunQuery.

Protobuf type google.firestore.v1.RunQueryRequest

RunQueryRequest.Builder

The request for Firestore.RunQuery.

Protobuf type google.firestore.v1.RunQueryRequest

RunQueryResponse

The response for Firestore.RunQuery.

Protobuf type google.firestore.v1.RunQueryResponse

RunQueryResponse.Builder

The response for Firestore.RunQuery.

Protobuf type google.firestore.v1.RunQueryResponse

StructuredQuery

A Firestore query.

Protobuf type google.firestore.v1.StructuredQuery

StructuredQuery.Builder

A Firestore query.

Protobuf type google.firestore.v1.StructuredQuery

StructuredQuery.CollectionSelector

A selection of a collection, such as messages as m1.

Protobuf type google.firestore.v1.StructuredQuery.CollectionSelector

StructuredQuery.CollectionSelector.Builder

A selection of a collection, such as messages as m1.

Protobuf type google.firestore.v1.StructuredQuery.CollectionSelector

StructuredQuery.CompositeFilter

A filter that merges multiple other filters using the given operator.

Protobuf type google.firestore.v1.StructuredQuery.CompositeFilter

StructuredQuery.CompositeFilter.Builder

A filter that merges multiple other filters using the given operator.

Protobuf type google.firestore.v1.StructuredQuery.CompositeFilter

StructuredQuery.FieldFilter

A filter on a specific field.

Protobuf type google.firestore.v1.StructuredQuery.FieldFilter

StructuredQuery.FieldFilter.Builder

A filter on a specific field.

Protobuf type google.firestore.v1.StructuredQuery.FieldFilter

StructuredQuery.FieldReference

A reference to a field, such as max(messages.time) as max_time.

Protobuf type google.firestore.v1.StructuredQuery.FieldReference

StructuredQuery.FieldReference.Builder

A reference to a field, such as max(messages.time) as max_time.

Protobuf type google.firestore.v1.StructuredQuery.FieldReference

StructuredQuery.Filter

A filter.

Protobuf type google.firestore.v1.StructuredQuery.Filter

StructuredQuery.Filter.Builder

A filter.

Protobuf type google.firestore.v1.StructuredQuery.Filter

StructuredQuery.Order

An order on a field.

Protobuf type google.firestore.v1.StructuredQuery.Order

StructuredQuery.Order.Builder

An order on a field.

Protobuf type google.firestore.v1.StructuredQuery.Order

StructuredQuery.Projection

The projection of document's fields to return.

Protobuf type google.firestore.v1.StructuredQuery.Projection

StructuredQuery.Projection.Builder

The projection of document's fields to return.

Protobuf type google.firestore.v1.StructuredQuery.Projection

StructuredQuery.UnaryFilter

A filter with a single operand.

Protobuf type google.firestore.v1.StructuredQuery.UnaryFilter

StructuredQuery.UnaryFilter.Builder

A filter with a single operand.

Protobuf type google.firestore.v1.StructuredQuery.UnaryFilter

Target

A specification of a set of documents to listen to.

Protobuf type google.firestore.v1.Target

Target.Builder

A specification of a set of documents to listen to.

Protobuf type google.firestore.v1.Target

Target.DocumentsTarget

A target specified by a set of documents names.

Protobuf type google.firestore.v1.Target.DocumentsTarget

Target.DocumentsTarget.Builder

A target specified by a set of documents names.

Protobuf type google.firestore.v1.Target.DocumentsTarget

Target.QueryTarget

A target specified by a query.

Protobuf type google.firestore.v1.Target.QueryTarget

Target.QueryTarget.Builder

A target specified by a query.

Protobuf type google.firestore.v1.Target.QueryTarget

TargetChange

Targets being watched have changed.

Protobuf type google.firestore.v1.TargetChange

TargetChange.Builder

Targets being watched have changed.

Protobuf type google.firestore.v1.TargetChange

TransactionOptions

Options for creating a new transaction.

Protobuf type google.firestore.v1.TransactionOptions

TransactionOptions.Builder

Options for creating a new transaction.

Protobuf type google.firestore.v1.TransactionOptions

TransactionOptions.ReadOnly

Options for a transaction that can only be used to read documents.

Protobuf type google.firestore.v1.TransactionOptions.ReadOnly

TransactionOptions.ReadOnly.Builder

Options for a transaction that can only be used to read documents.

Protobuf type google.firestore.v1.TransactionOptions.ReadOnly

TransactionOptions.ReadWrite

Options for a transaction that can be used to read and write documents.

Protobuf type google.firestore.v1.TransactionOptions.ReadWrite

TransactionOptions.ReadWrite.Builder

Options for a transaction that can be used to read and write documents.

Protobuf type google.firestore.v1.TransactionOptions.ReadWrite

UpdateDocumentRequest

The request for Firestore.UpdateDocument.

Protobuf type google.firestore.v1.UpdateDocumentRequest

UpdateDocumentRequest.Builder

The request for Firestore.UpdateDocument.

Protobuf type google.firestore.v1.UpdateDocumentRequest

Value

A message that can hold any of the supported value types.

Protobuf type google.firestore.v1.Value

Value.Builder

A message that can hold any of the supported value types.

Protobuf type google.firestore.v1.Value

Write

A write on a document.

Protobuf type google.firestore.v1.Write

Write.Builder

A write on a document.

Protobuf type google.firestore.v1.Write

WriteProto

WriteRequest

The request for Firestore.Write. The first request creates a stream, or resumes an existing one from a token. When creating a new stream, the server replies with a response containing only an ID and a token, to use in the next request. When resuming a stream, the server first streams any responses later than the given token, then a response containing only an up-to-date token, to use in the next request.

Protobuf type google.firestore.v1.WriteRequest

WriteRequest.Builder

The request for Firestore.Write. The first request creates a stream, or resumes an existing one from a token. When creating a new stream, the server replies with a response containing only an ID and a token, to use in the next request. When resuming a stream, the server first streams any responses later than the given token, then a response containing only an up-to-date token, to use in the next request.

Protobuf type google.firestore.v1.WriteRequest

WriteResponse

The response for Firestore.Write.

Protobuf type google.firestore.v1.WriteResponse

WriteResponse.Builder

The response for Firestore.Write.

Protobuf type google.firestore.v1.WriteResponse

WriteResult

The result of applying a write.

Protobuf type google.firestore.v1.WriteResult

WriteResult.Builder

The result of applying a write.

Protobuf type google.firestore.v1.WriteResult

Interfaces

ArrayValueOrBuilder

BatchGetDocumentsRequestOrBuilder

BatchGetDocumentsResponseOrBuilder

BatchWriteRequestOrBuilder

BatchWriteResponseOrBuilder

BeginTransactionRequestOrBuilder

BeginTransactionResponseOrBuilder

CommitRequestOrBuilder

CommitResponseOrBuilder

CreateDocumentRequestOrBuilder

CursorOrBuilder

DeleteDocumentRequestOrBuilder

DocumentChangeOrBuilder

DocumentDeleteOrBuilder

DocumentMaskOrBuilder

DocumentOrBuilder

DocumentRemoveOrBuilder

DocumentTransform.FieldTransformOrBuilder

DocumentTransformOrBuilder

ExistenceFilterOrBuilder

GetDocumentRequestOrBuilder

ListCollectionIdsRequestOrBuilder

ListCollectionIdsResponseOrBuilder

ListDocumentsRequestOrBuilder

ListDocumentsResponseOrBuilder

ListenRequestOrBuilder

ListenResponseOrBuilder

MapValueOrBuilder

PartitionQueryRequestOrBuilder

PartitionQueryResponseOrBuilder

PreconditionOrBuilder

RollbackRequestOrBuilder

RunQueryRequestOrBuilder

RunQueryResponseOrBuilder

StructuredQuery.CollectionSelectorOrBuilder

StructuredQuery.CompositeFilterOrBuilder

StructuredQuery.FieldFilterOrBuilder

StructuredQuery.FieldReferenceOrBuilder

StructuredQuery.FilterOrBuilder

StructuredQuery.OrderOrBuilder

StructuredQuery.ProjectionOrBuilder

StructuredQuery.UnaryFilterOrBuilder

StructuredQueryOrBuilder

Target.DocumentsTargetOrBuilder

Target.QueryTargetOrBuilder

TargetChangeOrBuilder

TargetOrBuilder

TransactionOptions.ReadOnlyOrBuilder

TransactionOptions.ReadWriteOrBuilder

TransactionOptionsOrBuilder

UpdateDocumentRequestOrBuilder

ValueOrBuilder

WriteOrBuilder

WriteRequestOrBuilder

WriteResponseOrBuilder

WriteResultOrBuilder

Enums

BatchGetDocumentsRequest.ConsistencySelectorCase

BatchGetDocumentsResponse.ResultCase

DocumentTransform.FieldTransform.ServerValue

A value that is calculated by the server.

Protobuf enum google.firestore.v1.DocumentTransform.FieldTransform.ServerValue

DocumentTransform.FieldTransform.TransformTypeCase

GetDocumentRequest.ConsistencySelectorCase

ListCollectionIdsRequest.ConsistencySelectorCase

ListDocumentsRequest.ConsistencySelectorCase

ListenRequest.TargetChangeCase

ListenResponse.ResponseTypeCase

PartitionQueryRequest.ConsistencySelectorCase

PartitionQueryRequest.QueryTypeCase

Precondition.ConditionTypeCase

RunQueryRequest.ConsistencySelectorCase

RunQueryRequest.QueryTypeCase

RunQueryResponse.ContinuationSelectorCase

StructuredQuery.CompositeFilter.Operator

A composite filter operator.

Protobuf enum google.firestore.v1.StructuredQuery.CompositeFilter.Operator

StructuredQuery.Direction

A sort direction.

Protobuf enum google.firestore.v1.StructuredQuery.Direction

StructuredQuery.FieldFilter.Operator

A field filter operator.

Protobuf enum google.firestore.v1.StructuredQuery.FieldFilter.Operator

StructuredQuery.Filter.FilterTypeCase

StructuredQuery.UnaryFilter.OperandTypeCase

StructuredQuery.UnaryFilter.Operator

A unary operator.

Protobuf enum google.firestore.v1.StructuredQuery.UnaryFilter.Operator

Target.QueryTarget.QueryTypeCase

Target.ResumeTypeCase

Target.TargetTypeCase

TargetChange.TargetChangeType

The type of change.

Protobuf enum google.firestore.v1.TargetChange.TargetChangeType

TransactionOptions.ModeCase

TransactionOptions.ReadOnly.ConsistencySelectorCase

Value.ValueTypeCase

Write.OperationCase