@google-cloud/discoveryengine 0.6.0 → 0.7.0

package/build/src/v1/search_service_client.d.ts

@@ -0,0 +1,857 @@
+/// <reference types="node" />
+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/protos';
+/**
+ *  Service for search.
+ * @class
+ * @memberof v1
+ */
+export declare class SearchServiceClient {
+    private _terminated;
+    private _opts;
+    private _providedCustomServicePath;
+    private _gaxModule;
+    private _gaxGrpc;
+    private _protos;
+    private _defaults;
+    auth: gax.GoogleAuth;
+    descriptors: Descriptors;
+    warn: (code: string, message: string, warnType?: string) => void;
+    innerApiCalls: {
+        [name: string]: Function;
+    };
+    pathTemplates: {
+        [name: string]: gax.PathTemplate;
+    };
+    searchServiceStub?: Promise<{
+        [name: string]: Function;
+    }>;
+    /**
+     * Construct an instance of SearchServiceClient.
+     *
+     * @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 | "rest"} [options.fallback] - Use HTTP fallback mode.
+     *     Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
+     *     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 SearchServiceClient({fallback: 'rest'}, 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.
+     * @returns {string} The DNS address for this service.
+     */
+    static get servicePath(): string;
+    /**
+     * The DNS address for this API service - same as servicePath(),
+     * exists for compatibility reasons.
+     * @returns {string} The DNS address for this service.
+     */
+    static get apiEndpoint(): 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<string>;
+    getProjectId(callback: Callback<string, undefined, undefined>): void;
+    /**
+     * Performs a search.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.servingConfig
+     *   Required. The resource name of the Search serving config, such as
+     *   `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
+     *   This field is used to identify the serving configuration name, set
+     *   of models used to make the search.
+     * @param {string} request.branch
+     *   The branch resource name, such as
+     *   `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
+     *
+     *   Use `default_branch` as the branch ID or leave this field empty, to search
+     *   documents under the default branch.
+     * @param {string} request.query
+     *   Raw search query.
+     * @param {number} request.pageSize
+     *   Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
+     *   return. If unspecified, defaults to a reasonable value. The maximum allowed
+     *   value is 100. Values above 100 will be coerced to 100.
+     *
+     *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+     * @param {string} request.pageToken
+     *   A page token received from a previous
+     *   {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
+     *   call. Provide this to retrieve the subsequent page.
+     *
+     *   When paginating, all other parameters provided to
+     *   {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
+     *   must match the call that provided the page token. Otherwise, an
+     *    `INVALID_ARGUMENT`  error is returned.
+     * @param {number} request.offset
+     *   A 0-indexed integer that specifies the current offset (that is, starting
+     *   result location, amongst the
+     *   {@link google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
+     *   relevant) in search results. This field is only considered if
+     *   {@link google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
+     *   unset.
+     *
+     *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+     * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
+     *   Information about the end user.
+     *   Highly recommended for analytics. The user_agent string in UserInfo will
+     *   be used to deduce device_type for analytics.
+     * @param {number[]} request.params
+     *   Additional search parameters.
+     *
+     *   For public website search only, supported values are:
+     *
+     *   * `user_country_code`: string. Default empty. If set to non-empty, results
+     *      are restricted or boosted based on the location provided.
+     *   * `search_type`: double. Default empty. Enables non-webpage searching
+     *     depending on the value. The only valid non-default value is 1,
+     *     which enables image searching.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
+     *   The query expansion specification that specifies the conditions under which
+     *   query expansion will occur.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
+     *   The spell correction specification that specifies the mode under
+     *   which spell correction will take effect.
+     * @param {string} request.userPseudoId
+     *   A unique identifier for tracking visitors. For example, this could be
+     *   implemented with an HTTP cookie, which should be able to uniquely identify
+     *   a visitor on a single device. This unique identifier should not change if
+     *   the visitor logs in or out of the website.
+     *
+     *   This field should NOT have a fixed value such as `unknown_visitor`.
+     *
+     *   This should be the same identifier as
+     *   {@link google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
+     *   and
+     *   {@link google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
+     *
+     *   The field must be a UTF-8 encoded string with a length limit of 128
+     *   characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
+     *   The content search spec that configs the desired behavior of content
+     *   search.
+     * @param {boolean} request.safeSearch
+     *   Whether to turn on safe search. This is only supported for
+     *   {@link |ContentConfig.PUBLIC_WEBSITE}.
+     * @param {number[]} request.userLabels
+     *   The user labels applied to a resource must meet the following requirements:
+     *
+     *   * Each resource can have multiple labels, up to a maximum of 64.
+     *   * Each label must be a key-value pair.
+     *   * Keys have a minimum length of 1 character and a maximum length of 63
+     *     characters and cannot be empty. Values can be empty and have a maximum
+     *     length of 63 characters.
+     *   * Keys and values can contain only lowercase letters, numeric characters,
+     *     underscores, and dashes. All characters must use UTF-8 encoding, and
+     *     international characters are allowed.
+     *   * The key portion of a label must be unique. However, you can use the same
+     *     key with multiple resources.
+     *   * Keys must start with a lowercase letter or international character.
+     *
+     *   See [Google Cloud
+     *   Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+     *   for more details.
+     * @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 google.cloud.discoveryengine.v1.SearchResponse.SearchResult | SearchResult}.
+     *   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 `searchAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   for more details and examples.
+     */
+    search(request?: protos.google.cloud.discoveryengine.v1.ISearchRequest, options?: CallOptions): Promise<[
+        protos.google.cloud.discoveryengine.v1.SearchResponse.ISearchResult[],
+        protos.google.cloud.discoveryengine.v1.ISearchRequest | null,
+        protos.google.cloud.discoveryengine.v1.ISearchResponse
+    ]>;
+    search(request: protos.google.cloud.discoveryengine.v1.ISearchRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1.ISearchRequest, protos.google.cloud.discoveryengine.v1.ISearchResponse | null | undefined, protos.google.cloud.discoveryengine.v1.SearchResponse.ISearchResult>): void;
+    search(request: protos.google.cloud.discoveryengine.v1.ISearchRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1.ISearchRequest, protos.google.cloud.discoveryengine.v1.ISearchResponse | null | undefined, protos.google.cloud.discoveryengine.v1.SearchResponse.ISearchResult>): 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.servingConfig
+     *   Required. The resource name of the Search serving config, such as
+     *   `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
+     *   This field is used to identify the serving configuration name, set
+     *   of models used to make the search.
+     * @param {string} request.branch
+     *   The branch resource name, such as
+     *   `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
+     *
+     *   Use `default_branch` as the branch ID or leave this field empty, to search
+     *   documents under the default branch.
+     * @param {string} request.query
+     *   Raw search query.
+     * @param {number} request.pageSize
+     *   Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
+     *   return. If unspecified, defaults to a reasonable value. The maximum allowed
+     *   value is 100. Values above 100 will be coerced to 100.
+     *
+     *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+     * @param {string} request.pageToken
+     *   A page token received from a previous
+     *   {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
+     *   call. Provide this to retrieve the subsequent page.
+     *
+     *   When paginating, all other parameters provided to
+     *   {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
+     *   must match the call that provided the page token. Otherwise, an
+     *    `INVALID_ARGUMENT`  error is returned.
+     * @param {number} request.offset
+     *   A 0-indexed integer that specifies the current offset (that is, starting
+     *   result location, amongst the
+     *   {@link google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
+     *   relevant) in search results. This field is only considered if
+     *   {@link google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
+     *   unset.
+     *
+     *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+     * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
+     *   Information about the end user.
+     *   Highly recommended for analytics. The user_agent string in UserInfo will
+     *   be used to deduce device_type for analytics.
+     * @param {number[]} request.params
+     *   Additional search parameters.
+     *
+     *   For public website search only, supported values are:
+     *
+     *   * `user_country_code`: string. Default empty. If set to non-empty, results
+     *      are restricted or boosted based on the location provided.
+     *   * `search_type`: double. Default empty. Enables non-webpage searching
+     *     depending on the value. The only valid non-default value is 1,
+     *     which enables image searching.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
+     *   The query expansion specification that specifies the conditions under which
+     *   query expansion will occur.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
+     *   The spell correction specification that specifies the mode under
+     *   which spell correction will take effect.
+     * @param {string} request.userPseudoId
+     *   A unique identifier for tracking visitors. For example, this could be
+     *   implemented with an HTTP cookie, which should be able to uniquely identify
+     *   a visitor on a single device. This unique identifier should not change if
+     *   the visitor logs in or out of the website.
+     *
+     *   This field should NOT have a fixed value such as `unknown_visitor`.
+     *
+     *   This should be the same identifier as
+     *   {@link google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
+     *   and
+     *   {@link google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
+     *
+     *   The field must be a UTF-8 encoded string with a length limit of 128
+     *   characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
+     *   The content search spec that configs the desired behavior of content
+     *   search.
+     * @param {boolean} request.safeSearch
+     *   Whether to turn on safe search. This is only supported for
+     *   {@link |ContentConfig.PUBLIC_WEBSITE}.
+     * @param {number[]} request.userLabels
+     *   The user labels applied to a resource must meet the following requirements:
+     *
+     *   * Each resource can have multiple labels, up to a maximum of 64.
+     *   * Each label must be a key-value pair.
+     *   * Keys have a minimum length of 1 character and a maximum length of 63
+     *     characters and cannot be empty. Values can be empty and have a maximum
+     *     length of 63 characters.
+     *   * Keys and values can contain only lowercase letters, numeric characters,
+     *     underscores, and dashes. All characters must use UTF-8 encoding, and
+     *     international characters are allowed.
+     *   * The key portion of a label must be unique. However, you can use the same
+     *     key with multiple resources.
+     *   * Keys must start with a lowercase letter or international character.
+     *
+     *   See [Google Cloud
+     *   Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+     *   for more details.
+     * @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 google.cloud.discoveryengine.v1.SearchResponse.SearchResult | SearchResult} 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 `searchAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   for more details and examples.
+     */
+    searchStream(request?: protos.google.cloud.discoveryengine.v1.ISearchRequest, options?: CallOptions): Transform;
+    /**
+     * Equivalent to `search`, 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.servingConfig
+     *   Required. The resource name of the Search serving config, such as
+     *   `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
+     *   This field is used to identify the serving configuration name, set
+     *   of models used to make the search.
+     * @param {string} request.branch
+     *   The branch resource name, such as
+     *   `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
+     *
+     *   Use `default_branch` as the branch ID or leave this field empty, to search
+     *   documents under the default branch.
+     * @param {string} request.query
+     *   Raw search query.
+     * @param {number} request.pageSize
+     *   Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
+     *   return. If unspecified, defaults to a reasonable value. The maximum allowed
+     *   value is 100. Values above 100 will be coerced to 100.
+     *
+     *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+     * @param {string} request.pageToken
+     *   A page token received from a previous
+     *   {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
+     *   call. Provide this to retrieve the subsequent page.
+     *
+     *   When paginating, all other parameters provided to
+     *   {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
+     *   must match the call that provided the page token. Otherwise, an
+     *    `INVALID_ARGUMENT`  error is returned.
+     * @param {number} request.offset
+     *   A 0-indexed integer that specifies the current offset (that is, starting
+     *   result location, amongst the
+     *   {@link google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
+     *   relevant) in search results. This field is only considered if
+     *   {@link google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
+     *   unset.
+     *
+     *   If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+     * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
+     *   Information about the end user.
+     *   Highly recommended for analytics. The user_agent string in UserInfo will
+     *   be used to deduce device_type for analytics.
+     * @param {number[]} request.params
+     *   Additional search parameters.
+     *
+     *   For public website search only, supported values are:
+     *
+     *   * `user_country_code`: string. Default empty. If set to non-empty, results
+     *      are restricted or boosted based on the location provided.
+     *   * `search_type`: double. Default empty. Enables non-webpage searching
+     *     depending on the value. The only valid non-default value is 1,
+     *     which enables image searching.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
+     *   The query expansion specification that specifies the conditions under which
+     *   query expansion will occur.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
+     *   The spell correction specification that specifies the mode under
+     *   which spell correction will take effect.
+     * @param {string} request.userPseudoId
+     *   A unique identifier for tracking visitors. For example, this could be
+     *   implemented with an HTTP cookie, which should be able to uniquely identify
+     *   a visitor on a single device. This unique identifier should not change if
+     *   the visitor logs in or out of the website.
+     *
+     *   This field should NOT have a fixed value such as `unknown_visitor`.
+     *
+     *   This should be the same identifier as
+     *   {@link google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
+     *   and
+     *   {@link google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
+     *
+     *   The field must be a UTF-8 encoded string with a length limit of 128
+     *   characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
+     *   The content search spec that configs the desired behavior of content
+     *   search.
+     * @param {boolean} request.safeSearch
+     *   Whether to turn on safe search. This is only supported for
+     *   {@link |ContentConfig.PUBLIC_WEBSITE}.
+     * @param {number[]} request.userLabels
+     *   The user labels applied to a resource must meet the following requirements:
+     *
+     *   * Each resource can have multiple labels, up to a maximum of 64.
+     *   * Each label must be a key-value pair.
+     *   * Keys have a minimum length of 1 character and a maximum length of 63
+     *     characters and cannot be empty. Values can be empty and have a maximum
+     *     length of 63 characters.
+     *   * Keys and values can contain only lowercase letters, numeric characters,
+     *     underscores, and dashes. All characters must use UTF-8 encoding, and
+     *     international characters are allowed.
+     *   * The key portion of a label must be unique. However, you can use the same
+     *     key with multiple resources.
+     *   * Keys must start with a lowercase letter or international character.
+     *
+     *   See [Google Cloud
+     *   Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+     *   for more details.
+     * @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 [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
+     *   When you iterate the returned iterable, each element will be an object representing
+     *   {@link google.cloud.discoveryengine.v1.SearchResponse.SearchResult | SearchResult}. 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
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/search_service.search.js</caption>
+     * region_tag:discoveryengine_v1_generated_SearchService_Search_async
+     */
+    searchAsync(request?: protos.google.cloud.discoveryengine.v1.ISearchRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.SearchResponse.ISearchResult>;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreBranch resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} branch
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreBranchPath(project: string, location: string, collection: string, dataStore: string, branch: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreBranch resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchName
+     *   A fully-qualified path representing project_location_collection_data_store_branch resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreBranch resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchName
+     *   A fully-qualified path representing project_location_collection_data_store_branch resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreBranch resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchName
+     *   A fully-qualified path representing project_location_collection_data_store_branch resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreBranch resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchName
+     *   A fully-qualified path representing project_location_collection_data_store_branch resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;
+    /**
+     * Parse the branch from ProjectLocationCollectionDataStoreBranch resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchName
+     *   A fully-qualified path representing project_location_collection_data_store_branch resource.
+     * @returns {string} A string representing the branch.
+     */
+    matchBranchFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} branch
+     * @param {string} document
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document resource.
+     * @returns {string} A string representing the branch.
+     */
+    matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document resource.
+     * @returns {string} A string representing the document.
+     */
+    matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} schema
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSchemaName
+     *   A fully-qualified path representing project_location_collection_data_store_schema resource.
+     * @returns {string} A string representing the schema.
+     */
+    matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} serving_config
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreServingConfigPath(project: string, location: string, collection: string, dataStore: string, servingConfig: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreServingConfigName
+     *   A fully-qualified path representing project_location_collection_data_store_serving_config resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreServingConfigName
+     *   A fully-qualified path representing project_location_collection_data_store_serving_config resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreServingConfigName
+     *   A fully-qualified path representing project_location_collection_data_store_serving_config resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreServingConfigName
+     *   A fully-qualified path representing project_location_collection_data_store_serving_config resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
+    /**
+     * Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreServingConfigName
+     *   A fully-qualified path representing project_location_collection_data_store_serving_config resource.
+     * @returns {string} A string representing the serving_config.
+     */
+    matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreBranch resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} branch
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreBranchPath(project: string, location: string, dataStore: string, branch: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreBranch resource.
+     *
+     * @param {string} projectLocationDataStoreBranchName
+     *   A fully-qualified path representing project_location_data_store_branch resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreBranch resource.
+     *
+     * @param {string} projectLocationDataStoreBranchName
+     *   A fully-qualified path representing project_location_data_store_branch resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreBranch resource.
+     *
+     * @param {string} projectLocationDataStoreBranchName
+     *   A fully-qualified path representing project_location_data_store_branch resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName: string): string | number;
+    /**
+     * Parse the branch from ProjectLocationDataStoreBranch resource.
+     *
+     * @param {string} projectLocationDataStoreBranchName
+     *   A fully-qualified path representing project_location_data_store_branch resource.
+     * @returns {string} A string representing the branch.
+     */
+    matchBranchFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} branch
+     * @param {string} document
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_data_store_branch_document resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_data_store_branch_document resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_data_store_branch_document resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Parse the branch from ProjectLocationDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_data_store_branch_document resource.
+     * @returns {string} A string representing the branch.
+     */
+    matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Parse the document from ProjectLocationDataStoreBranchDocument resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentName
+     *   A fully-qualified path representing project_location_data_store_branch_document resource.
+     * @returns {string} A string representing the document.
+     */
+    matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreSchema resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} schema
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
+    /**
+     * Parse the schema from ProjectLocationDataStoreSchema resource.
+     *
+     * @param {string} projectLocationDataStoreSchemaName
+     *   A fully-qualified path representing project_location_data_store_schema resource.
+     * @returns {string} A string representing the schema.
+     */
+    matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreServingConfig resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} serving_config
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreServingConfigPath(project: string, location: string, dataStore: string, servingConfig: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreServingConfig resource.
+     *
+     * @param {string} projectLocationDataStoreServingConfigName
+     *   A fully-qualified path representing project_location_data_store_serving_config resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreServingConfig resource.
+     *
+     * @param {string} projectLocationDataStoreServingConfigName
+     *   A fully-qualified path representing project_location_data_store_serving_config resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreServingConfig resource.
+     *
+     * @param {string} projectLocationDataStoreServingConfigName
+     *   A fully-qualified path representing project_location_data_store_serving_config resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
+    /**
+     * Parse the serving_config from ProjectLocationDataStoreServingConfig resource.
+     *
+     * @param {string} projectLocationDataStoreServingConfigName
+     *   A fully-qualified path representing project_location_data_store_serving_config resource.
+     * @returns {string} A string representing the serving_config.
+     */
+    matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
+    /**
+     * 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<void>;
+}