@google-cloud/discoveryengine 2.1.0 → 2.3.0

package/build/src/v1/completion_service_proto_list.json

@@ -1,6 +1,7 @@
 [
     "../../protos/google/cloud/discoveryengine/v1/answer.proto",
     "../../protos/google/cloud/discoveryengine/v1/chunk.proto",
+    "../../protos/google/cloud/discoveryengine/v1/cmek_config_service.proto",
     "../../protos/google/cloud/discoveryengine/v1/common.proto",
     "../../protos/google/cloud/discoveryengine/v1/completion.proto",
     "../../protos/google/cloud/discoveryengine/v1/completion_service.proto",
@@ -18,6 +19,8 @@
     "../../protos/google/cloud/discoveryengine/v1/engine_service.proto",
     "../../protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto",
     "../../protos/google/cloud/discoveryengine/v1/grounding.proto",
+    "../../protos/google/cloud/discoveryengine/v1/identity_mapping_store.proto",
+    "../../protos/google/cloud/discoveryengine/v1/identity_mapping_store_service.proto",
     "../../protos/google/cloud/discoveryengine/v1/import_config.proto",
     "../../protos/google/cloud/discoveryengine/v1/project.proto",
     "../../protos/google/cloud/discoveryengine/v1/project_service.proto",
@@ -35,5 +38,7 @@
     "../../protos/google/cloud/discoveryengine/v1/site_search_engine.proto",
     "../../protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto",
     "../../protos/google/cloud/discoveryengine/v1/user_event.proto",
-    "../../protos/google/cloud/discoveryengine/v1/user_event_service.proto"
+    "../../protos/google/cloud/discoveryengine/v1/user_event_service.proto",
+    "../../protos/google/cloud/discoveryengine/v1/user_license.proto",
+    "../../protos/google/cloud/discoveryengine/v1/user_license_service.proto"
 ]

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

@@ -246,40 +246,40 @@ export declare class ControlServiceClient {
     getControl(request: protos.google.cloud.discoveryengine.v1.IGetControlRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IControl, protos.google.cloud.discoveryengine.v1.IGetControlRequest | null | undefined, {} | null | undefined>): void;
     getControl(request: protos.google.cloud.discoveryengine.v1.IGetControlRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.IControl, protos.google.cloud.discoveryengine.v1.IGetControlRequest | null | undefined, {} | null | undefined>): void;
     /**
-     * Lists all Controls by their parent
-     * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}.
-     *
-     * @param {Object} request
-     *   The request object that will be sent.
-     * @param {string} request.parent
-     *   Required. The data store resource name. Format:
-     *   `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
-     *   or
-     *   `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
-     * @param {number} [request.pageSize]
-     *   Optional. Maximum number of results to return. If unspecified, defaults
-     *   to 50. Max allowed value is 1000.
-     * @param {string} [request.pageToken]
-     *   Optional. A page token, received from a previous `ListControls` call.
-     *   Provide this to retrieve the subsequent page.
-     * @param {string} [request.filter]
-     *   Optional. A filter to apply on the list results. Supported features:
-     *
-     *   * List all the products under the parent branch if
-     *   {@link protos.google.cloud.discoveryengine.v1.ListControlsRequest.filter|filter} is
-     *   unset. Currently this field is unsupported.
-     * @param {object} [options]
-     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
-     * @returns {Promise} - The promise which resolves to an array.
-     *   The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.Control|Control}.
-     *   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 `listControlsAsync()`
-     *   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.
-     */
+    * Lists all Controls by their parent
+    * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}.
+    *
+    * @param {Object} request
+    *   The request object that will be sent.
+    * @param {string} request.parent
+    *   Required. The data store resource name. Format:
+    *   `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
+    *   or
+    *   `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
+    * @param {number} [request.pageSize]
+    *   Optional. Maximum number of results to return. If unspecified, defaults
+    *   to 50. Max allowed value is 1000.
+    * @param {string} [request.pageToken]
+    *   Optional. A page token, received from a previous `ListControls` call.
+    *   Provide this to retrieve the subsequent page.
+    * @param {string} [request.filter]
+    *   Optional. A filter to apply on the list results. Supported features:
+    *
+    *   * List all the products under the parent branch if
+    *   {@link protos.google.cloud.discoveryengine.v1.ListControlsRequest.filter|filter} is
+    *   unset. Currently this field is unsupported.
+    * @param {object} [options]
+    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+    * @returns {Promise} - The promise which resolves to an array.
+    *   The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.Control|Control}.
+    *   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 `listControlsAsync()`
+    *   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.
+    */
     listControls(request?: protos.google.cloud.discoveryengine.v1.IListControlsRequest, options?: CallOptions): Promise<[
         protos.google.cloud.discoveryengine.v1.IControl[],
         protos.google.cloud.discoveryengine.v1.IListControlsRequest | null,
@@ -357,55 +357,55 @@ export declare class ControlServiceClient {
      */
     listControlsAsync(request?: protos.google.cloud.discoveryengine.v1.IListControlsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.IControl>;
     /**
-     * Gets information about a location.
-     *
-     * @param {Object} request
-     *   The request object that will be sent.
-     * @param {string} request.name
-     *   Resource name for the location.
-     * @param {object} [options]
-     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
-     * @returns {Promise} - The promise which resolves to an array.
-     *   The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
-     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
-     *   for more details and examples.
-     * @example
-     * ```
-     * const [response] = await client.getLocation(request);
-     * ```
-     */
+       * Gets information about a location.
+       *
+       * @param {Object} request
+       *   The request object that will be sent.
+       * @param {string} request.name
+       *   Resource name for the location.
+       * @param {object} [options]
+       *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
+       * @returns {Promise} - The promise which resolves to an array.
+       *   The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
+       *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+       *   for more details and examples.
+       * @example
+       * ```
+       * const [response] = await client.getLocation(request);
+       * ```
+       */
     getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
     /**
-     * Lists information about the supported locations for this service. Returns an iterable object.
-     *
-     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
-     * @param {Object} request
-     *   The request object that will be sent.
-     * @param {string} request.name
-     *   The resource that owns the locations collection, if applicable.
-     * @param {string} request.filter
-     *   The standard list filter.
-     * @param {number} request.pageSize
-     *   The standard list page size.
-     * @param {string} request.pageToken
-     *   The standard list page token.
-     * @param {object} [options]
-     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
-     * @returns {Object}
-     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
-     *   When you iterate the returned iterable, each element will be an object representing
-     *   {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
-     *   so you can stop the iteration when you don't need more results.
-     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
-     *   for more details and examples.
-     * @example
-     * ```
-     * const iterable = client.listLocationsAsync(request);
-     * for await (const response of iterable) {
-     *   // process response
-     * }
-     * ```
-     */
+       * Lists information about the supported locations for this service. Returns an iterable object.
+       *
+       * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+       * @param {Object} request
+       *   The request object that will be sent.
+       * @param {string} request.name
+       *   The resource that owns the locations collection, if applicable.
+       * @param {string} request.filter
+       *   The standard list filter.
+       * @param {number} request.pageSize
+       *   The standard list page size.
+       * @param {string} request.pageToken
+       *   The standard list page token.
+       * @param {object} [options]
+       *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+       * @returns {Object}
+       *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
+       *   When you iterate the returned iterable, each element will be an object representing
+       *   {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
+       *   so you can stop the iteration when you don't need more results.
+       *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+       *   for more details and examples.
+       * @example
+       * ```
+       * const iterable = client.listLocationsAsync(request);
+       * for await (const response of iterable) {
+       *   // process response
+       * }
+       * ```
+       */
     listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
     /**
      * Return a fully-qualified engine resource name string.
@@ -449,6 +449,39 @@ export declare class ControlServiceClient {
      * @returns {string} A string representing the engine.
      */
     matchEngineFromEngineName(engineName: string): string | number;
+    /**
+     * Return a fully-qualified identityMappingStore resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} identity_mapping_store
+     * @returns {string} Resource name string.
+     */
+    identityMappingStorePath(project: string, location: string, identityMappingStore: string): string;
+    /**
+     * Parse the project from IdentityMappingStore resource.
+     *
+     * @param {string} identityMappingStoreName
+     *   A fully-qualified path representing IdentityMappingStore resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromIdentityMappingStoreName(identityMappingStoreName: string): string | number;
+    /**
+     * Parse the location from IdentityMappingStore resource.
+     *
+     * @param {string} identityMappingStoreName
+     *   A fully-qualified path representing IdentityMappingStore resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromIdentityMappingStoreName(identityMappingStoreName: string): string | number;
+    /**
+     * Parse the identity_mapping_store from IdentityMappingStore resource.
+     *
+     * @param {string} identityMappingStoreName
+     *   A fully-qualified path representing IdentityMappingStore resource.
+     * @returns {string} A string representing the identity_mapping_store.
+     */
+    matchIdentityMappingStoreFromIdentityMappingStoreName(identityMappingStoreName: string): string | number;
     /**
      * Return a fully-qualified location resource name string.
      *
@@ -488,6 +521,63 @@ export declare class ControlServiceClient {
      * @returns {string} A string representing the project.
      */
     matchProjectFromProjectName(projectName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCmekConfig resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @returns {string} Resource name string.
+     */
+    projectLocationCmekConfigPath(project: string, location: string): string;
+    /**
+     * Parse the project from ProjectLocationCmekConfig resource.
+     *
+     * @param {string} projectLocationCmekConfigName
+     *   A fully-qualified path representing project_location_cmekConfig resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCmekConfigName(projectLocationCmekConfigName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCmekConfig resource.
+     *
+     * @param {string} projectLocationCmekConfigName
+     *   A fully-qualified path representing project_location_cmekConfig resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCmekConfigName(projectLocationCmekConfigName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCmekConfigs resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} cmek_config
+     * @returns {string} Resource name string.
+     */
+    projectLocationCmekConfigsPath(project: string, location: string, cmekConfig: string): string;
+    /**
+     * Parse the project from ProjectLocationCmekConfigs resource.
+     *
+     * @param {string} projectLocationCmekConfigsName
+     *   A fully-qualified path representing project_location_cmekConfigs resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCmekConfigs resource.
+     *
+     * @param {string} projectLocationCmekConfigsName
+     *   A fully-qualified path representing project_location_cmekConfigs resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName: string): string | number;
+    /**
+     * Parse the cmek_config from ProjectLocationCmekConfigs resource.
+     *
+     * @param {string} projectLocationCmekConfigsName
+     *   A fully-qualified path representing project_location_cmekConfigs resource.
+     * @returns {string} A string representing the cmek_config.
+     */
+    matchCmekConfigFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStore resource name string.
      *