@google-cloud/retail/build/src/v2/catalog_service_client.d.ts

Retail client for Node.js

import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
 *  Service for managing catalog configuration.
 * @class
 * @memberof v2
 */
export declare class CatalogServiceClient {
    private _terminated;
    private _opts;
    private _providedCustomServicePath;
    private _gaxModule;
    private _gaxGrpc;
    private _protos;
    private _defaults;
    private _universeDomain;
    private _servicePath;
    private _log;
    auth: gax.GoogleAuth;
    descriptors: Descriptors;
    warn: (code: string, message: string, warnType?: string) => void;
    innerApiCalls: {
        [name: string]: Function;
    };
    locationsClient: LocationsClient;
    pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
    operationsClient: gax.OperationsClient;
    catalogServiceStub?: Promise<{
        [name: string]: Function;
    }>;
    /**
     * Construct an instance of CatalogServiceClient.
     *
     * @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://cloud.google.com/docs/authentication/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 CatalogServiceClient({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<string>;
    getProjectId(callback: Callback<string, undefined, undefined>): void;
    /**
     * Updates the {@link protos.google.cloud.retail.v2.Catalog|Catalog}s.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {google.cloud.retail.v2.Catalog} request.catalog
     *   Required. The {@link protos.google.cloud.retail.v2.Catalog|Catalog} to update.
     *
     *   If the caller does not have permission to update the
     *   {@link protos.google.cloud.retail.v2.Catalog|Catalog}, regardless of whether or not it
     *   exists, a PERMISSION_DENIED error is returned.
     *
     *   If the {@link protos.google.cloud.retail.v2.Catalog|Catalog} to update does not exist,
     *   a NOT_FOUND error is returned.
     * @param {google.protobuf.FieldMask} request.updateMask
     *   Indicates which fields in the provided
     *   {@link protos.google.cloud.retail.v2.Catalog|Catalog} to update.
     *
     *   If an unsupported or unknown field is provided, 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 an object representing {@link protos.google.cloud.retail.v2.Catalog|Catalog}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v2/catalog_service.update_catalog.js</caption>
     * region_tag:retail_v2_generated_CatalogService_UpdateCatalog_async
     */
    updateCatalog(request?: protos.google.cloud.retail.v2.IUpdateCatalogRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2.ICatalog,
        protos.google.cloud.retail.v2.IUpdateCatalogRequest | undefined,
        {} | undefined
    ]>;
    updateCatalog(request: protos.google.cloud.retail.v2.IUpdateCatalogRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2.ICatalog, protos.google.cloud.retail.v2.IUpdateCatalogRequest | null | undefined, {} | null | undefined>): void;
    updateCatalog(request: protos.google.cloud.retail.v2.IUpdateCatalogRequest, callback: Callback<protos.google.cloud.retail.v2.ICatalog, protos.google.cloud.retail.v2.IUpdateCatalogRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Set a specified branch id as default branch. API methods such as
     * {@link protos.google.cloud.retail.v2.SearchService.Search|SearchService.Search},
     * {@link protos.google.cloud.retail.v2.ProductService.GetProduct|ProductService.GetProduct},
     * {@link protos.google.cloud.retail.v2.ProductService.ListProducts|ProductService.ListProducts}
     * will treat requests using "default_branch" to the actual branch id set as
     * default.
     *
     * For example, if `projects/* /locations/* /catalogs/* /branches/1` is set as
     * default, setting
     * {@link protos.google.cloud.retail.v2.SearchRequest.branch|SearchRequest.branch} to
     * `projects/* /locations/* /catalogs/* /branches/default_branch` is equivalent
     * to setting
     * {@link protos.google.cloud.retail.v2.SearchRequest.branch|SearchRequest.branch} to
     * `projects/* /locations/* /catalogs/* /branches/1`.
     *
     * Using multiple branches can be useful when developers would like
     * to have a staging branch to test and verify for future usage. When it
     * becomes ready, developers switch on the staging branch using this API
     * while keeping using
     * `projects/* /locations/* /catalogs/* /branches/default_branch` as
     * {@link protos.google.cloud.retail.v2.SearchRequest.branch|SearchRequest.branch} to
     * route the traffic to this staging branch.
     *
     * CAUTION: If you have live predict/search traffic, switching the default
     * branch could potentially cause outages if the ID space of the new branch
     * is very different from the old one.
     *
     * More specifically:
     *
     * * PredictionService will only return product IDs from branch {newBranch}.
     * * SearchService will only return product IDs from branch {newBranch}
     *   (if branch is not explicitly set).
     * * UserEventService will only join events with products from branch
     *   {newBranch}.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.catalog
     *   Full resource name of the catalog, such as
     *   `projects/* /locations/global/catalogs/default_catalog`.
     * @param {string} request.branchId
     *   The final component of the resource name of a branch.
     *
     *   This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT
     *   error is returned.
     *
     *   If there are no sufficient active products in the targeted branch and
     *   {@link protos.google.cloud.retail.v2.SetDefaultBranchRequest.force|force} is not set, a
     *   FAILED_PRECONDITION error is returned.
     * @param {string} request.note
     *   Some note on this request, this can be retrieved by
     *   {@link protos.google.cloud.retail.v2.CatalogService.GetDefaultBranch|CatalogService.GetDefaultBranch}
     *   before next valid default branch set occurs.
     *
     *   This field must be a UTF-8 encoded string with a length limit of 1,000
     *   characters. Otherwise, an INVALID_ARGUMENT error is returned.
     * @param {boolean} request.force
     *   If set to true, it permits switching to a branch with
     *   {@link protos.google.cloud.retail.v2.SetDefaultBranchRequest.branch_id|branch_id} even
     *   if it has no sufficient active products.
     * @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 <caption>include:samples/generated/v2/catalog_service.set_default_branch.js</caption>
     * region_tag:retail_v2_generated_CatalogService_SetDefaultBranch_async
     */
    setDefaultBranch(request?: protos.google.cloud.retail.v2.ISetDefaultBranchRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.retail.v2.ISetDefaultBranchRequest | undefined,
        {} | undefined
    ]>;
    setDefaultBranch(request: protos.google.cloud.retail.v2.ISetDefaultBranchRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.retail.v2.ISetDefaultBranchRequest | null | undefined, {} | null | undefined>): void;
    setDefaultBranch(request: protos.google.cloud.retail.v2.ISetDefaultBranchRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.retail.v2.ISetDefaultBranchRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Get which branch is currently default branch set by
     * {@link protos.google.cloud.retail.v2.CatalogService.SetDefaultBranch|CatalogService.SetDefaultBranch}
     * method under a specified parent catalog.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.catalog
     *   The parent catalog resource name, such as
     *   `projects/* /locations/global/catalogs/default_catalog`.
     * @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.cloud.retail.v2.GetDefaultBranchResponse|GetDefaultBranchResponse}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v2/catalog_service.get_default_branch.js</caption>
     * region_tag:retail_v2_generated_CatalogService_GetDefaultBranch_async
     */
    getDefaultBranch(request?: protos.google.cloud.retail.v2.IGetDefaultBranchRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2.IGetDefaultBranchResponse,
        protos.google.cloud.retail.v2.IGetDefaultBranchRequest | undefined,
        {} | undefined
    ]>;
    getDefaultBranch(request: protos.google.cloud.retail.v2.IGetDefaultBranchRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2.IGetDefaultBranchResponse, protos.google.cloud.retail.v2.IGetDefaultBranchRequest | null | undefined, {} | null | undefined>): void;
    getDefaultBranch(request: protos.google.cloud.retail.v2.IGetDefaultBranchRequest, callback: Callback<protos.google.cloud.retail.v2.IGetDefaultBranchResponse, protos.google.cloud.retail.v2.IGetDefaultBranchRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Gets a {@link protos.google.cloud.retail.v2.CompletionConfig|CompletionConfig}.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Full CompletionConfig resource name. Format:
     *   `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig`
     * @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.cloud.retail.v2.CompletionConfig|CompletionConfig}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v2/catalog_service.get_completion_config.js</caption>
     * region_tag:retail_v2_generated_CatalogService_GetCompletionConfig_async
     */
    getCompletionConfig(request?: protos.google.cloud.retail.v2.IGetCompletionConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2.ICompletionConfig,
        protos.google.cloud.retail.v2.IGetCompletionConfigRequest | undefined,
        {} | undefined
    ]>;
    getCompletionConfig(request: protos.google.cloud.retail.v2.IGetCompletionConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2.ICompletionConfig, protos.google.cloud.retail.v2.IGetCompletionConfigRequest | null | undefined, {} | null | undefined>): void;
    getCompletionConfig(request: protos.google.cloud.retail.v2.IGetCompletionConfigRequest, callback: Callback<protos.google.cloud.retail.v2.ICompletionConfig, protos.google.cloud.retail.v2.IGetCompletionConfigRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Updates the {@link protos.google.cloud.retail.v2.CompletionConfig|CompletionConfig}s.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {google.cloud.retail.v2.CompletionConfig} request.completionConfig
     *   Required. The {@link protos.google.cloud.retail.v2.CompletionConfig|CompletionConfig}
     *   to update.
     *
     *   If the caller does not have permission to update the
     *   {@link protos.google.cloud.retail.v2.CompletionConfig|CompletionConfig}, then a
     *   PERMISSION_DENIED error is returned.
     *
     *   If the {@link protos.google.cloud.retail.v2.CompletionConfig|CompletionConfig} to
     *   update does not exist, a NOT_FOUND error is returned.
     * @param {google.protobuf.FieldMask} request.updateMask
     *   Indicates which fields in the provided
     *   {@link protos.google.cloud.retail.v2.CompletionConfig|CompletionConfig} to update. The
     *   following are the only supported fields:
     *
     *   * {@link protos.google.cloud.retail.v2.CompletionConfig.matching_order|CompletionConfig.matching_order}
     *   * {@link protos.google.cloud.retail.v2.CompletionConfig.max_suggestions|CompletionConfig.max_suggestions}
     *   * {@link protos.google.cloud.retail.v2.CompletionConfig.min_prefix_length|CompletionConfig.min_prefix_length}
     *   * {@link protos.google.cloud.retail.v2.CompletionConfig.auto_learning|CompletionConfig.auto_learning}
     *
     *   If not set, all supported fields are updated.
     * @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.cloud.retail.v2.CompletionConfig|CompletionConfig}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v2/catalog_service.update_completion_config.js</caption>
     * region_tag:retail_v2_generated_CatalogService_UpdateCompletionConfig_async
     */
    updateCompletionConfig(request?: protos.google.cloud.retail.v2.IUpdateCompletionConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2.ICompletionConfig,
        protos.google.cloud.retail.v2.IUpdateCompletionConfigRequest | undefined,
        {} | undefined
    ]>;
    updateCompletionConfig(request: protos.google.cloud.retail.v2.IUpdateCompletionConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2.ICompletionConfig, protos.google.cloud.retail.v2.IUpdateCompletionConfigRequest | null | undefined, {} | null | undefined>): void;
    updateCompletionConfig(request: protos.google.cloud.retail.v2.IUpdateCompletionConfigRequest, callback: Callback<protos.google.cloud.retail.v2.ICompletionConfig, protos.google.cloud.retail.v2.IUpdateCompletionConfigRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Gets an {@link protos.google.cloud.retail.v2.AttributesConfig|AttributesConfig}.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.name
     *   Required. Full AttributesConfig resource name. Format:
     *   `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
     * @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.cloud.retail.v2.AttributesConfig|AttributesConfig}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v2/catalog_service.get_attributes_config.js</caption>
     * region_tag:retail_v2_generated_CatalogService_GetAttributesConfig_async
     */
    getAttributesConfig(request?: protos.google.cloud.retail.v2.IGetAttributesConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2.IAttributesConfig,
        protos.google.cloud.retail.v2.IGetAttributesConfigRequest | undefined,
        {} | undefined
    ]>;
    getAttributesConfig(request: protos.google.cloud.retail.v2.IGetAttributesConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2.IAttributesConfig, protos.google.cloud.retail.v2.IGetAttributesConfigRequest | null | undefined, {} | null | undefined>): void;
    getAttributesConfig(request: protos.google.cloud.retail.v2.IGetAttributesConfigRequest, callback: Callback<protos.google.cloud.retail.v2.IAttributesConfig, protos.google.cloud.retail.v2.IGetAttributesConfigRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Updates the {@link protos.google.cloud.retail.v2.AttributesConfig|AttributesConfig}.
     *
     * The catalog attributes in the request will be updated in the catalog, or
     * inserted if they do not exist. Existing catalog attributes not included in
     * the request will remain unchanged. Attributes that are assigned to
     * products, but do not exist at the catalog level, are always included in the
     * response. The product attribute is assigned default values for missing
     * catalog attribute fields, e.g., searchable and dynamic facetable options.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {google.cloud.retail.v2.AttributesConfig} request.attributesConfig
     *   Required. The {@link protos.google.cloud.retail.v2.AttributesConfig|AttributesConfig}
     *   to update.
     * @param {google.protobuf.FieldMask} request.updateMask
     *   Indicates which fields in the provided
     *   {@link protos.google.cloud.retail.v2.AttributesConfig|AttributesConfig} to update. The
     *   following is the only supported field:
     *
     *   * {@link protos.google.cloud.retail.v2.AttributesConfig.catalog_attributes|AttributesConfig.catalog_attributes}
     *
     *   If not set, all supported fields are updated.
     * @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.cloud.retail.v2.AttributesConfig|AttributesConfig}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v2/catalog_service.update_attributes_config.js</caption>
     * region_tag:retail_v2_generated_CatalogService_UpdateAttributesConfig_async
     */
    updateAttributesConfig(request?: protos.google.cloud.retail.v2.IUpdateAttributesConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2.IAttributesConfig,
        protos.google.cloud.retail.v2.IUpdateAttributesConfigRequest | undefined,
        {} | undefined
    ]>;
    updateAttributesConfig(request: protos.google.cloud.retail.v2.IUpdateAttributesConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2.IAttributesConfig, protos.google.cloud.retail.v2.IUpdateAttributesConfigRequest | null | undefined, {} | null | undefined>): void;
    updateAttributesConfig(request: protos.google.cloud.retail.v2.IUpdateAttributesConfigRequest, callback: Callback<protos.google.cloud.retail.v2.IAttributesConfig, protos.google.cloud.retail.v2.IUpdateAttributesConfigRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Adds the specified
     * {@link protos.google.cloud.retail.v2.CatalogAttribute|CatalogAttribute} to the
     * {@link protos.google.cloud.retail.v2.AttributesConfig|AttributesConfig}.
     *
     * If the {@link protos.google.cloud.retail.v2.CatalogAttribute|CatalogAttribute} to add
     * already exists, an ALREADY_EXISTS error is returned.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.attributesConfig
     *   Required. Full AttributesConfig resource name. Format:
     *   `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
     * @param {google.cloud.retail.v2.CatalogAttribute} request.catalogAttribute
     *   Required. The {@link protos.google.cloud.retail.v2.CatalogAttribute|CatalogAttribute}
     *   to add.
     * @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.cloud.retail.v2.AttributesConfig|AttributesConfig}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v2/catalog_service.add_catalog_attribute.js</caption>
     * region_tag:retail_v2_generated_CatalogService_AddCatalogAttribute_async
     */
    addCatalogAttribute(request?: protos.google.cloud.retail.v2.IAddCatalogAttributeRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2.IAttributesConfig,
        protos.google.cloud.retail.v2.IAddCatalogAttributeRequest | undefined,
        {} | undefined
    ]>;
    addCatalogAttribute(request: protos.google.cloud.retail.v2.IAddCatalogAttributeRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2.IAttributesConfig, protos.google.cloud.retail.v2.IAddCatalogAttributeRequest | null | undefined, {} | null | undefined>): void;
    addCatalogAttribute(request: protos.google.cloud.retail.v2.IAddCatalogAttributeRequest, callback: Callback<protos.google.cloud.retail.v2.IAttributesConfig, protos.google.cloud.retail.v2.IAddCatalogAttributeRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Removes the specified
     * {@link protos.google.cloud.retail.v2.CatalogAttribute|CatalogAttribute} from the
     * {@link protos.google.cloud.retail.v2.AttributesConfig|AttributesConfig}.
     *
     * If the {@link protos.google.cloud.retail.v2.CatalogAttribute|CatalogAttribute} to
     * remove does not exist, a NOT_FOUND error is returned.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.attributesConfig
     *   Required. Full AttributesConfig resource name. Format:
     *   `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
     * @param {string} request.key
     *   Required. The attribute name key of the
     *   {@link protos.google.cloud.retail.v2.CatalogAttribute|CatalogAttribute} to remove.
     * @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.cloud.retail.v2.AttributesConfig|AttributesConfig}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v2/catalog_service.remove_catalog_attribute.js</caption>
     * region_tag:retail_v2_generated_CatalogService_RemoveCatalogAttribute_async
     */
    removeCatalogAttribute(request?: protos.google.cloud.retail.v2.IRemoveCatalogAttributeRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2.IAttributesConfig,
        protos.google.cloud.retail.v2.IRemoveCatalogAttributeRequest | undefined,
        {} | undefined
    ]>;
    removeCatalogAttribute(request: protos.google.cloud.retail.v2.IRemoveCatalogAttributeRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2.IAttributesConfig, protos.google.cloud.retail.v2.IRemoveCatalogAttributeRequest | null | undefined, {} | null | undefined>): void;
    removeCatalogAttribute(request: protos.google.cloud.retail.v2.IRemoveCatalogAttributeRequest, callback: Callback<protos.google.cloud.retail.v2.IAttributesConfig, protos.google.cloud.retail.v2.IRemoveCatalogAttributeRequest | null | undefined, {} | null | undefined>): void;
    /**
     * Replaces the specified
     * {@link protos.google.cloud.retail.v2.CatalogAttribute|CatalogAttribute} in the
     * {@link protos.google.cloud.retail.v2.AttributesConfig|AttributesConfig} by updating the
     * catalog attribute with the same
     * {@link protos.google.cloud.retail.v2.CatalogAttribute.key|CatalogAttribute.key}.
     *
     * If the {@link protos.google.cloud.retail.v2.CatalogAttribute|CatalogAttribute} to
     * replace does not exist, a NOT_FOUND error is returned.
     *
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.attributesConfig
     *   Required. Full AttributesConfig resource name. Format:
     *   `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
     * @param {google.cloud.retail.v2.CatalogAttribute} request.catalogAttribute
     *   Required. The updated
     *   {@link protos.google.cloud.retail.v2.CatalogAttribute|CatalogAttribute}.
     * @param {google.protobuf.FieldMask} request.updateMask
     *   Indicates which fields in the provided
     *   {@link protos.google.cloud.retail.v2.CatalogAttribute|CatalogAttribute} to update. The
     *   following are NOT supported:
     *
     *   * {@link protos.google.cloud.retail.v2.CatalogAttribute.key|CatalogAttribute.key}
     *
     *   If not set, all supported fields are updated.
     * @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.cloud.retail.v2.AttributesConfig|AttributesConfig}.
     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
     *   for more details and examples.
     * @example <caption>include:samples/generated/v2/catalog_service.replace_catalog_attribute.js</caption>
     * region_tag:retail_v2_generated_CatalogService_ReplaceCatalogAttribute_async
     */
    replaceCatalogAttribute(request?: protos.google.cloud.retail.v2.IReplaceCatalogAttributeRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2.IAttributesConfig,
        protos.google.cloud.retail.v2.IReplaceCatalogAttributeRequest | undefined,
        {} | undefined
    ]>;
    replaceCatalogAttribute(request: protos.google.cloud.retail.v2.IReplaceCatalogAttributeRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2.IAttributesConfig, protos.google.cloud.retail.v2.IReplaceCatalogAttributeRequest | null | undefined, {} | null | undefined>): void;
    replaceCatalogAttribute(request: protos.google.cloud.retail.v2.IReplaceCatalogAttributeRequest, callback: Callback<protos.google.cloud.retail.v2.IAttributesConfig, protos.google.cloud.retail.v2.IReplaceCatalogAttributeRequest | null | undefined, {} | null | undefined>): void;
    /**
    * Lists all the {@link protos.google.cloud.retail.v2.Catalog|Catalog}s associated with
    * the project.
    *
    * @param {Object} request
    *   The request object that will be sent.
    * @param {string} request.parent
    *   Required. The account resource name with an associated location.
    *
    *   If the caller does not have permission to list
    *   {@link protos.google.cloud.retail.v2.Catalog|Catalog}s under this location, regardless
    *   of whether or not this location exists, a PERMISSION_DENIED error is
    *   returned.
    * @param {number} request.pageSize
    *   Maximum number of {@link protos.google.cloud.retail.v2.Catalog|Catalog}s to return. If
    *   unspecified, defaults to 50. The maximum allowed value is 1000. Values
    *   above 1000 will be coerced to 1000.
    *
    *   If this field is negative, an INVALID_ARGUMENT is returned.
    * @param {string} request.pageToken
    *   A page token
    *   {@link protos.google.cloud.retail.v2.ListCatalogsResponse.next_page_token|ListCatalogsResponse.next_page_token},
    *   received from a previous
    *   {@link protos.google.cloud.retail.v2.CatalogService.ListCatalogs|CatalogService.ListCatalogs}
    *   call. Provide this to retrieve the subsequent page.
    *
    *   When paginating, all other parameters provided to
    *   {@link protos.google.cloud.retail.v2.CatalogService.ListCatalogs|CatalogService.ListCatalogs}
    *   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.retail.v2.Catalog|Catalog}.
    *   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 `listCatalogsAsync()`
    *   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.
    */
    listCatalogs(request?: protos.google.cloud.retail.v2.IListCatalogsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2.ICatalog[],
        protos.google.cloud.retail.v2.IListCatalogsRequest | null,
        protos.google.cloud.retail.v2.IListCatalogsResponse
    ]>;
    listCatalogs(request: protos.google.cloud.retail.v2.IListCatalogsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.retail.v2.IListCatalogsRequest, protos.google.cloud.retail.v2.IListCatalogsResponse | null | undefined, protos.google.cloud.retail.v2.ICatalog>): void;
    listCatalogs(request: protos.google.cloud.retail.v2.IListCatalogsRequest, callback: PaginationCallback<protos.google.cloud.retail.v2.IListCatalogsRequest, protos.google.cloud.retail.v2.IListCatalogsResponse | null | undefined, protos.google.cloud.retail.v2.ICatalog>): void;
    /**
     * Equivalent to `listCatalogs`, but returns a NodeJS Stream object.
     * @param {Object} request
     *   The request object that will be sent.
     * @param {string} request.parent
     *   Required. The account resource name with an associated location.
     *
     *   If the caller does not have permission to list
     *   {@link protos.google.cloud.retail.v2.Catalog|Catalog}s under this location, regardless
     *   of whether or not this location exists, a PERMISSION_DENIED error is
     *   returned.
     * @param {number} request.pageSize
     *   Maximum number of {@link protos.google.cloud.retail.v2.Catalog|Catalog}s to return. If
     *   unspecified, defaults to 50. The maximum allowed value is 1000. Values
     *   above 1000 will be coerced to 1000.
     *
     *   If this field is negative, an INVALID_ARGUMENT is returned.
     * @param {string} request.pageToken
     *   A page token
     *   {@link protos.google.cloud.retail.v2.ListCatalogsResponse.next_page_token|ListCatalogsResponse.next_page_token},
     *   received from a previous
     *   {@link protos.google.cloud.retail.v2.CatalogService.ListCatalogs|CatalogService.ListCatalogs}
     *   call. Provide this to retrieve the subsequent page.
     *
     *   When paginating, all other parameters provided to
     *   {@link protos.google.cloud.retail.v2.CatalogService.ListCatalogs|CatalogService.ListCatalogs}
     *   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 {Stream}
     *   An object stream which emits an object representing {@link protos.google.cloud.retail.v2.Catalog|Catalog} 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 `listCatalogsAsync()`
     *   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.
     */
    listCatalogsStream(request?: protos.google.cloud.retail.v2.IListCatalogsRequest, options?: CallOptions): Transform;
    /**
     * Equivalent to `listCatalogs`, 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 account resource name with an associated location.
     *
     *   If the caller does not have permission to list
     *   {@link protos.google.cloud.retail.v2.Catalog|Catalog}s under this location, regardless
     *   of whether or not this location exists, a PERMISSION_DENIED error is
     *   returned.
     * @param {number} request.pageSize
     *   Maximum number of {@link protos.google.cloud.retail.v2.Catalog|Catalog}s to return. If
     *   unspecified, defaults to 50. The maximum allowed value is 1000. Values
     *   above 1000 will be coerced to 1000.
     *
     *   If this field is negative, an INVALID_ARGUMENT is returned.
     * @param {string} request.pageToken
     *   A page token
     *   {@link protos.google.cloud.retail.v2.ListCatalogsResponse.next_page_token|ListCatalogsResponse.next_page_token},
     *   received from a previous
     *   {@link protos.google.cloud.retail.v2.CatalogService.ListCatalogs|CatalogService.ListCatalogs}
     *   call. Provide this to retrieve the subsequent page.
     *
     *   When paginating, all other parameters provided to
     *   {@link protos.google.cloud.retail.v2.CatalogService.ListCatalogs|CatalogService.ListCatalogs}
     *   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 {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.cloud.retail.v2.Catalog|Catalog}. 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 <caption>include:samples/generated/v2/catalog_service.list_catalogs.js</caption>
     * region_tag:retail_v2_generated_CatalogService_ListCatalogs_async
     */
    listCatalogsAsync(request?: protos.google.cloud.retail.v2.IListCatalogsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.retail.v2.ICatalog>;
    /**
       * 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
       * }
       * ```
       */
    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)
       * ```
       */
    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
     * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
     *
     * For-await-of syntax is used with the iterable to recursively get response element on-demand.
     *
     * @param {Object} request - The request object that will be sent.
     * @param {string} request.name - The name of the operation collection.
     * @param {string} request.filter - The standard list filter.
     * @param {number=} request.pageSize -
     *   The maximum number of resources contained in the underlying API
     *   response. If page streaming is performed per-resource, this
     *   parameter does not affect the return value. If page streaming is
     *   performed per-page, this determines the maximum number of
     *   resources in a page.
     * @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.
     * @returns {Object}
     *   An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
     *
     * @example
     * ```
     * const client = longrunning.operationsClient();
     * for await (const response of client.listOperationsAsync(request));
     * // doThingsWith(response)
     * ```
     */
    listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;
    /**
     * Starts asynchronous cancellation on a long-running operation.  The server
     * makes a best effort to cancel the operation, but success is not
     * guaranteed.  If the server doesn't support this method, it returns
     * `google.rpc.Code.UNIMPLEMENTED`.  Clients can use
     * {@link Operations.GetOperation} or
     * other methods to check whether the cancellation succeeded or whether the
     * operation completed despite cancellation. On successful cancellation,
     * the operation is not deleted; instead, it becomes an operation with
     * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
     * 1, corresponding to `Code.CANCELLED`.
     *
     * @param {Object} request - The request object that will be sent.
     * @param {string} request.name - The name of the operation resource to be cancelled.
     * @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)=} callback
     *   The function which will be called with the result of the API call.
     * @return {Promise} - The promise which resolves when API call finishes.
     *   The promise has a method named "cancel" which cancels the ongoing API
     * call.
     *
     * @example
     * ```
     * const client = longrunning.operationsClient();
     * await client.cancelOperation({name: ''});
     * ```
     */
    cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.lo