googleapis
Version:
Google APIs Client Library for Node.js
1,143 lines • 142 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace firestore_v1beta1 {
export interface Options extends GlobalOptions {
version: 'v1beta1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Firestore API
*
* Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.
*
* @example
* ```js
* const {google} = require('googleapis');
* const firestore = google.firestore('v1beta1');
* ```
*/
export class Firestore {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* An array value.
*/
export interface Schema$ArrayValue {
/**
* Values in the array.
*/
values?: Schema$Value[];
}
/**
* The request for Firestore.BatchGetDocuments.
*/
export interface Schema$BatchGetDocumentsRequest {
/**
* The names of the documents to retrieve. In the format: `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`. The request will fail if any of the document is not a child resource of the given `database`. Duplicate names will be elided.
*/
documents?: string[] | null;
/**
* The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.
*/
mask?: Schema$DocumentMask;
/**
* Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
*/
newTransaction?: Schema$TransactionOptions;
/**
* Reads documents as they were at the given time. This may not be older than 270 seconds.
*/
readTime?: string | null;
/**
* Reads documents in a transaction.
*/
transaction?: string | null;
}
/**
* The streamed response for Firestore.BatchGetDocuments.
*/
export interface Schema$BatchGetDocumentsResponse {
/**
* A document that was requested.
*/
found?: Schema$Document;
/**
* A document name that was requested but does not exist. In the format: `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`.
*/
missing?: string | null;
/**
* The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.
*/
readTime?: string | null;
/**
* The transaction that was started as part of this request. Will only be set in the first response, and only if BatchGetDocumentsRequest.new_transaction was set in the request.
*/
transaction?: string | null;
}
/**
* The request for Firestore.BatchWrite.
*/
export interface Schema$BatchWriteRequest {
/**
* Labels associated with this batch write.
*/
labels?: {
[key: string]: string;
} | null;
/**
* The writes to apply. Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.
*/
writes?: Schema$Write[];
}
/**
* The response from Firestore.BatchWrite.
*/
export interface Schema$BatchWriteResponse {
/**
* The status of applying the writes. This i-th write status corresponds to the i-th write in the request.
*/
status?: Schema$Status[];
/**
* The result of applying the writes. This i-th write result corresponds to the i-th write in the request.
*/
writeResults?: Schema$WriteResult[];
}
/**
* The request for Firestore.BeginTransaction.
*/
export interface Schema$BeginTransactionRequest {
/**
* The options for the transaction. Defaults to a read-write transaction.
*/
options?: Schema$TransactionOptions;
}
/**
* The response for Firestore.BeginTransaction.
*/
export interface Schema$BeginTransactionResponse {
/**
* The transaction that was started.
*/
transaction?: string | null;
}
/**
* A selection of a collection, such as `messages as m1`.
*/
export interface Schema$CollectionSelector {
/**
* When false, selects only collections that are immediate children of the `parent` specified in the containing `RunQueryRequest`. When true, selects all descendant collections.
*/
allDescendants?: boolean | null;
/**
* The collection ID. When set, selects only collections with this ID.
*/
collectionId?: string | null;
}
/**
* The request for Firestore.Commit.
*/
export interface Schema$CommitRequest {
/**
* If set, applies all writes in this transaction, and commits it.
*/
transaction?: string | null;
/**
* The writes to apply. Always executed atomically and in order.
*/
writes?: Schema$Write[];
}
/**
* The response for Firestore.Commit.
*/
export interface Schema$CommitResponse {
/**
* The time at which the commit occurred. Any read with an equal or greater `read_time` is guaranteed to see the effects of the commit.
*/
commitTime?: string | null;
/**
* The result of applying the writes. This i-th write result corresponds to the i-th write in the request.
*/
writeResults?: Schema$WriteResult[];
}
/**
* A filter that merges multiple other filters using the given operator.
*/
export interface Schema$CompositeFilter {
/**
* The list of filters to combine. Must contain at least one filter.
*/
filters?: Schema$Filter[];
/**
* The operator for combining multiple filters.
*/
op?: string | null;
}
/**
* A position in a query result set.
*/
export interface Schema$Cursor {
/**
* If the position is just before or just after the given values, relative to the sort order defined by the query.
*/
before?: boolean | null;
/**
* The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause.
*/
values?: Schema$Value[];
}
/**
* A Firestore document. Must not exceed 1 MiB - 4 bytes.
*/
export interface Schema$Document {
/**
* Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query.
*/
createTime?: string | null;
/**
* The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" \}\}\}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``.
*/
fields?: {
[key: string]: Schema$Value;
} | null;
/**
* The resource name of the document, for example `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`.
*/
name?: string | null;
/**
* Output only. The time at which the document was last changed. This value is initially set to the `create_time` then increases monotonically with each change to the document. It can also be compared to values from other documents and the `read_time` of a query.
*/
updateTime?: string | null;
}
/**
* 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.
*/
export interface Schema$DocumentChange {
/**
* The new state of the Document. If `mask` is set, contains only fields that were updated or added.
*/
document?: Schema$Document;
/**
* A set of target IDs for targets that no longer match this document.
*/
removedTargetIds?: number[] | null;
/**
* A set of target IDs of targets that match this document.
*/
targetIds?: number[] | null;
}
/**
* 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.
*/
export interface Schema$DocumentDelete {
/**
* The resource name of the Document that was deleted.
*/
document?: string | null;
/**
* The read timestamp at which the delete was observed. Greater or equal to the `commit_time` of the delete.
*/
readTime?: string | null;
/**
* A set of target IDs for targets that previously matched this entity.
*/
removedTargetIds?: number[] | null;
}
/**
* 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.
*/
export interface Schema$DocumentMask {
/**
* The list of field paths in the mask. See Document.fields for a field path syntax reference.
*/
fieldPaths?: string[] | null;
}
/**
* 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.
*/
export interface Schema$DocumentRemove {
/**
* The resource name of the Document that has gone out of view.
*/
document?: string | null;
/**
* The read timestamp at which the remove was observed. Greater or equal to the `commit_time` of the change/delete/remove.
*/
readTime?: string | null;
/**
* A set of target IDs for targets that previously matched this document.
*/
removedTargetIds?: number[] | null;
}
/**
* A target specified by a set of documents names.
*/
export interface Schema$DocumentsTarget {
/**
* The names of the documents to retrieve. In the format: `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`. The request will fail if any of the document is not a child resource of the given `database`. Duplicate names will be elided.
*/
documents?: string[] | null;
}
/**
* A transformation of a document.
*/
export interface Schema$DocumentTransform {
/**
* The name of the document to transform.
*/
document?: string | null;
/**
* The list of transformations to apply to the fields of the document, in order. This must not be empty.
*/
fieldTransforms?: Schema$FieldTransform[];
}
/**
* 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); \} The JSON representation for `Empty` is empty JSON object `{\}`.
*/
export interface Schema$Empty {
}
/**
* A digest of all the documents that match a given target.
*/
export interface Schema$ExistenceFilter {
/**
* The total count of documents that match target_id. If different from the count of documents in the client that match, the client must manually determine which documents no longer match the target.
*/
count?: number | null;
/**
* The target ID to which this filter applies.
*/
targetId?: number | null;
}
/**
* A filter on a specific field.
*/
export interface Schema$FieldFilter {
/**
* The field to filter by.
*/
field?: Schema$FieldReference;
/**
* The operator to filter by.
*/
op?: string | null;
/**
* The value to compare to.
*/
value?: Schema$Value;
}
/**
* A reference to a field, such as `max(messages.time) as max_time`.
*/
export interface Schema$FieldReference {
fieldPath?: string | null;
}
/**
* A transformation of a field of the document.
*/
export interface Schema$FieldTransform {
/**
* Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value.
*/
appendMissingElements?: Schema$ArrayValue;
/**
* The path of the field. See Document.fields for the field path syntax reference.
*/
fieldPath?: string | null;
/**
* Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer.
*/
increment?: Schema$Value;
/**
* Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.
*/
maximum?: Schema$Value;
/**
* Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.
*/
minimum?: Schema$Value;
/**
* Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value.
*/
removeAllFromArray?: Schema$ArrayValue;
/**
* Sets the field to the given server value.
*/
setToServerValue?: string | null;
}
/**
* A filter.
*/
export interface Schema$Filter {
/**
* A composite filter.
*/
compositeFilter?: Schema$CompositeFilter;
/**
* A filter on a document field.
*/
fieldFilter?: Schema$FieldFilter;
/**
* A filter that takes exactly one argument.
*/
unaryFilter?: Schema$UnaryFilter;
}
/**
* Metadata for ExportDocuments operations.
*/
export interface Schema$GoogleFirestoreAdminV1beta1ExportDocumentsMetadata {
/**
* Which collection ids are being exported.
*/
collectionIds?: string[] | null;
/**
* The time the operation ended, either successfully or otherwise. Unset if the operation is still active.
*/
endTime?: string | null;
/**
* The state of the export operation.
*/
operationState?: string | null;
/**
* Where the entities are being exported to.
*/
outputUriPrefix?: string | null;
/**
* An estimate of the number of bytes processed.
*/
progressBytes?: Schema$GoogleFirestoreAdminV1beta1Progress;
/**
* An estimate of the number of documents processed.
*/
progressDocuments?: Schema$GoogleFirestoreAdminV1beta1Progress;
/**
* The time that work began on the operation.
*/
startTime?: string | null;
}
/**
* The request for FirestoreAdmin.ExportDocuments.
*/
export interface Schema$GoogleFirestoreAdminV1beta1ExportDocumentsRequest {
/**
* Which collection ids to export. Unspecified means all collections.
*/
collectionIds?: string[] | null;
/**
* The output URI. Currently only supports Google Cloud Storage URIs of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time.
*/
outputUriPrefix?: string | null;
}
/**
* Returned in the google.longrunning.Operation response field.
*/
export interface Schema$GoogleFirestoreAdminV1beta1ExportDocumentsResponse {
/**
* Location of the output files. This can be used to begin an import into Cloud Firestore (this project or another project) after the operation completes successfully.
*/
outputUriPrefix?: string | null;
}
/**
* Metadata for ImportDocuments operations.
*/
export interface Schema$GoogleFirestoreAdminV1beta1ImportDocumentsMetadata {
/**
* Which collection ids are being imported.
*/
collectionIds?: string[] | null;
/**
* The time the operation ended, either successfully or otherwise. Unset if the operation is still active.
*/
endTime?: string | null;
/**
* The location of the documents being imported.
*/
inputUriPrefix?: string | null;
/**
* The state of the import operation.
*/
operationState?: string | null;
/**
* An estimate of the number of bytes processed.
*/
progressBytes?: Schema$GoogleFirestoreAdminV1beta1Progress;
/**
* An estimate of the number of documents processed.
*/
progressDocuments?: Schema$GoogleFirestoreAdminV1beta1Progress;
/**
* The time that work began on the operation.
*/
startTime?: string | null;
}
/**
* The request for FirestoreAdmin.ImportDocuments.
*/
export interface Schema$GoogleFirestoreAdminV1beta1ImportDocumentsRequest {
/**
* Which collection ids to import. Unspecified means all collections included in the import.
*/
collectionIds?: string[] | null;
/**
* Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix.
*/
inputUriPrefix?: string | null;
}
/**
* An index definition.
*/
export interface Schema$GoogleFirestoreAdminV1beta1Index {
/**
* The collection ID to which this index applies. Required.
*/
collectionId?: string | null;
/**
* The fields to index.
*/
fields?: Schema$GoogleFirestoreAdminV1beta1IndexField[];
/**
* The resource name of the index. Output only.
*/
name?: string | null;
/**
* The state of the index. Output only.
*/
state?: string | null;
}
/**
* A field of an index.
*/
export interface Schema$GoogleFirestoreAdminV1beta1IndexField {
/**
* The path of the field. Must match the field path specification described by google.firestore.v1beta1.Document.fields. Special field path `__name__` may be used by itself or at the end of a path. `__type__` may be used only at the end of path.
*/
fieldPath?: string | null;
/**
* The field's mode.
*/
mode?: string | null;
}
/**
* Metadata for index operations. This metadata populates the metadata field of google.longrunning.Operation.
*/
export interface Schema$GoogleFirestoreAdminV1beta1IndexOperationMetadata {
/**
* True if the [google.longrunning.Operation] was cancelled. If the cancellation is in progress, cancelled will be true but google.longrunning.Operation.done will be false.
*/
cancelled?: boolean | null;
/**
* Progress of the existing operation, measured in number of documents.
*/
documentProgress?: Schema$GoogleFirestoreAdminV1beta1Progress;
/**
* The time the operation ended, either successfully or otherwise. Unset if the operation is still active.
*/
endTime?: string | null;
/**
* The index resource that this operation is acting on. For example: `projects/{project_id\}/databases/{database_id\}/indexes/{index_id\}`
*/
index?: string | null;
/**
* The type of index operation.
*/
operationType?: string | null;
/**
* The time that work began on the operation.
*/
startTime?: string | null;
}
/**
* The response for FirestoreAdmin.ListIndexes.
*/
export interface Schema$GoogleFirestoreAdminV1beta1ListIndexesResponse {
/**
* The indexes.
*/
indexes?: Schema$GoogleFirestoreAdminV1beta1Index[];
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
}
/**
* The metadata message for google.cloud.location.Location.metadata.
*/
export interface Schema$GoogleFirestoreAdminV1beta1LocationMetadata {
}
/**
* Measures the progress of a particular metric.
*/
export interface Schema$GoogleFirestoreAdminV1beta1Progress {
/**
* An estimate of how much work has been completed. Note that this may be greater than `work_estimated`.
*/
workCompleted?: string | null;
/**
* An estimate of how much work needs to be performed. Zero if the work estimate is unavailable. May change as work progresses.
*/
workEstimated?: string | null;
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$GoogleLongrunningOperation {
/**
* If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`.
*/
name?: string | null;
/**
* The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {
[key: string]: any;
} | null;
}
/**
* 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 must conform to the WGS84 standard. Values must be within normalized ranges.
*/
export interface Schema$LatLng {
/**
* The latitude in degrees. It must be in the range [-90.0, +90.0].
*/
latitude?: number | null;
/**
* The longitude in degrees. It must be in the range [-180.0, +180.0].
*/
longitude?: number | null;
}
/**
* The request for Firestore.ListCollectionIds.
*/
export interface Schema$ListCollectionIdsRequest {
/**
* The maximum number of results to return.
*/
pageSize?: number | null;
/**
* A page token. Must be a value from ListCollectionIdsResponse.
*/
pageToken?: string | null;
}
/**
* The response from Firestore.ListCollectionIds.
*/
export interface Schema$ListCollectionIdsResponse {
/**
* The collection ids.
*/
collectionIds?: string[] | null;
/**
* A page token that may be used to continue the list.
*/
nextPageToken?: string | null;
}
/**
* The response for Firestore.ListDocuments.
*/
export interface Schema$ListDocumentsResponse {
/**
* The Documents found.
*/
documents?: Schema$Document[];
/**
* The next page token.
*/
nextPageToken?: string | null;
}
/**
* A request for Firestore.Listen
*/
export interface Schema$ListenRequest {
/**
* A target to add to this stream.
*/
addTarget?: Schema$Target;
/**
* Labels associated with this target change.
*/
labels?: {
[key: string]: string;
} | null;
/**
* The ID of a target to remove from this stream.
*/
removeTarget?: number | null;
}
/**
* The response for Firestore.Listen.
*/
export interface Schema$ListenResponse {
/**
* A Document has changed.
*/
documentChange?: Schema$DocumentChange;
/**
* A Document has been deleted.
*/
documentDelete?: Schema$DocumentDelete;
/**
* A Document has been removed from a target (because it is no longer relevant to that target).
*/
documentRemove?: Schema$DocumentRemove;
/**
* A filter to apply to the set of documents previously returned for the given target. Returned when documents may have been removed from the given target, but the exact documents are unknown.
*/
filter?: Schema$ExistenceFilter;
/**
* Targets have changed.
*/
targetChange?: Schema$TargetChange;
}
/**
* A map value.
*/
export interface Schema$MapValue {
/**
* The map's fields. The map keys represent field names. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
*/
fields?: {
[key: string]: Schema$Value;
} | null;
}
/**
* An order on a field.
*/
export interface Schema$Order {
/**
* The direction to order by. Defaults to `ASCENDING`.
*/
direction?: string | null;
/**
* The field to order by.
*/
field?: Schema$FieldReference;
}
/**
* The request for Firestore.PartitionQuery.
*/
export interface Schema$PartitionQueryRequest {
/**
* The maximum number of partitions to return in this call, subject to `partition_count`. For example, if `partition_count` = 10 and `page_size` = 8, the first call to PartitionQuery will return up to 8 partitions and a `next_page_token` if more results exist. A second call to PartitionQuery will return up to 2 partitions, to complete the total of 10 specified in `partition_count`.
*/
pageSize?: number | null;
/**
* The `next_page_token` value returned from a previous call to PartitionQuery that may be used to get an additional set of results. There are no ordering guarantees between sets of results. Thus, using multiple sets of results will require merging the different result sets. For example, two subsequent calls using a page_token may return: * cursor B, cursor M, cursor Q * cursor A, cursor U, cursor W To obtain a complete result set ordered with respect to the results of the query supplied to PartitionQuery, the results sets should be merged: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W
*/
pageToken?: string | null;
/**
* The desired maximum number of partition points. The partitions may be returned across multiple pages of results. The number must be positive. The actual number of partitions returned may be fewer. For example, this may be set to one fewer than the number of parallel queries to be run, or in running a data pipeline job, one fewer than the number of workers or compute instances available.
*/
partitionCount?: string | null;
/**
* A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported.
*/
structuredQuery?: Schema$StructuredQuery;
}
/**
* The response for Firestore.PartitionQuery.
*/
export interface Schema$PartitionQueryResponse {
/**
* A page token that may be used to request an additional set of results, up to the number specified by `partition_count` in the PartitionQuery request. If blank, there are no more results.
*/
nextPageToken?: string | null;
/**
* Partition results. Each partition is a split point that can be used by RunQuery as a starting or end point for the query results. The RunQuery requests must be made with the same query supplied to this PartitionQuery request. The partition cursors will be ordered according to same ordering as the results of the query supplied to PartitionQuery. For example, if a PartitionQuery request returns partition cursors A and B, running the following three queries will return the entire result set of the original query: * query, end_at A * query, start_at A, end_at B * query, start_at B An empty result may indicate that the query has too few results to be partitioned.
*/
partitions?: Schema$Cursor[];
}
/**
* A precondition on a document, used for conditional operations.
*/
export interface Schema$Precondition {
/**
* When set to `true`, the target document must exist. When set to `false`, the target document must not exist.
*/
exists?: boolean | null;
/**
* When set, the target document must exist and have been last updated at that time.
*/
updateTime?: string | null;
}
/**
* The projection of document's fields to return.
*/
export interface Schema$Projection {
/**
* The fields to return. If empty, all fields are returned. To only return the name of the document, use `['__name__']`.
*/
fields?: Schema$FieldReference[];
}
/**
* A target specified by a query.
*/
export interface Schema$QueryTarget {
/**
* The parent resource name. In the format: `projects/{project_id\}/databases/{database_id\}/documents` or `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
*/
parent?: string | null;
/**
* A structured query.
*/
structuredQuery?: Schema$StructuredQuery;
}
/**
* Options for a transaction that can only be used to read documents.
*/
export interface Schema$ReadOnly {
/**
* Reads documents at the given time. This may not be older than 60 seconds.
*/
readTime?: string | null;
}
/**
* Options for a transaction that can be used to read and write documents.
*/
export interface Schema$ReadWrite {
/**
* An optional transaction to retry.
*/
retryTransaction?: string | null;
}
/**
* The request for Firestore.Rollback.
*/
export interface Schema$RollbackRequest {
/**
* Required. The transaction to roll back.
*/
transaction?: string | null;
}
/**
* The request for Firestore.RunQuery.
*/
export interface Schema$RunQueryRequest {
/**
* Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
*/
newTransaction?: Schema$TransactionOptions;
/**
* Reads documents as they were at the given time. This may not be older than 270 seconds.
*/
readTime?: string | null;
/**
* A structured query.
*/
structuredQuery?: Schema$StructuredQuery;
/**
* Reads documents in a transaction.
*/
transaction?: string | null;
}
/**
* The response for Firestore.RunQuery.
*/
export interface Schema$RunQueryResponse {
/**
* A query result. Not set when reporting partial progress.
*/
document?: Schema$Document;
/**
* The time at which the document was read. This may be monotonically increasing; in this case, the previous documents in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `document` will be sent, and this represents the time at which the query was run.
*/
readTime?: string | null;
/**
* The number of results that have been skipped due to an offset between the last response and the current response.
*/
skippedResults?: number | null;
/**
* The transaction that was started as part of this request. Can only be set in the first response, and only if RunQueryRequest.new_transaction was set in the request. If set, no other fields will be set in this response.
*/
transaction?: string | null;
}
/**
* 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](https://github.com/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](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
*/
message?: string | null;
}
/**
* A Firestore query.
*/
export interface Schema$StructuredQuery {
/**
* A end point for the query results.
*/
endAt?: Schema$Cursor;
/**
* The collections to query.
*/
from?: Schema$CollectionSelector[];
/**
* The maximum number of results to return. Applies after all other constraints. Must be \>= 0 if specified.
*/
limit?: number | null;
/**
* The number of results to skip. Applies before limit, but after all other constraints. Must be \>= 0 if specified.
*/
offset?: number | null;
/**
* The order to apply to the query results. Firestore guarantees a stable ordering through the following rules: * Any field required to appear in `order_by`, that is not already specified in `order_by`, is appended to the order in field name order by default. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `SELECT * FROM Foo ORDER BY A` becomes `SELECT * FROM Foo ORDER BY A, __name__` * `SELECT * FROM Foo ORDER BY A DESC` becomes `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC` * `SELECT * FROM Foo WHERE A \> 1` becomes `SELECT * FROM Foo WHERE A \> 1 ORDER BY A, __name__`
*/
orderBy?: Schema$Order[];
/**
* The projection to return.
*/
select?: Schema$Projection;
/**
* A starting point for the query results.
*/
startAt?: Schema$Cursor;
/**
* The filter to apply.
*/
where?: Schema$Filter;
}
/**
* A specification of a set of documents to listen to.
*/
export interface Schema$Target {
/**
* A target specified by a set of document names.
*/
documents?: Schema$DocumentsTarget;
/**
* If the target should be removed once it is current and consistent.
*/
once?: boolean | null;
/**
* A target specified by a query.
*/
query?: Schema$QueryTarget;
/**
* Start listening after a specific `read_time`. The client must know the state of matching documents at this time.
*/
readTime?: string | null;
/**
* A resume token from a prior TargetChange for an identical target. Using a resume token with a different target is unsupported and may fail.
*/
resumeToken?: string | null;
/**
* The target ID that identifies the target on the stream. Must be a positive number and non-zero.
*/
targetId?: number | null;
}
/**
* Targets being watched have changed.
*/
export interface Schema$TargetChange {
/**
* The error that resulted in this change, if applicable.
*/
cause?: Schema$Status;
/**
* The consistent `read_time` for the given `target_ids` (omitted when the target_ids are not at a consistent snapshot). The stream is guaranteed to send a `read_time` with `target_ids` empty whenever the entire stream reaches a new consistent snapshot. ADD, CURRENT, and RESET messages are guaranteed to (eventually) result in a new consistent snapshot (while NO_CHANGE and REMOVE messages are not). For a given stream, `read_time` is guaranteed to be monotonically increasing.
*/
readTime?: string | null;
/**
* A token that can be used to resume the stream for the given `target_ids`, or all targets if `target_ids` is empty. Not set on every target change.
*/
resumeToken?: string | null;
/**
* The type of change that occurred.
*/
targetChangeType?: string | null;
/**
* The target IDs of targets that have changed. If empty, the change applies to all targets. The order of the target IDs is not defined.
*/
targetIds?: number[] | null;
}
/**
* Options for creating a new transaction.
*/
export interface Schema$TransactionOptions {
/**
* The transaction can only be used for read operations.
*/
readOnly?: Schema$ReadOnly;
/**
* The transaction can be used for both read and write operations.
*/
readWrite?: Schema$ReadWrite;
}
/**
* A filter with a single operand.
*/
export interface Schema$UnaryFilter {
/**
* The field to which to apply the operator.
*/
field?: Schema$FieldReference;
/**
* The unary operator to apply.
*/
op?: string | null;
}
/**
* A message that can hold any of the supported value types.
*/
export interface Schema$Value {
/**
* An array value. Cannot directly contain another array value, though can contain an map which contains another array.
*/
arrayValue?: Schema$ArrayValue;
/**
* A boolean value.
*/
booleanValue?: boolean | null;
/**
* A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
*/
bytesValue?: string | null;
/**
* A double value.
*/
doubleValue?: number | null;
/**
* A geo point value representing a point on the surface of Earth.
*/
geoPointValue?: Schema$LatLng;
/**
* An integer value.
*/
integerValue?: string | null;
/**
* A map value.
*/
mapValue?: Schema$MapValue;
/**
* A null value.
*/
nullValue?: string | null;
/**
* A reference to a document. For example: `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`.
*/
referenceValue?: string | null;
/**
* A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
*/
stringValue?: string | null;
/**
* A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
*/
timestampValue?: string | null;
}
/**
* A write on a document.
*/
export interface Schema$Write {
/**
* An optional precondition on the document. The write will fail if this is set and not met by the target document.
*/
currentDocument?: Schema$Precondition;
/**
* A document name to delete. In the format: `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`.
*/
delete?: string | null;
/**
* Applies a transformation to a document.
*/
transform?: Schema$DocumentTransform;
/**
* A document to write.
*/
update?: Schema$Document;
/**
* The fields to update in this write. This field can be set only when the operation is `update`. If the mask is not set for an `update` and the document exists, any existing data will be overwritten. If the mask is set and the document on the server has fields not covered by the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server. The field paths in this mask must not contain a reserved field name.
*/
updateMask?: Schema$DocumentMask;
/**
* The transforms to perform after update. This field can be set only when the operation is `update`. If present, this write is equivalent to performing `update` and `transform` to the same document atomically and in order.
*/
updateTransforms?: Schema$FieldTransform[];
}
/**
* 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.
*/
export interface Schema$WriteRequest {
/**
* Labels associated with this write request.
*/
labels?: {
[key: string]: string;
} | null;
/**
*