@google-cloud/discoveryengine 2.0.1 → 2.1.0

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

@@ -127,9 +127,9 @@ export declare class UserEventServiceClient {
      *   {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore} level, the format
      *   is:
      *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
-     *   If the write user event action is applied in {@link protos.|Location} level, for
-     *   example, the event with
-     *   {@link protos.google.cloud.discoveryengine.v1.Document|Document} across multiple
+     *   If the write user event action is applied in
+     *   {@link protos.google.cloud.location.Location|Location} level, for example, the event
+     *   with {@link protos.google.cloud.discoveryengine.v1.Document|Document} across multiple
      *   {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}, the format is:
      *   `projects/{project}/locations/{location}`.
      * @param {google.cloud.discoveryengine.v1.UserEvent} request.userEvent
@@ -163,8 +163,16 @@ export declare class UserEventServiceClient {
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.parent
-     *   Required. The parent DataStore resource name, such as
+     *   Required. The parent resource name.
+     *   If the collect user event action is applied in
+     *   {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore} level, the format
+     *   is:
      *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
+     *   If the collect user event action is applied in
+     *   {@link protos.google.cloud.location.Location|Location} level, for example, the event
+     *   with {@link protos.google.cloud.discoveryengine.v1.Document|Document} across multiple
+     *   {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}, the format is:
+     *   `projects/{project}/locations/{location}`.
      * @param {string} request.userEvent
      *   Required. URL encoded UserEvent proto with a length limit of 2,000,000
      *   characters.
@@ -218,16 +226,20 @@ export declare class UserEventServiceClient {
      *   * `userId`: Double quoted string. Specifying this will delete all events
      *     associated with a user.
      *
+     *   Note: This API only supports purging a max range of 30 days.
+     *
      *   Examples:
      *
      *   * Deleting all events in a time range:
      *     `eventTime > "2012-04-23T18:25:43.511Z"
      *     eventTime < "2012-04-23T18:30:43.511Z"`
-     *   * Deleting specific eventType:
-     *     `eventType = "search"`
-     *   * Deleting all events for a specific visitor:
-     *     `userPseudoId = "visitor1024"`
-     *   * Deleting all events inside a DataStore:
+     *   * Deleting specific eventType in a time range:
+     *     `eventTime > "2012-04-23T18:25:43.511Z"
+     *     eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"`
+     *   * Deleting all events for a specific visitor in a time range:
+     *     `eventTime > "2012-04-23T18:25:43.511Z"
+     *     eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"`
+     *   * Deleting the past 30 days of events inside a DataStore:
      *     `*`
      *
      *   The filtering fields are assumed to have an implicit AND.
@@ -966,6 +978,57 @@ export declare class UserEventServiceClient {
      * @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 projectLocationCollectionDataStoreSession resource name string.
      *
@@ -1119,6 +1182,57 @@ export declare class UserEventServiceClient {
      * @returns {string} A string representing the data_store.
      */
     matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineSitemap resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} sitemap
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreSiteSearchEngineSitemapPath(project: string, location: string, collection: string, dataStore: string, sitemap: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the sitemap from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the sitemap.
+     */
+    matchSitemapFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
      *
@@ -1272,6 +1386,57 @@ export declare class UserEventServiceClient {
      * @returns {string} A string representing the conversation.
      */
     matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} engine
+     * @param {string} serving_config
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionEngineServingConfigPath(project: string, location: string, collection: string, engine: string, servingConfig: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionEngineServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionEngineServingConfigName
+     *   A fully-qualified path representing project_location_collection_engine_serving_config resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionEngineServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionEngineServingConfigName
+     *   A fully-qualified path representing project_location_collection_engine_serving_config resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionEngineServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionEngineServingConfigName
+     *   A fully-qualified path representing project_location_collection_engine_serving_config resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
+    /**
+     * Parse the engine from ProjectLocationCollectionEngineServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionEngineServingConfigName
+     *   A fully-qualified path representing project_location_collection_engine_serving_config resource.
+     * @returns {string} A string representing the engine.
+     */
+    matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
+    /**
+     * Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.
+     *
+     * @param {string} projectLocationCollectionEngineServingConfigName
+     *   A fully-qualified path representing project_location_collection_engine_serving_config resource.
+     * @returns {string} A string representing the serving_config.
+     */
+    matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionEngineSession resource name string.
      *
@@ -1728,6 +1893,48 @@ export declare class UserEventServiceClient {
      * @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;
     /**
      * Return a fully-qualified projectLocationDataStoreSession resource name string.
      *
@@ -1854,6 +2061,48 @@ export declare class UserEventServiceClient {
      * @returns {string} A string representing the data_store.
      */
     matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreSiteSearchEngineSitemap resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} sitemap
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreSiteSearchEngineSitemapPath(project: string, location: string, dataStore: string, sitemap: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
+    /**
+     * Parse the sitemap from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the sitemap.
+     */
+    matchSitemapFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
      *