import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/firestore_v1beta1_proto_api'; /** * The Cloud Firestore service. * * Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL * document database that simplifies storing, syncing, and querying data for * your mobile, web, and IoT apps at global scale. Its client libraries provide * live synchronization and offline support, while its security features and * integrations with Firebase and Google Cloud Platform (GCP) accelerate * building truly serverless apps. * @class * @deprecated Use v1/firestore_client instead. * @memberof v1beta1 */ export declare class FirestoreClient { private _terminated; private _opts; private _providedCustomServicePath; private _gaxModule; private _gaxGrpc; private _protos; private _defaults; private _universeDomain; private _servicePath; auth: gax.GoogleAuth; descriptors: Descriptors; warn: (code: string, message: string, warnType?: string) => void; innerApiCalls: { [name: string]: Function; }; firestoreStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of FirestoreClient. * * @param {object} [options] - The configuration object. * The options accepted by the constructor are described in detail * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance). * The common options are: * @param {object} [options.credentials] - Credentials object. * @param {string} [options.credentials.client_email] * @param {string} [options.credentials.private_key] * @param {string} [options.email] - Account email address. Required when * using a .pem or .p12 keyFilename. * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or * .p12 key downloaded from the Google Developers Console. If you provide * a path to a JSON file, the projectId option below is not necessary. * NOTE: .pem and .p12 require you to specify options.email as well. * @param {number} [options.port] - The port on which to connect to * the remote host. * @param {string} [options.projectId] - The project ID from the Google * Developer's Console, e.g. 'grape-spaceship-123'. We will also check * the environment variable GCLOUD_PROJECT for your project ID. If your * app is running in an environment which supports * {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials}, * your project ID will be detected automatically. * @param {string} [options.apiEndpoint] - The domain name of the * API remote host. * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override. * Follows the structure of {@link gapicConfig}. * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode. * For more information, please check the * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}. * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you * need to avoid loading the default gRPC version and want to use the fallback * HTTP implementation. Load only fallback version and pass it to the constructor: * ``` * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC * const client = new FirestoreClient({fallback: true}, gax); * ``` */ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback); /** * Initialize the client. * Performs asynchronous operations (such as authentication) and prepares the client. * This function will be called automatically when any class method is called for the * first time, but if you need to initialize it before calling an actual method, * feel free to call initialize() directly. * * You can await on this method if you want to make sure the client is initialized. * * @returns {Promise} A promise that resolves to an authenticated service stub. */ initialize(): Promise<{ [name: string]: Function; }>; /** * The DNS address for this API service. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get servicePath(): string; /** * The DNS address for this API service - same as servicePath. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get apiEndpoint(): string; /** * The DNS address for this API service. * @returns {string} The DNS address for this service. */ get apiEndpoint(): string; get universeDomain(): string; /** * The port for this API service. * @returns {number} The default port for this service. */ static get port(): number; /** * The scopes needed to make gRPC calls for every method defined * in this service. * @returns {string[]} List of default scopes. */ static get scopes(): string[]; getProjectId(): Promise; getProjectId(callback: Callback): void; /** * Gets a single document. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name of the Document to get. In the format: * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. * @param {google.firestore.v1beta1.DocumentMask} request.mask * The fields to return. If not set, returns all fields. * * If the document has a field that is not present in this mask, that field * will not be returned in the response. * @param {Buffer} request.transaction * Reads the document in a transaction. * @param {google.protobuf.Timestamp} request.readTime * Reads the version of the document at the given time. * This may not be older than 270 seconds. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.firestore.v1beta1.Document|Document}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/firestore.get_document.js * region_tag:firestore_v1beta1_generated_Firestore_GetDocument_async */ getDocument(request?: protos.google.firestore.v1beta1.IGetDocumentRequest, options?: CallOptions): Promise<[ protos.google.firestore.v1beta1.IDocument, protos.google.firestore.v1beta1.IGetDocumentRequest | undefined, {} | undefined ]>; getDocument(request: protos.google.firestore.v1beta1.IGetDocumentRequest, options: CallOptions, callback: Callback): void; getDocument(request: protos.google.firestore.v1beta1.IGetDocumentRequest, callback: Callback): void; /** * Updates or inserts a document. * * @param {Object} request * The request object that will be sent. * @param {google.firestore.v1beta1.Document} request.document * Required. The updated document. * Creates the document if it does not already exist. * @param {google.firestore.v1beta1.DocumentMask} request.updateMask * The fields to update. * None of the field paths in the mask may contain a reserved name. * * If the document exists on the server and has fields not referenced in 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. * @param {google.firestore.v1beta1.DocumentMask} request.mask * The fields to return. If not set, returns all fields. * * If the document has a field that is not present in this mask, that field * will not be returned in the response. * @param {google.firestore.v1beta1.Precondition} request.currentDocument * An optional precondition on the document. * The request will fail if this is set and not met by the target document. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.firestore.v1beta1.Document|Document}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/firestore.update_document.js * region_tag:firestore_v1beta1_generated_Firestore_UpdateDocument_async */ updateDocument(request?: protos.google.firestore.v1beta1.IUpdateDocumentRequest, options?: CallOptions): Promise<[ protos.google.firestore.v1beta1.IDocument, protos.google.firestore.v1beta1.IUpdateDocumentRequest | undefined, {} | undefined ]>; updateDocument(request: protos.google.firestore.v1beta1.IUpdateDocumentRequest, options: CallOptions, callback: Callback): void; updateDocument(request: protos.google.firestore.v1beta1.IUpdateDocumentRequest, callback: Callback): void; /** * Deletes a document. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The resource name of the Document to delete. In the format: * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. * @param {google.firestore.v1beta1.Precondition} request.currentDocument * An optional precondition on the document. * The request will fail if this is set and not met by the target document. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/firestore.delete_document.js * region_tag:firestore_v1beta1_generated_Firestore_DeleteDocument_async */ deleteDocument(request?: protos.google.firestore.v1beta1.IDeleteDocumentRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, protos.google.firestore.v1beta1.IDeleteDocumentRequest | undefined, {} | undefined ]>; deleteDocument(request: protos.google.firestore.v1beta1.IDeleteDocumentRequest, options: CallOptions, callback: Callback): void; deleteDocument(request: protos.google.firestore.v1beta1.IDeleteDocumentRequest, callback: Callback): void; /** * Starts a new transaction. * * @param {Object} request * The request object that will be sent. * @param {string} request.database * Required. The database name. In the format: * `projects/{project_id}/databases/{database_id}`. * @param {google.firestore.v1beta1.TransactionOptions} request.options * The options for the transaction. * Defaults to a read-write transaction. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.firestore.v1beta1.BeginTransactionResponse|BeginTransactionResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/firestore.begin_transaction.js * region_tag:firestore_v1beta1_generated_Firestore_BeginTransaction_async */ beginTransaction(request?: protos.google.firestore.v1beta1.IBeginTransactionRequest, options?: CallOptions): Promise<[ protos.google.firestore.v1beta1.IBeginTransactionResponse, protos.google.firestore.v1beta1.IBeginTransactionRequest | undefined, {} | undefined ]>; beginTransaction(request: protos.google.firestore.v1beta1.IBeginTransactionRequest, options: CallOptions, callback: Callback): void; beginTransaction(request: protos.google.firestore.v1beta1.IBeginTransactionRequest, callback: Callback): void; /** * Commits a transaction, while optionally updating documents. * * @param {Object} request * The request object that will be sent. * @param {string} request.database * Required. The database name. In the format: * `projects/{project_id}/databases/{database_id}`. * @param {number[]} request.writes * The writes to apply. * * Always executed atomically and in order. * @param {Buffer} request.transaction * If set, applies all writes in this transaction, and commits it. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.firestore.v1beta1.CommitResponse|CommitResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/firestore.commit.js * region_tag:firestore_v1beta1_generated_Firestore_Commit_async */ commit(request?: protos.google.firestore.v1beta1.ICommitRequest, options?: CallOptions): Promise<[ protos.google.firestore.v1beta1.ICommitResponse, protos.google.firestore.v1beta1.ICommitRequest | undefined, {} | undefined ]>; commit(request: protos.google.firestore.v1beta1.ICommitRequest, options: CallOptions, callback: Callback): void; commit(request: protos.google.firestore.v1beta1.ICommitRequest, callback: Callback): void; /** * Rolls back a transaction. * * @param {Object} request * The request object that will be sent. * @param {string} request.database * Required. The database name. In the format: * `projects/{project_id}/databases/{database_id}`. * @param {Buffer} request.transaction * Required. The transaction to roll back. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/firestore.rollback.js * region_tag:firestore_v1beta1_generated_Firestore_Rollback_async */ rollback(request?: protos.google.firestore.v1beta1.IRollbackRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, protos.google.firestore.v1beta1.IRollbackRequest | undefined, {} | undefined ]>; rollback(request: protos.google.firestore.v1beta1.IRollbackRequest, options: CallOptions, callback: Callback): void; rollback(request: protos.google.firestore.v1beta1.IRollbackRequest, callback: Callback): void; /** * Applies a batch of write operations. * * The BatchWrite method does not apply the write operations atomically * and can apply them out of order. Method does not allow more than one write * per document. Each write succeeds or fails independently. See the * {@link protos.google.firestore.v1beta1.BatchWriteResponse|BatchWriteResponse} for the success status of each write. * * If you require an atomically applied set of writes, use * {@link protos.google.firestore.v1beta1.Firestore.Commit|Commit} instead. * * @param {Object} request * The request object that will be sent. * @param {string} request.database * Required. The database name. In the format: * `projects/{project_id}/databases/{database_id}`. * @param {number[]} request.writes * 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. * @param {number[]} request.labels * Labels associated with this batch write. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.firestore.v1beta1.BatchWriteResponse|BatchWriteResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/firestore.batch_write.js * region_tag:firestore_v1beta1_generated_Firestore_BatchWrite_async */ batchWrite(request?: protos.google.firestore.v1beta1.IBatchWriteRequest, options?: CallOptions): Promise<[ protos.google.firestore.v1beta1.IBatchWriteResponse, protos.google.firestore.v1beta1.IBatchWriteRequest | undefined, {} | undefined ]>; batchWrite(request: protos.google.firestore.v1beta1.IBatchWriteRequest, options: CallOptions, callback: Callback): void; batchWrite(request: protos.google.firestore.v1beta1.IBatchWriteRequest, callback: Callback): void; /** * Creates a new document. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource. For example: * `projects/{project_id}/databases/{database_id}/documents` or * `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}` * @param {string} request.collectionId * Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`. * @param {string} request.documentId * The client-assigned document ID to use for this document. * * Optional. If not specified, an ID will be assigned by the service. * @param {google.firestore.v1beta1.Document} request.document * Required. The document to create. `name` must not be set. * @param {google.firestore.v1beta1.DocumentMask} request.mask * The fields to return. If not set, returns all fields. * * If the document has a field that is not present in this mask, that field * will not be returned in the response. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.firestore.v1beta1.Document|Document}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/firestore.create_document.js * region_tag:firestore_v1beta1_generated_Firestore_CreateDocument_async */ createDocument(request?: protos.google.firestore.v1beta1.ICreateDocumentRequest, options?: CallOptions): Promise<[ protos.google.firestore.v1beta1.IDocument, protos.google.firestore.v1beta1.ICreateDocumentRequest | undefined, {} | undefined ]>; createDocument(request: protos.google.firestore.v1beta1.ICreateDocumentRequest, options: CallOptions, callback: Callback): void; createDocument(request: protos.google.firestore.v1beta1.ICreateDocumentRequest, callback: Callback): void; /** * Gets multiple documents. * * Documents returned by this method are not guaranteed to be returned in the * same order that they were requested. * * @param {Object} request * The request object that will be sent. * @param {string} request.database * Required. The database name. In the format: * `projects/{project_id}/databases/{database_id}`. * @param {string[]} request.documents * 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. * @param {google.firestore.v1beta1.DocumentMask} request.mask * 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. * @param {Buffer} request.transaction * Reads documents in a transaction. * @param {google.firestore.v1beta1.TransactionOptions} request.newTransaction * 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. * @param {google.protobuf.Timestamp} request.readTime * Reads documents as they were at the given time. * This may not be older than 270 seconds. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits {@link protos.google.firestore.v1beta1.BatchGetDocumentsResponse|BatchGetDocumentsResponse} on 'data' event. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/firestore.batch_get_documents.js * region_tag:firestore_v1beta1_generated_Firestore_BatchGetDocuments_async */ batchGetDocuments(request?: protos.google.firestore.v1beta1.IBatchGetDocumentsRequest, options?: CallOptions): gax.CancellableStream; /** * Runs a query. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. 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` * @param {google.firestore.v1beta1.StructuredQuery} request.structuredQuery * A structured query. * @param {Buffer} request.transaction * Reads documents in a transaction. * @param {google.firestore.v1beta1.TransactionOptions} request.newTransaction * 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. * @param {google.protobuf.Timestamp} request.readTime * Reads documents as they were at the given time. * This may not be older than 270 seconds. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits {@link protos.google.firestore.v1beta1.RunQueryResponse|RunQueryResponse} on 'data' event. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/firestore.run_query.js * region_tag:firestore_v1beta1_generated_Firestore_RunQuery_async */ runQuery(request?: protos.google.firestore.v1beta1.IRunQueryRequest, options?: CallOptions): gax.CancellableStream; /** * Streams batches of document updates and deletes, in order. * * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which is both readable and writable. It accepts objects * representing {@link protos.google.firestore.v1beta1.WriteRequest|WriteRequest} for write() method, and * will emit objects representing {@link protos.google.firestore.v1beta1.WriteResponse|WriteResponse} on 'data' event asynchronously. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#bi-directional-streaming | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/firestore.write.js * region_tag:firestore_v1beta1_generated_Firestore_Write_async */ write(options?: CallOptions): gax.CancellableStream; /** * Listens to changes. * * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which is both readable and writable. It accepts objects * representing {@link protos.google.firestore.v1beta1.ListenRequest|ListenRequest} for write() method, and * will emit objects representing {@link protos.google.firestore.v1beta1.ListenResponse|ListenResponse} on 'data' event asynchronously. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#bi-directional-streaming | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/firestore.listen.js * region_tag:firestore_v1beta1_generated_Firestore_Listen_async */ listen(options?: CallOptions): gax.CancellableStream; /** * Lists documents. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. 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` * @param {string} request.collectionId * Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` * or `messages`. * @param {number} request.pageSize * The maximum number of documents to return. * @param {string} request.pageToken * The `next_page_token` value returned from a previous List request, if any. * @param {string} request.orderBy * The order to sort results by. For example: `priority desc, name`. * @param {google.firestore.v1beta1.DocumentMask} request.mask * 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. * @param {Buffer} request.transaction * Reads documents in a transaction. * @param {google.protobuf.Timestamp} request.readTime * Reads documents as they were at the given time. * This may not be older than 270 seconds. * @param {boolean} request.showMissing * If the list should show missing documents. A missing document is a * document that does not exist but has sub-documents. These documents will * be returned with a key but will not have fields, {@link protos.google.firestore.v1beta1.Document.create_time|Document.create_time}, * or {@link protos.google.firestore.v1beta1.Document.update_time|Document.update_time} set. * * Requests with `show_missing` may not specify `where` or * `order_by`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.firestore.v1beta1.Document|Document}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listDocumentsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDocuments(request?: protos.google.firestore.v1beta1.IListDocumentsRequest, options?: CallOptions): Promise<[ protos.google.firestore.v1beta1.IDocument[], protos.google.firestore.v1beta1.IListDocumentsRequest | null, protos.google.firestore.v1beta1.IListDocumentsResponse ]>; listDocuments(request: protos.google.firestore.v1beta1.IListDocumentsRequest, options: CallOptions, callback: PaginationCallback): void; listDocuments(request: protos.google.firestore.v1beta1.IListDocumentsRequest, callback: PaginationCallback): void; /** * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. 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` * @param {string} request.collectionId * Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` * or `messages`. * @param {number} request.pageSize * The maximum number of documents to return. * @param {string} request.pageToken * The `next_page_token` value returned from a previous List request, if any. * @param {string} request.orderBy * The order to sort results by. For example: `priority desc, name`. * @param {google.firestore.v1beta1.DocumentMask} request.mask * 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. * @param {Buffer} request.transaction * Reads documents in a transaction. * @param {google.protobuf.Timestamp} request.readTime * Reads documents as they were at the given time. * This may not be older than 270 seconds. * @param {boolean} request.showMissing * If the list should show missing documents. A missing document is a * document that does not exist but has sub-documents. These documents will * be returned with a key but will not have fields, {@link protos.google.firestore.v1beta1.Document.create_time|Document.create_time}, * or {@link protos.google.firestore.v1beta1.Document.update_time|Document.update_time} set. * * Requests with `show_missing` may not specify `where` or * `order_by`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.firestore.v1beta1.Document|Document} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listDocumentsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listDocumentsStream(request?: protos.google.firestore.v1beta1.IListDocumentsRequest, options?: CallOptions): Transform; /** * Equivalent to `listDocuments`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. 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` * @param {string} request.collectionId * Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` * or `messages`. * @param {number} request.pageSize * The maximum number of documents to return. * @param {string} request.pageToken * The `next_page_token` value returned from a previous List request, if any. * @param {string} request.orderBy * The order to sort results by. For example: `priority desc, name`. * @param {google.firestore.v1beta1.DocumentMask} request.mask * 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. * @param {Buffer} request.transaction * Reads documents in a transaction. * @param {google.protobuf.Timestamp} request.readTime * Reads documents as they were at the given time. * This may not be older than 270 seconds. * @param {boolean} request.showMissing * If the list should show missing documents. A missing document is a * document that does not exist but has sub-documents. These documents will * be returned with a key but will not have fields, {@link protos.google.firestore.v1beta1.Document.create_time|Document.create_time}, * or {@link protos.google.firestore.v1beta1.Document.update_time|Document.update_time} set. * * Requests with `show_missing` may not specify `where` or * `order_by`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.firestore.v1beta1.Document|Document}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/firestore.list_documents.js * region_tag:firestore_v1beta1_generated_Firestore_ListDocuments_async */ listDocumentsAsync(request?: protos.google.firestore.v1beta1.IListDocumentsRequest, options?: CallOptions): AsyncIterable; /** * Partitions a query by returning partition cursors that can be used to run * the query in parallel. The returned partition cursors are split points that * can be used by RunQuery as starting/end points for the query results. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource name. In the format: * `projects/{project_id}/databases/{database_id}/documents`. * Document resource names are not supported; only database resource names * can be specified. * @param {google.firestore.v1beta1.StructuredQuery} request.structuredQuery * 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. * @param {number} request.partitionCount * 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. * @param {string} request.pageToken * 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 * @param {number} request.pageSize * 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`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.firestore.v1beta1.Cursor|Cursor}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `partitionQueryAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ partitionQuery(request?: protos.google.firestore.v1beta1.IPartitionQueryRequest, options?: CallOptions): Promise<[ protos.google.firestore.v1beta1.ICursor[], protos.google.firestore.v1beta1.IPartitionQueryRequest | null, protos.google.firestore.v1beta1.IPartitionQueryResponse ]>; partitionQuery(request: protos.google.firestore.v1beta1.IPartitionQueryRequest, options: CallOptions, callback: PaginationCallback): void; partitionQuery(request: protos.google.firestore.v1beta1.IPartitionQueryRequest, callback: PaginationCallback): void; /** * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource name. In the format: * `projects/{project_id}/databases/{database_id}/documents`. * Document resource names are not supported; only database resource names * can be specified. * @param {google.firestore.v1beta1.StructuredQuery} request.structuredQuery * 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. * @param {number} request.partitionCount * 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. * @param {string} request.pageToken * 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 * @param {number} request.pageSize * 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`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.firestore.v1beta1.Cursor|Cursor} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `partitionQueryAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ partitionQueryStream(request?: protos.google.firestore.v1beta1.IPartitionQueryRequest, options?: CallOptions): Transform; /** * Equivalent to `partitionQuery`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource name. In the format: * `projects/{project_id}/databases/{database_id}/documents`. * Document resource names are not supported; only database resource names * can be specified. * @param {google.firestore.v1beta1.StructuredQuery} request.structuredQuery * 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. * @param {number} request.partitionCount * 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. * @param {string} request.pageToken * 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 * @param {number} request.pageSize * 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`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.firestore.v1beta1.Cursor|Cursor}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/firestore.partition_query.js * region_tag:firestore_v1beta1_generated_Firestore_PartitionQuery_async */ partitionQueryAsync(request?: protos.google.firestore.v1beta1.IPartitionQueryRequest, options?: CallOptions): AsyncIterable; /** * Lists all the collection IDs underneath a document. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent document. In the format: * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. * For example: * `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` * @param {number} request.pageSize * The maximum number of results to return. * @param {string} request.pageToken * A page token. Must be a value from * {@link protos.google.firestore.v1beta1.ListCollectionIdsResponse|ListCollectionIdsResponse}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of string. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listCollectionIdsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listCollectionIds(request?: protos.google.firestore.v1beta1.IListCollectionIdsRequest, options?: CallOptions): Promise<[ string[], protos.google.firestore.v1beta1.IListCollectionIdsRequest | null, protos.google.firestore.v1beta1.IListCollectionIdsResponse ]>; listCollectionIds(request: protos.google.firestore.v1beta1.IListCollectionIdsRequest, options: CallOptions, callback: PaginationCallback): void; listCollectionIds(request: protos.google.firestore.v1beta1.IListCollectionIdsRequest, callback: PaginationCallback): void; /** * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent document. In the format: * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. * For example: * `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` * @param {number} request.pageSize * The maximum number of results to return. * @param {string} request.pageToken * A page token. Must be a value from * {@link protos.google.firestore.v1beta1.ListCollectionIdsResponse|ListCollectionIdsResponse}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing string on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listCollectionIdsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listCollectionIdsStream(request?: protos.google.firestore.v1beta1.IListCollectionIdsRequest, options?: CallOptions): Transform; /** * Equivalent to `listCollectionIds`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent document. In the format: * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. * For example: * `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` * @param {number} request.pageSize * The maximum number of results to return. * @param {string} request.pageToken * A page token. Must be a value from * {@link protos.google.firestore.v1beta1.ListCollectionIdsResponse|ListCollectionIdsResponse}. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * string. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1beta1/firestore.list_collection_ids.js * region_tag:firestore_v1beta1_generated_Firestore_ListCollectionIds_async */ listCollectionIdsAsync(request?: protos.google.firestore.v1beta1.IListCollectionIdsRequest, options?: CallOptions): AsyncIterable; /** * Terminate the gRPC channel and close the client. * * The client will no longer be usable and all future behavior is undefined. * @returns {Promise} A promise that resolves when the client is closed. */ close(): Promise; }