Namespace Google.Apis.Firestore.v1.Data
Classes
Aggregation
Defines a aggregation that produces a single result.
AggregationResult
The result of a single bucket from a Firestore aggregation query. The keys of aggregate_fields
are the same
for all results in an aggregation query, unlike document queries which can have different fields present for
each result.
ArrayValue
An array value.
BatchGetDocumentsRequest
The request for Firestore.BatchGetDocuments.
BatchGetDocumentsResponse
The streamed response for Firestore.BatchGetDocuments.
BatchWriteRequest
The request for Firestore.BatchWrite.
BatchWriteResponse
The response from Firestore.BatchWrite.
BeginTransactionRequest
The request for Firestore.BeginTransaction.
BeginTransactionResponse
The response for Firestore.BeginTransaction.
CollectionSelector
A selection of a collection, such as messages as m1
.
CommitRequest
The request for Firestore.Commit.
CommitResponse
The response for Firestore.Commit.
CompositeFilter
A filter that merges multiple other filters using the given operator.
Count
Count of documents that match the query. The COUNT(*)
aggregation function operates on the entire document so
it does not require a field reference.
Cursor
A position in a query result set.
Document
A Firestore document. Must not exceed 1 MiB - 4 bytes.
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.
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.
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.
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.
DocumentsTarget
A target specified by a set of documents names.
DocumentTransform
A transformation of a document.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
ExistenceFilter
A digest of all the documents that match a given target.
FieldFilter
A filter on a specific field.
FieldReference
A reference to a field in a document, ex: stats.operations
.
FieldTransform
A transformation of a field of the document.
Filter
A filter.
GoogleFirestoreAdminV1Database
A Cloud Firestore Database. Currently only one database is allowed per cloud project; this database must have a
database_id
of '(default)'.
GoogleFirestoreAdminV1ExportDocumentsMetadata
Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments.
GoogleFirestoreAdminV1ExportDocumentsRequest
The request for FirestoreAdmin.ExportDocuments.
GoogleFirestoreAdminV1ExportDocumentsResponse
Returned in the google.longrunning.Operation response field.
GoogleFirestoreAdminV1Field
Represents a single field in the database. Fields are grouped by their "Collection Group", which represent all collections in the database with the same id.
GoogleFirestoreAdminV1FieldOperationMetadata
Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField.
GoogleFirestoreAdminV1ImportDocumentsMetadata
Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments.
GoogleFirestoreAdminV1ImportDocumentsRequest
The request for FirestoreAdmin.ImportDocuments.
GoogleFirestoreAdminV1Index
Cloud Firestore indexes enable simple and complex queries against documents in a database.
GoogleFirestoreAdminV1IndexConfig
The index configuration for this field.
GoogleFirestoreAdminV1IndexConfigDelta
Information about an index configuration change.
GoogleFirestoreAdminV1IndexField
A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
GoogleFirestoreAdminV1IndexOperationMetadata
Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex.
GoogleFirestoreAdminV1ListDatabasesResponse
The list of databases for a project.
GoogleFirestoreAdminV1ListFieldsResponse
The response for FirestoreAdmin.ListFields.
GoogleFirestoreAdminV1ListIndexesResponse
The response for FirestoreAdmin.ListIndexes.
GoogleFirestoreAdminV1LocationMetadata
The metadata message for google.cloud.location.Location.metadata.
GoogleFirestoreAdminV1Progress
Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress is used.
GoogleFirestoreAdminV1TtlConfig
The TTL (time-to-live) configuration for documents that have this Field
set. Storing a timestamp value into a
TTL-enabled field will be treated as the document's absolute expiration time. Timestamp values in the past
indicate that the document is eligible for immediate expiration. Using any other data type or leaving the field
absent will disable expiration for the individual document.
GoogleFirestoreAdminV1TtlConfigDelta
Information about an TTL configuration change.
GoogleFirestoreAdminV1UpdateDatabaseMetadata
Metadata related to the update database operation.
GoogleLongrunningCancelOperationRequest
The request message for Operations.CancelOperation.
GoogleLongrunningListOperationsResponse
The response message for Operations.ListOperations.
GoogleLongrunningOperation
This resource represents a long-running operation that is the result of a network API call.
LatLng
An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.
ListCollectionIdsRequest
The request for Firestore.ListCollectionIds.
ListCollectionIdsResponse
The response from Firestore.ListCollectionIds.
ListDocumentsResponse
The response for Firestore.ListDocuments.
ListenRequest
A request for Firestore.Listen
ListenResponse
The response for Firestore.Listen.
ListLocationsResponse
The response message for Locations.ListLocations.
Location
A resource that represents Google Cloud Platform location.
MapValue
A map value.
Order
An order on a field.
PartitionQueryRequest
The request for Firestore.PartitionQuery.
PartitionQueryResponse
The response for Firestore.PartitionQuery.
Precondition
A precondition on a document, used for conditional operations.
Projection
The projection of document's fields to return.
QueryTarget
A target specified by a query.
ReadOnly
Options for a transaction that can only be used to read documents.
ReadWrite
Options for a transaction that can be used to read and write documents.
RollbackRequest
The request for Firestore.Rollback.
RunAggregationQueryRequest
The request for Firestore.RunAggregationQuery.
RunAggregationQueryResponse
The response for Firestore.RunAggregationQuery.
RunQueryRequest
The request for Firestore.RunQuery.
RunQueryResponse
The response for Firestore.RunQuery.
Status
The Status
type defines a logical error model that is suitable for different programming environments,
including REST APIs and RPC APIs. It is used by gRPC. Each Status
message contains
three pieces of data: error code, error message, and error details. You can find out more about this error model
and how to work with it in the API Design Guide.
StructuredAggregationQuery
Firestore query for running an aggregation over a StructuredQuery.
StructuredQuery
A Firestore query.
Target
A specification of a set of documents to listen to.
TargetChange
Targets being watched have changed.
TransactionOptions
Options for creating a new transaction.
UnaryFilter
A filter with a single operand.
Value
A message that can hold any of the supported value types.
Write
A write on a document.
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.
WriteResponse
The response for Firestore.Write.
WriteResult
The result of applying a write.