googleapis
Version:
Google APIs Client Library for Node.js
1,079 lines • 229 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_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
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('v1');
* ```
*/
export class Firestore {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Defines a aggregation that produces a single result.
*/
export interface Schema$Aggregation {
/**
* Optional. Optional name of the field to store the result of the aggregation into. If not provided, Firestore will pick a default name following the format `field_`. For example: ``` AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT_UP_TO(4) OVER ( ... ); ``` becomes: ``` AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2) AS field_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT_UP_TO(4) AS field_2 OVER ( ... ); ``` Requires: * Must be unique across all aggregation aliases. * Conform to document field name limitations.
*/
alias?: string | null;
/**
* Count aggregator.
*/
count?: Schema$Count;
}
/**
* 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.
*/
export interface Schema$AggregationResult {
/**
* The result of the aggregation functions, ex: `COUNT(*) AS total_docs`. The key is the alias assigned to the aggregation function on input and the size of this map equals the number of aggregation functions in the query.
*/
aggregateFields?: {
[key: string]: Schema$Value;
} | null;
}
/**
* 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. Requires: * At least one filter is present.
*/
filters?: Schema$Filter[];
/**
* The operator for combining multiple filters.
*/
op?: string | null;
}
/**
* Count of documents that match the query. The `COUNT(*)` aggregation function operates on the entire document so it does not require a field reference.
*/
export interface Schema$Count {
/**
* Optional. Optional constraint on the maximum number of documents to count. This provides a way to set an upper bound on the number of documents to scan, limiting latency and cost. Unspecified is interpreted as no bound. High-Level Example: ``` AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k ); ``` Requires: * Must be greater than zero when present.
*/
upTo?: 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); \}
*/
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 in a document, ex: `stats.operations`.
*/
export interface Schema$FieldReference {
/**
* The relative path of the document being referenced. Requires: * Conform to document field name limitations.
*/
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;
}
/**
* A Cloud Firestore Database. Currently only one database is allowed per cloud project; this database must have a `database_id` of '(default)'.
*/
export interface Schema$GoogleFirestoreAdminV1Database {
/**
* The App Engine integration mode to use for this database.
*/
appEngineIntegrationMode?: string | null;
/**
* The concurrency control mode to use for this database.
*/
concurrencyMode?: string | null;
/**
* This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
*/
etag?: string | null;
/**
* Output only. The key_prefix for this database. This key_prefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
*/
keyPrefix?: string | null;
/**
* The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations.
*/
locationId?: string | null;
/**
* The resource name of the Database. Format: `projects/{project\}/databases/{database\}`
*/
name?: string | null;
/**
* The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
*/
type?: string | null;
}
/**
* Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments.
*/
export interface Schema$GoogleFirestoreAdminV1ExportDocumentsMetadata {
/**
* Which collection ids are being exported.
*/
collectionIds?: string[] | null;
/**
* The time this operation completed. Will be unset if operation still in progress.
*/
endTime?: string | null;
/**
* The state of the export operation.
*/
operationState?: string | null;
/**
* Where the entities are being exported to.
*/
outputUriPrefix?: string | null;
/**
* The progress, in bytes, of this operation.
*/
progressBytes?: Schema$GoogleFirestoreAdminV1Progress;
/**
* The progress, in documents, of this operation.
*/
progressDocuments?: Schema$GoogleFirestoreAdminV1Progress;
/**
* The time this operation started.
*/
startTime?: string | null;
}
/**
* The request for FirestoreAdmin.ExportDocuments.
*/
export interface Schema$GoogleFirestoreAdminV1ExportDocumentsRequest {
/**
* Which collection ids to export. Unspecified means all collections.
*/
collectionIds?: string[] | null;
/**
* An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.
*/
namespaceIds?: 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$GoogleFirestoreAdminV1ExportDocumentsResponse {
/**
* 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;
}
/**
* 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.
*/
export interface Schema$GoogleFirestoreAdminV1Field {
/**
* The index configuration for this field. If unset, field indexing will revert to the configuration defined by the `ancestor_field`. To explicitly remove all indexes for this field, specify an index config with an empty list of indexes.
*/
indexConfig?: Schema$GoogleFirestoreAdminV1IndexConfig;
/**
* Required. A field name of the form `projects/{project_id\}/databases/{database_id\}/collectionGroups/{collection_id\}/fields/{field_path\}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\`address.city\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id\}/databases/{database_id\}/collectionGroups/__default__/fields/x` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration.
*/
name?: string | null;
/**
* The TTL configuration for this `Field`. Setting or unsetting this will enable or disable the TTL for documents that have this `Field`.
*/
ttlConfig?: Schema$GoogleFirestoreAdminV1TtlConfig;
}
/**
* Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField.
*/
export interface Schema$GoogleFirestoreAdminV1FieldOperationMetadata {
/**
* The time this operation completed. Will be unset if operation still in progress.
*/
endTime?: string | null;
/**
* The field resource that this operation is acting on. For example: `projects/{project_id\}/databases/{database_id\}/collectionGroups/{collection_id\}/fields/{field_path\}`
*/
field?: string | null;
/**
* A list of IndexConfigDelta, which describe the intent of this operation.
*/
indexConfigDeltas?: Schema$GoogleFirestoreAdminV1IndexConfigDelta[];
/**
* The progress, in bytes, of this operation.
*/
progressBytes?: Schema$GoogleFirestoreAdminV1Progress;
/**
* The progress, in documents, of this operation.
*/
progressDocuments?: Schema$GoogleFirestoreAdminV1Progress;
/**
* The time this operation started.
*/
startTime?: string | null;
/**
* The state of the operation.
*/
state?: string | null;
/**
* Describes the deltas of TTL configuration.
*/
ttlConfigDelta?: Schema$GoogleFirestoreAdminV1TtlConfigDelta;
}
/**
* Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments.
*/
export interface Schema$GoogleFirestoreAdminV1ImportDocumentsMetadata {
/**
* Which collection ids are being imported.
*/
collectionIds?: string[] | null;
/**
* The time this operation completed. Will be unset if operation still in progress.
*/
endTime?: string | null;
/**
* The location of the documents being imported.
*/
inputUriPrefix?: string | null;
/**
* The state of the import operation.
*/
operationState?: string | null;
/**
* The progress, in bytes, of this operation.
*/
progressBytes?: Schema$GoogleFirestoreAdminV1Progress;
/**
* The progress, in documents, of this operation.
*/
progressDocuments?: Schema$GoogleFirestoreAdminV1Progress;
/**
* The time this operation started.
*/
startTime?: string | null;
}
/**
* The request for FirestoreAdmin.ImportDocuments.
*/
export interface Schema$GoogleFirestoreAdminV1ImportDocumentsRequest {
/**
* 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.v1.ExportDocumentsResponse.output_uri_prefix.
*/
inputUriPrefix?: string | null;
/**
* An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.
*/
namespaceIds?: string[] | null;
}
/**
* Cloud Firestore indexes enable simple and complex queries against documents in a database.
*/
export interface Schema$GoogleFirestoreAdminV1Index {
/**
* The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.
*/
fields?: Schema$GoogleFirestoreAdminV1IndexField[];
/**
* Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id\}/databases/{database_id\}/collectionGroups/{collection_id\}/indexes/{composite_index_id\}` For single field indexes, this field will be empty.
*/
name?: string | null;
/**
* Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.
*/
queryScope?: string | null;
/**
* Output only. The serving state of the index.
*/
state?: string | null;
}
/**
* The index configuration for this field.
*/
export interface Schema$GoogleFirestoreAdminV1IndexConfig {
/**
* Output only. Specifies the resource name of the `Field` from which this field's index configuration is set (when `uses_ancestor_config` is true), or from which it *would* be set if this field had no index configuration (when `uses_ancestor_config` is false).
*/
ancestorField?: string | null;
/**
* The indexes supported for this field.
*/
indexes?: Schema$GoogleFirestoreAdminV1Index[];
/**
* Output only When true, the `Field`'s index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by `ancestor_field`, at which point `uses_ancestor_config` will be `true` and `reverting` will be `false`.
*/
reverting?: boolean | null;
/**
* Output only. When true, the `Field`'s index configuration is set from the configuration specified by the `ancestor_field`. When false, the `Field`'s index configuration is defined explicitly.
*/
usesAncestorConfig?: boolean | null;
}
/**
* Information about an index configuration change.
*/
export interface Schema$GoogleFirestoreAdminV1IndexConfigDelta {
/**
* Specifies how the index is changing.
*/
changeType?: string | null;
/**
* The index being changed.
*/
index?: Schema$GoogleFirestoreAdminV1Index;
}
/**
* A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
*/
export interface Schema$GoogleFirestoreAdminV1IndexField {
/**
* Indicates that this field supports operations on `array_value`s.
*/
arrayConfig?: string | null;
/**
* Can be __name__. For single field indexes, this must match the name of the field or may be omitted.
*/
fieldPath?: string | null;
/**
* Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, \>, \>=.
*/
order?: string | null;
}
/**
* Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex.
*/
export interface Schema$GoogleFirestoreAdminV1IndexOperationMetadata {
/**
* The time this operation completed. Will be unset if operation still in progress.
*/
endTime?: string | null;
/**
* The index resource that this operation is acting on. For example: `projects/{project_id\}/databases/{database_id\}/collectionGroups/{collection_id\}/indexes/{index_id\}`
*/
index?: string | null;
/**
* The progress, in bytes, of this operation.
*/
progressBytes?: Schema$GoogleFirestoreAdminV1Progress;
/**
* The progress, in documents, of this operation.
*/
progressDocuments?: Schema$GoogleFirestoreAdminV1Progress;
/**
* The time this operation started.
*/
startTime?: string | null;
/**
* The state of the operation.
*/
state?: string | null;
}
/**
* The list of databases for a project.
*/
export interface Schema$GoogleFirestoreAdminV1ListDatabasesResponse {
/**
* The databases in the project.
*/
databases?: Schema$GoogleFirestoreAdminV1Database[];
}
/**
* The response for FirestoreAdmin.ListFields.
*/
export interface Schema$GoogleFirestoreAdminV1ListFieldsResponse {
/**
* The requested fields.
*/
fields?: Schema$GoogleFirestoreAdminV1Field[];
/**
* A page token that may be used to request another page of results. If blank, this is the last page.
*/
nextPageToken?: string | null;
}
/**
* The response for FirestoreAdmin.ListIndexes.
*/
export interface Schema$GoogleFirestoreAdminV1ListIndexesResponse {
/**
* The requested indexes.
*/
indexes?: Schema$GoogleFirestoreAdminV1Index[];
/**
* A page token that may be used to request another page of results. If blank, this is the last page.
*/
nextPageToken?: string | null;
}
/**
* The metadata message for google.cloud.location.Location.metadata.
*/
export interface Schema$GoogleFirestoreAdminV1LocationMetadata {
}
/**
* Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress is used.
*/
export interface Schema$GoogleFirestoreAdminV1Progress {
/**
* The amount of work completed.
*/
completedWork?: string | null;
/**
* The amount of work estimated.
*/
estimatedWork?: string | null;
}
/**
* 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.
*/
export interface Schema$GoogleFirestoreAdminV1TtlConfig {
/**
* Output only. The state of the TTL configuration.
*/
state?: string | null;
}
/**
* Information about an TTL configuration change.
*/
export interface Schema$GoogleFirestoreAdminV1TtlConfigDelta {
/**
* Specifies how the TTL configuration is changing.
*/
changeType?: string | null;
}
/**
* Metadata related to the update database operation.
*/
export interface Schema$GoogleFirestoreAdminV1UpdateDatabaseMetadata {
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$GoogleLongrunningCancelOperationRequest {
}
/**
* The response message for Operations.ListOperations.
*/
export interface Schema$GoogleLongrunningListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$GoogleLongrunningOperation[];
}
/**
* 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 object 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;
/**
* Reads documents as they were at the given time. This may not be older than 270 seconds.
*/
readTime?: 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;
}
/**
* The response message for Locations.ListLocations.
*/
export interface Schema$ListLocationsResponse {
/**
* A list of locations that matches the specified filter in the request.
*/
locations?: Schema$Location[];
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
}
/**
* A resource that represents Google Cloud Platform location.
*/
export interface Schema$Location {
/**
* The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string | null;
/**
* Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\}
*/
labels?: {
[key: string]: string;
} | null;
/**
* The canonical id for this location. For example: `"us-east1"`.
*/
locationId?: string | null;
/**
* Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
*/
name?: string | null;
}
/**
* 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;
/**
* Reads documents as they were at the given time. This may not be older than 270 seconds.
*/
readTime?: 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 cur