Namespace Google.Cloud.Firestore.V1

Classes

ArrayValue

An array value.

BatchGetDocumentsRequest

The request for [Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].

BatchGetDocumentsResponse

The streamed response for [Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].

BatchWriteRequest

The request for [Firestore.BatchWrite][google.firestore.v1.Firestore.BatchWrite].

BatchWriteResponse

The response from [Firestore.BatchWrite][google.firestore.v1.Firestore.BatchWrite].

BeginTransactionRequest

The request for [Firestore.BeginTransaction][google.firestore.v1.Firestore.BeginTransaction].

BeginTransactionResponse

The response for [Firestore.BeginTransaction][google.firestore.v1.Firestore.BeginTransaction].

CommitRequest

The request for [Firestore.Commit][google.firestore.v1.Firestore.Commit].

CommitResponse

The response for [Firestore.Commit][google.firestore.v1.Firestore.Commit].

CreateDocumentRequest

The request for [Firestore.CreateDocument][google.firestore.v1.Firestore.CreateDocument].

Cursor

A position in a query result set.

DeleteDocumentRequest

The request for [Firestore.DeleteDocument][google.firestore.v1.Firestore.DeleteDocument].

Document

A Firestore document.

Must not exceed 1 MiB - 4 bytes.

DocumentChange

A [Document][google.firestore.v1.Document] has changed.

May be the result of multiple [writes][google.firestore.v1.Write], including deletes, that ultimately resulted in a new value for the [Document][google.firestore.v1.Document].

Multiple [DocumentChange][google.firestore.v1.DocumentChange] messages may be returned for the same logical change, if multiple targets are affected.

DocumentDelete

A [Document][google.firestore.v1.Document] has been deleted.

May be the result of multiple [writes][google.firestore.v1.Write], including updates, the last of which deleted the [Document][google.firestore.v1.Document].

Multiple [DocumentDelete][google.firestore.v1.DocumentDelete] messages may be returned for the same logical delete, if multiple targets are affected.

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][google.firestore.v1.Document], and takes in account the dynamic nature of [Value][google.firestore.v1.Value].

DocumentRemove

A [Document][google.firestore.v1.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][google.firestore.v1.DocumentRemove] messages may be returned for the same logical write or delete, if multiple targets are affected.

DocumentTransform

A transformation of a document.

DocumentTransform.Types

Container for nested types declared in the DocumentTransform message type.

DocumentTransform.Types.FieldTransform

A transformation of a field of the document.

DocumentTransform.Types.FieldTransform.Types

Container for nested types declared in the FieldTransform message type.

ExistenceFilter

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

Firestore

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.

Firestore.FirestoreBase

Base class for server-side implementations of Firestore

Firestore.FirestoreClient

Client for Firestore

FirestoreClient

Firestore client wrapper, for convenient use.

FirestoreClient.BatchGetDocumentsStream

Server streaming methods for BatchGetDocuments(BatchGetDocumentsRequest, CallSettings) .

FirestoreClient.ListenStream

Bidirectional streaming methods for Listen(CallSettings, BidirectionalStreamingSettings).

FirestoreClient.RunQueryStream

Server streaming methods for RunQuery(RunQueryRequest, CallSettings).

FirestoreClient.WriteStream

Bidirectional streaming methods for Write(CallSettings, BidirectionalStreamingSettings).

FirestoreClientBuilder

Builder class for FirestoreClient to provide simple configuration of credentials, endpoint etc.

FirestoreClientImpl

Firestore client wrapper implementation, for convenient use.

FirestoreSettings

Settings for FirestoreClient instances.

GetDocumentRequest

The request for [Firestore.GetDocument][google.firestore.v1.Firestore.GetDocument].

ListCollectionIdsRequest

The request for [Firestore.ListCollectionIds][google.firestore.v1.Firestore.ListCollectionIds].

ListCollectionIdsResponse

The response from [Firestore.ListCollectionIds][google.firestore.v1.Firestore.ListCollectionIds].

ListDocumentsRequest

The request for [Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments].

ListDocumentsResponse

The response for [Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments].

ListenRequest

A request for [Firestore.Listen][google.firestore.v1.Firestore.Listen]

ListenResponse

The response for [Firestore.Listen][google.firestore.v1.Firestore.Listen].

MapValue

A map value.

PartitionQueryRequest

The request for [Firestore.PartitionQuery][google.firestore.v1.Firestore.PartitionQuery].

PartitionQueryResponse

The response for [Firestore.PartitionQuery][google.firestore.v1.Firestore.PartitionQuery].

Precondition

A precondition on a document, used for conditional operations.

RollbackRequest

The request for [Firestore.Rollback][google.firestore.v1.Firestore.Rollback].

RunQueryRequest

The request for [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].

RunQueryResponse

The response for [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].

StructuredQuery

A Firestore query.

StructuredQuery.Types

Container for nested types declared in the StructuredQuery message type.

StructuredQuery.Types.CollectionSelector

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

StructuredQuery.Types.CompositeFilter

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

StructuredQuery.Types.CompositeFilter.Types

Container for nested types declared in the CompositeFilter message type.

StructuredQuery.Types.FieldFilter

A filter on a specific field.

StructuredQuery.Types.FieldFilter.Types

Container for nested types declared in the FieldFilter message type.

StructuredQuery.Types.FieldReference

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

StructuredQuery.Types.Filter

A filter.

StructuredQuery.Types.Order

An order on a field.

StructuredQuery.Types.Projection

The projection of document's fields to return.

StructuredQuery.Types.UnaryFilter

A filter with a single operand.

StructuredQuery.Types.UnaryFilter.Types

Container for nested types declared in the UnaryFilter message type.

Target

A specification of a set of documents to listen to.

Target.Types

Container for nested types declared in the Target message type.

Target.Types.DocumentsTarget

A target specified by a set of documents names.

Target.Types.QueryTarget

A target specified by a query.

TargetChange

Targets being watched have changed.

TargetChange.Types

Container for nested types declared in the TargetChange message type.

TransactionOptions

Options for creating a new transaction.

TransactionOptions.Types

Container for nested types declared in the TransactionOptions message type.

TransactionOptions.Types.ReadOnly

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

TransactionOptions.Types.ReadWrite

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

UpdateDocumentRequest

The request for [Firestore.UpdateDocument][google.firestore.v1.Firestore.UpdateDocument].

Value

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

Write

A write on a document.

WriteRequest

The request for [Firestore.Write][google.firestore.v1.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.

WriteResponse

The response for [Firestore.Write][google.firestore.v1.Firestore.Write].

WriteResult

The result of applying a write.

Enums

BatchGetDocumentsRequest.ConsistencySelectorOneofCase

Enum of possible cases for the "consistency_selector" oneof.

BatchGetDocumentsResponse.ResultOneofCase

Enum of possible cases for the "result" oneof.

DocumentTransform.Types.FieldTransform.TransformTypeOneofCase

Enum of possible cases for the "transform_type" oneof.

DocumentTransform.Types.FieldTransform.Types.ServerValue

A value that is calculated by the server.

GetDocumentRequest.ConsistencySelectorOneofCase

Enum of possible cases for the "consistency_selector" oneof.

ListDocumentsRequest.ConsistencySelectorOneofCase

Enum of possible cases for the "consistency_selector" oneof.

ListenRequest.TargetChangeOneofCase

Enum of possible cases for the "target_change" oneof.

ListenResponse.ResponseTypeOneofCase

Enum of possible cases for the "response_type" oneof.

PartitionQueryRequest.QueryTypeOneofCase

Enum of possible cases for the "query_type" oneof.

Precondition.ConditionTypeOneofCase

Enum of possible cases for the "condition_type" oneof.

RunQueryRequest.ConsistencySelectorOneofCase

Enum of possible cases for the "consistency_selector" oneof.

RunQueryRequest.QueryTypeOneofCase

Enum of possible cases for the "query_type" oneof.

StructuredQuery.Types.CompositeFilter.Types.Operator

A composite filter operator.

StructuredQuery.Types.Direction

A sort direction.

StructuredQuery.Types.FieldFilter.Types.Operator

A field filter operator.

StructuredQuery.Types.Filter.FilterTypeOneofCase

Enum of possible cases for the "filter_type" oneof.

StructuredQuery.Types.UnaryFilter.OperandTypeOneofCase

Enum of possible cases for the "operand_type" oneof.

StructuredQuery.Types.UnaryFilter.Types.Operator

A unary operator.

Target.ResumeTypeOneofCase

Enum of possible cases for the "resume_type" oneof.

Target.TargetTypeOneofCase

Enum of possible cases for the "target_type" oneof.

Target.Types.QueryTarget.QueryTypeOneofCase

Enum of possible cases for the "query_type" oneof.

TargetChange.Types.TargetChangeType

The type of change.

TransactionOptions.ModeOneofCase

Enum of possible cases for the "mode" oneof.

TransactionOptions.Types.ReadOnly.ConsistencySelectorOneofCase

Enum of possible cases for the "consistency_selector" oneof.

Value.ValueTypeOneofCase

Enum of possible cases for the "value_type" oneof.

Write.OperationOneofCase

Enum of possible cases for the "operation" oneof.