@google-cloud/discoveryengine 2.0.1 → 2.2.0

package/build/src/v1alpha/document_service_client.d.ts

@@ -146,7 +146,7 @@ export declare class DocumentServiceClient {
      */
     getDocument(request?: protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest, options?: CallOptions): Promise<[
         protos.google.cloud.discoveryengine.v1alpha.IDocument,
-        (protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest | undefined),
+        protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest | undefined,
         {} | undefined
     ]>;
     getDocument(request: protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.IGetDocumentRequest | null | undefined, {} | null | undefined>): void;
@@ -191,7 +191,7 @@ export declare class DocumentServiceClient {
      */
     createDocument(request?: protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest, options?: CallOptions): Promise<[
         protos.google.cloud.discoveryengine.v1alpha.IDocument,
-        (protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest | undefined),
+        protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest | undefined,
         {} | undefined
     ]>;
     createDocument(request: protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.ICreateDocumentRequest | null | undefined, {} | null | undefined>): void;
@@ -231,7 +231,7 @@ export declare class DocumentServiceClient {
      */
     updateDocument(request?: protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest, options?: CallOptions): Promise<[
         protos.google.cloud.discoveryengine.v1alpha.IDocument,
-        (protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest | undefined),
+        protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest | undefined,
         {} | undefined
     ]>;
     updateDocument(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IDocument, protos.google.cloud.discoveryengine.v1alpha.IUpdateDocumentRequest | null | undefined, {} | null | undefined>): void;
@@ -263,7 +263,7 @@ export declare class DocumentServiceClient {
      */
     deleteDocument(request?: protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest, options?: CallOptions): Promise<[
         protos.google.protobuf.IEmpty,
-        (protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest | undefined),
+        protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest | undefined,
         {} | undefined
     ]>;
     deleteDocument(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteDocumentRequest | null | undefined, {} | null | undefined>): void;
@@ -300,7 +300,7 @@ export declare class DocumentServiceClient {
      */
     getProcessedDocument(request?: protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest, options?: CallOptions): Promise<[
         protos.google.cloud.discoveryengine.v1alpha.IProcessedDocument,
-        (protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest | undefined),
+        protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest | undefined,
         {} | undefined
     ]>;
     getProcessedDocument(request: protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IProcessedDocument, protos.google.cloud.discoveryengine.v1alpha.IGetProcessedDocumentRequest | null | undefined, {} | null | undefined>): void;
@@ -329,7 +329,7 @@ export declare class DocumentServiceClient {
      */
     batchGetDocumentsMetadata(request?: protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataRequest, options?: CallOptions): Promise<[
         protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataResponse,
-        (protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataRequest | undefined),
+        protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataRequest | undefined,
         {} | undefined
     ]>;
     batchGetDocumentsMetadata(request: protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataResponse, protos.google.cloud.discoveryengine.v1alpha.IBatchGetDocumentsMetadataRequest | null | undefined, {} | null | undefined>): void;
@@ -538,50 +538,50 @@ export declare class DocumentServiceClient {
      */
     checkPurgeDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.PurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1alpha.PurgeDocumentsMetadata>>;
     /**
-     * Gets a list of {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s.
-     *
-     * @param {Object} request
-     *   The request object that will be sent.
-     * @param {string} request.parent
-     *   Required. The parent branch resource name, such as
-     *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
-     *   Use `default_branch` as the branch ID, to list documents under the default
-     *   branch.
-     *
-     *   If the caller does not have permission to list
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s under this
-     *   branch, regardless of whether or not this branch exists, a
-     *   `PERMISSION_DENIED` error is returned.
-     * @param {number} request.pageSize
-     *   Maximum number of
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to return. If
-     *   unspecified, defaults to 100. The maximum allowed value is 1000. Values
-     *   above 1000 are set to 1000.
-     *
-     *   If this field is negative, an `INVALID_ARGUMENT` error is returned.
-     * @param {string} request.pageToken
-     *   A page token
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
-     *   received from a previous
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments|DocumentService.ListDocuments}
-     *   call. Provide this to retrieve the subsequent page.
-     *
-     *   When paginating, all other parameters provided to
-     *   {@link protos.google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments|DocumentService.ListDocuments}
-     *   must match the call that provided the page token. Otherwise, an
-     *   `INVALID_ARGUMENT` error is returned.
-     * @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.cloud.discoveryengine.v1alpha.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.
-     */
+    * Gets a list of {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s.
+    *
+    * @param {Object} request
+    *   The request object that will be sent.
+    * @param {string} request.parent
+    *   Required. The parent branch resource name, such as
+    *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
+    *   Use `default_branch` as the branch ID, to list documents under the default
+    *   branch.
+    *
+    *   If the caller does not have permission to list
+    *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s under this
+    *   branch, regardless of whether or not this branch exists, a
+    *   `PERMISSION_DENIED` error is returned.
+    * @param {number} request.pageSize
+    *   Maximum number of
+    *   {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to return. If
+    *   unspecified, defaults to 100. The maximum allowed value is 1000. Values
+    *   above 1000 are set to 1000.
+    *
+    *   If this field is negative, an `INVALID_ARGUMENT` error is returned.
+    * @param {string} request.pageToken
+    *   A page token
+    *   {@link protos.google.cloud.discoveryengine.v1alpha.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
+    *   received from a previous
+    *   {@link protos.google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments|DocumentService.ListDocuments}
+    *   call. Provide this to retrieve the subsequent page.
+    *
+    *   When paginating, all other parameters provided to
+    *   {@link protos.google.cloud.discoveryengine.v1alpha.DocumentService.ListDocuments|DocumentService.ListDocuments}
+    *   must match the call that provided the page token. Otherwise, an
+    *   `INVALID_ARGUMENT` error is returned.
+    * @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.cloud.discoveryengine.v1alpha.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.cloud.discoveryengine.v1alpha.IListDocumentsRequest, options?: CallOptions): Promise<[
         protos.google.cloud.discoveryengine.v1alpha.IDocument[],
         protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest | null,
@@ -681,86 +681,86 @@ export declare class DocumentServiceClient {
      */
     listDocumentsAsync(request?: protos.google.cloud.discoveryengine.v1alpha.IListDocumentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1alpha.IDocument>;
     /**
-     * Gets information about a location.
-     *
-     * @param {Object} request
-     *   The request object that will be sent.
-     * @param {string} request.name
-     *   Resource name for the location.
-     * @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 google.cloud.location.Location | Location}.
-     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
-     *   for more details and examples.
-     * @example
-     * ```
-     * const [response] = await client.getLocation(request);
-     * ```
-     */
+       * Gets information about a location.
+       *
+       * @param {Object} request
+       *   The request object that will be sent.
+       * @param {string} request.name
+       *   Resource name for the location.
+       * @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 google.cloud.location.Location | Location}.
+       *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+       *   for more details and examples.
+       * @example
+       * ```
+       * const [response] = await client.getLocation(request);
+       * ```
+       */
     getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
     /**
-     * Lists information about the supported locations for this service. 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.name
-     *   The resource that owns the locations collection, if applicable.
-     * @param {string} request.filter
-     *   The standard list filter.
-     * @param {number} request.pageSize
-     *   The standard list page size.
-     * @param {string} request.pageToken
-     *   The standard list page token.
-     * @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 google.cloud.location.Location | Location}. 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
-     * ```
-     * const iterable = client.listLocationsAsync(request);
-     * for await (const response of iterable) {
-     *   // process response
-     * }
-     * ```
-     */
+       * Lists information about the supported locations for this service. 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.name
+       *   The resource that owns the locations collection, if applicable.
+       * @param {string} request.filter
+       *   The standard list filter.
+       * @param {number} request.pageSize
+       *   The standard list page size.
+       * @param {string} request.pageToken
+       *   The standard list page token.
+       * @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 google.cloud.location.Location | Location}. 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
+       * ```
+       * const iterable = client.listLocationsAsync(request);
+       * for await (const response of iterable) {
+       *   // process response
+       * }
+       * ```
+       */
     listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
     /**
-     * Gets the latest state of a long-running operation.  Clients can use this
-     * method to poll the operation result at intervals as recommended by the API
-     * service.
-     *
-     * @param {Object} request - The request object that will be sent.
-     * @param {string} request.name - The name of the operation resource.
-     * @param {Object=} options
-     *   Optional parameters. You can override the default settings for this call,
-     *   e.g, timeout, retries, paginations, etc. See {@link
-     *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
-     *   for the details.
-     * @param {function(?Error, ?Object)=} callback
-     *   The function which will be called with the result of the API call.
-     *
-     *   The second parameter to the callback is an object representing
-     *   {@link google.longrunning.Operation | google.longrunning.Operation}.
-     * @return {Promise} - The promise which resolves to an array.
-     *   The first element of the array is an object representing
-     * {@link google.longrunning.Operation | google.longrunning.Operation}.
-     * The promise has a method named "cancel" which cancels the ongoing API call.
-     *
-     * @example
-     * ```
-     * const client = longrunning.operationsClient();
-     * const name = '';
-     * const [response] = await client.getOperation({name});
-     * // doThingsWith(response)
-     * ```
-     */
+       * Gets the latest state of a long-running operation.  Clients can use this
+       * method to poll the operation result at intervals as recommended by the API
+       * service.
+       *
+       * @param {Object} request - The request object that will be sent.
+       * @param {string} request.name - The name of the operation resource.
+       * @param {Object=} options
+       *   Optional parameters. You can override the default settings for this call,
+       *   e.g, timeout, retries, paginations, etc. See {@link
+       *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
+       *   for the details.
+       * @param {function(?Error, ?Object)=} callback
+       *   The function which will be called with the result of the API call.
+       *
+       *   The second parameter to the callback is an object representing
+       *   {@link google.longrunning.Operation | google.longrunning.Operation}.
+       * @return {Promise} - The promise which resolves to an array.
+       *   The first element of the array is an object representing
+       * {@link google.longrunning.Operation | google.longrunning.Operation}.
+       * The promise has a method named "cancel" which cancels the ongoing API call.
+       *
+       * @example
+       * ```
+       * const client = longrunning.operationsClient();
+       * const name = '';
+       * const [response] = await client.getOperation({name});
+       * // doThingsWith(response)
+       * ```
+       */
     getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
     /**
      * Lists operations that match the specified filter in the request. If the