googleapis
Version:
Google APIs Client Library for Node.js
1,116 lines • 126 kB
TypeScript
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace firestore_v1 {
interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* 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
* const {google} = require('googleapis');
* const firestore = google.firestore('v1');
*
* @namespace firestore
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Firestore
*/
class Firestore {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* An array value.
*/
interface Schema$ArrayValue {
/**
* Values in the array.
*/
values?: Schema$Value[];
}
/**
* The request for Firestore.BatchGetDocuments.
*/
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[];
/**
* 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 60 seconds.
*/
readTime?: string;
/**
* Reads documents in a transaction.
*/
transaction?: string;
}
/**
* The streamed response for Firestore.BatchGetDocuments.
*/
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;
/**
* 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;
/**
* 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;
}
/**
* The request for Firestore.BeginTransaction.
*/
interface Schema$BeginTransactionRequest {
/**
* The options for the transaction. Defaults to a read-write transaction.
*/
options?: Schema$TransactionOptions;
}
/**
* The response for Firestore.BeginTransaction.
*/
interface Schema$BeginTransactionResponse {
/**
* The transaction that was started.
*/
transaction?: string;
}
/**
* A selection of a collection, such as `messages as m1`.
*/
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;
/**
* The collection ID. When set, selects only collections with this ID.
*/
collectionId?: string;
}
/**
* The request for Firestore.Commit.
*/
interface Schema$CommitRequest {
/**
* If set, applies all writes in this transaction, and commits it.
*/
transaction?: string;
/**
* The writes to apply. Always executed atomically and in order.
*/
writes?: Schema$Write[];
}
/**
* The response for Firestore.Commit.
*/
interface Schema$CommitResponse {
/**
* The time at which the commit occurred.
*/
commitTime?: string;
/**
* 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.
*/
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;
}
/**
* A position in a query result set.
*/
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;
/**
* 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.
*/
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;
/**
* 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;
};
/**
* The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
*/
name?: string;
/**
* 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;
}
/**
* 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.
*/
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[];
/**
* A set of target IDs of targets that match this document.
*/
targetIds?: number[];
}
/**
* 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.
*/
interface Schema$DocumentDelete {
/**
* The resource name of the Document that was deleted.
*/
document?: string;
/**
* The read timestamp at which the delete was observed. Greater or equal to the `commit_time` of the delete.
*/
readTime?: string;
/**
* A set of target IDs for targets that previously matched this entity.
*/
removedTargetIds?: number[];
}
/**
* 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.
*/
interface Schema$DocumentMask {
/**
* The list of field paths in the mask. See Document.fields for a field path syntax reference.
*/
fieldPaths?: string[];
}
/**
* 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.
*/
interface Schema$DocumentRemove {
/**
* The resource name of the Document that has gone out of view.
*/
document?: string;
/**
* The read timestamp at which the remove was observed. Greater or equal to the `commit_time` of the change/delete/remove.
*/
readTime?: string;
/**
* A set of target IDs for targets that previously matched this document.
*/
removedTargetIds?: number[];
}
/**
* A target specified by a set of documents names.
*/
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[];
}
/**
* A transformation of a document.
*/
interface Schema$DocumentTransform {
/**
* The name of the document to transform.
*/
document?: string;
/**
* 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 `{}`.
*/
interface Schema$Empty {
}
/**
* A digest of all the documents that match a given target.
*/
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;
/**
* The target ID to which this filter applies.
*/
targetId?: number;
}
/**
* A filter on a specific field.
*/
interface Schema$FieldFilter {
/**
* The field to filter by.
*/
field?: Schema$FieldReference;
/**
* The operator to filter by.
*/
op?: string;
/**
* The value to compare to.
*/
value?: Schema$Value;
}
/**
* A reference to a field, such as `max(messages.time) as max_time`.
*/
interface Schema$FieldReference {
fieldPath?: string;
}
/**
* A transformation of a field of the document.
*/
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;
/**
* 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;
}
/**
* A filter.
*/
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 google.longrunning.Operation results from FirestoreAdmin.ExportDocuments.
*/
interface Schema$GoogleFirestoreAdminV1ExportDocumentsMetadata {
/**
* Which collection ids are being exported.
*/
collectionIds?: string[];
/**
* The time this operation completed. Will be unset if operation still in progress.
*/
endTime?: string;
/**
* The state of the export operation.
*/
operationState?: string;
/**
* Where the entities are being exported to.
*/
outputUriPrefix?: string;
/**
* 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;
}
/**
* The request for FirestoreAdmin.ExportDocuments.
*/
interface Schema$GoogleFirestoreAdminV1ExportDocumentsRequest {
/**
* Which collection ids to export. Unspecified means all collections.
*/
collectionIds?: string[];
/**
* 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;
}
/**
* Returned in the google.longrunning.Operation response field.
*/
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;
}
/**
* 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.
*/
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;
/**
* 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;
}
/**
* Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField.
*/
interface Schema$GoogleFirestoreAdminV1FieldOperationMetadata {
/**
* The time this operation completed. Will be unset if operation still in progress.
*/
endTime?: string;
/**
* 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;
/**
* 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;
/**
* The state of the operation.
*/
state?: string;
}
/**
* Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments.
*/
interface Schema$GoogleFirestoreAdminV1ImportDocumentsMetadata {
/**
* Which collection ids are being imported.
*/
collectionIds?: string[];
/**
* The time this operation completed. Will be unset if operation still in progress.
*/
endTime?: string;
/**
* The location of the documents being imported.
*/
inputUriPrefix?: string;
/**
* The state of the import operation.
*/
operationState?: string;
/**
* 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;
}
/**
* The request for FirestoreAdmin.ImportDocuments.
*/
interface Schema$GoogleFirestoreAdminV1ImportDocumentsRequest {
/**
* Which collection ids to import. Unspecified means all collections included in the import.
*/
collectionIds?: string[];
/**
* 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;
}
/**
* Cloud Firestore indexes enable simple and complex queries against documents in a database.
*/
interface Schema$GoogleFirestoreAdminV1Index {
/**
* The fields supported by this index. For composite indexes, this is always 2 or more 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;
/**
* 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;
/**
* Output only. The serving state of the index.
*/
state?: string;
}
/**
* The index configuration for this field.
*/
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;
/**
* 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;
/**
* 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;
}
/**
* Information about an index configuration change.
*/
interface Schema$GoogleFirestoreAdminV1IndexConfigDelta {
/**
* Specifies how the index is changing.
*/
changeType?: string;
/**
* 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.
*/
interface Schema$GoogleFirestoreAdminV1IndexField {
/**
* Indicates that this field supports operations on `array_value`s.
*/
arrayConfig?: string;
/**
* Can be __name__. For single field indexes, this must match the name of the field or may be omitted.
*/
fieldPath?: string;
/**
* Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
*/
order?: string;
}
/**
* Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex.
*/
interface Schema$GoogleFirestoreAdminV1IndexOperationMetadata {
/**
* The time this operation completed. Will be unset if operation still in progress.
*/
endTime?: string;
/**
* 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;
/**
* 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;
/**
* The state of the operation.
*/
state?: string;
}
/**
* The response for FirestoreAdmin.ListFields.
*/
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;
}
/**
* The response for FirestoreAdmin.ListIndexes.
*/
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;
}
/**
* The metadata message for google.cloud.location.Location.metadata.
*/
interface Schema$GoogleFirestoreAdminV1LocationMetadata {
}
/**
* Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress is used.
*/
interface Schema$GoogleFirestoreAdminV1Progress {
/**
* The amount of work completed.
*/
completedWork?: string;
/**
* The amount of work estimated.
*/
estimatedWork?: string;
}
/**
* The request message for Operations.CancelOperation.
*/
interface Schema$GoogleLongrunningCancelOperationRequest {
}
/**
* The response message for Operations.ListOperations.
*/
interface Schema$GoogleLongrunningListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string;
/**
* 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.
*/
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;
/**
* 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;
};
/**
* 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 have the format of `operations/some/unique/name`.
*/
name?: string;
/**
* 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;
};
}
/**
* An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges.
*/
interface Schema$LatLng {
/**
* The latitude in degrees. It must be in the range [-90.0, +90.0].
*/
latitude?: number;
/**
* The longitude in degrees. It must be in the range [-180.0, +180.0].
*/
longitude?: number;
}
/**
* The request for Firestore.ListCollectionIds.
*/
interface Schema$ListCollectionIdsRequest {
/**
* The maximum number of results to return.
*/
pageSize?: number;
/**
* A page token. Must be a value from ListCollectionIdsResponse.
*/
pageToken?: string;
}
/**
* The response from Firestore.ListCollectionIds.
*/
interface Schema$ListCollectionIdsResponse {
/**
* The collection ids.
*/
collectionIds?: string[];
/**
* A page token that may be used to continue the list.
*/
nextPageToken?: string;
}
/**
* The response for Firestore.ListDocuments.
*/
interface Schema$ListDocumentsResponse {
/**
* The Documents found.
*/
documents?: Schema$Document[];
/**
* The next page token.
*/
nextPageToken?: string;
}
/**
* A request for Firestore.Listen
*/
interface Schema$ListenRequest {
/**
* A target to add to this stream.
*/
addTarget?: Schema$Target;
/**
* Labels associated with this target change.
*/
labels?: {
[key: string]: string;
};
/**
* The ID of a target to remove from this stream.
*/
removeTarget?: number;
}
/**
* The response for Firestore.Listen.
*/
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.
*/
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;
}
/**
* A resource that represents Google Cloud Platform location.
*/
interface Schema$Location {
/**
* The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string;
/**
* Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
*/
labels?: {
[key: string]: string;
};
/**
* The canonical id for this location. For example: `"us-east1"`.
*/
locationId?: string;
/**
* Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {
[key: string]: any;
};
/**
* Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
*/
name?: string;
}
/**
* A map value.
*/
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;
};
}
/**
* An order on a field.
*/
interface Schema$Order {
/**
* The direction to order by. Defaults to `ASCENDING`.
*/
direction?: string;
/**
* The field to order by.
*/
field?: Schema$FieldReference;
}
/**
* A precondition on a document, used for conditional operations.
*/
interface Schema$Precondition {
/**
* When set to `true`, the target document must exist. When set to `false`, the target document must not exist.
*/
exists?: boolean;
/**
* When set, the target document must exist and have been last updated at that time.
*/
updateTime?: string;
}
/**
* The projection of document's fields to return.
*/
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.
*/
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;
/**
* A structured query.
*/
structuredQuery?: Schema$StructuredQuery;
}
/**
* Options for a transaction that can only be used to read documents.
*/
interface Schema$ReadOnly {
/**
* Reads documents at the given time. This may not be older than 60 seconds.
*/
readTime?: string;
}
/**
* Options for a transaction that can be used to read and write documents.
*/
interface Schema$ReadWrite {
/**
* An optional transaction to retry.
*/
retryTransaction?: string;
}
/**
* The request for Firestore.Rollback.
*/
interface Schema$RollbackRequest {
/**
* The transaction to roll back.
*/
transaction?: string;
}
/**
* The request for Firestore.RunQuery.
*/
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 60 seconds.
*/
readTime?: string;
/**
* A structured query.
*/
structuredQuery?: Schema$StructuredQuery;
/**
* Reads documents in a transaction.
*/
transaction?: string;
}
/**
* The response for Firestore.RunQuery.
*/
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;
/**
* The number of results that have been skipped due to an offset between the last response and the current response.
*/
skippedResults?: number;
/**
* 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;
}
/**
* 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). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
*/
interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number;
/**
* 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;
}>;
/**
* 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;
}
/**
* A Firestore query.
*/
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;
/**
* The number of results to skip. Applies before limit, but after all other constraints. Must be >= 0 if specified.
*/
offset?: number;
/**
* 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.
*/
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;
/**
* 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;
/**
* 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;
/**
* A client provided target ID. If not set, the server will assign an ID for the target. Used for resuming a target without changing IDs. The IDs can either be client-assigned or be server-assigned in a previous stream. All targets with client provided IDs must be added before adding a target that needs a server-assigned id.
*/
targetId?: number;
}
/**
* Targets being watched have changed.
*/
interface Sch