@google-cloud/discoveryengine 1.10.0 → 1.12.0

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

@@ -192,6 +192,81 @@ export declare class UserEventServiceClient {
     ]>;
     collectUserEvent(request: protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest, options: CallOptions, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest | null | undefined, {} | null | undefined>): void;
     collectUserEvent(request: protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Deletes permanently all user events specified by the filter provided.
+     * Depending on the number of events specified by the filter, this operation
+     * could take hours or days to complete. To test a filter, use the list
+     * command first.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The resource name of the catalog under which the events are
+     *   created. The format is
+     *   `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
+     * @param {string} request.filter
+     *   Required. The filter string to specify the events to be deleted with a
+     *   length limit of 5,000 characters. The eligible fields for filtering are:
+     *
+     *   * `eventType`: Double quoted
+     *   {@link protos.google.cloud.discoveryengine.v1beta.UserEvent.event_type|UserEvent.event_type}
+     *   string.
+     *   * `eventTime`: in ISO 8601 "zulu" format.
+     *   * `userPseudoId`: Double quoted string. Specifying this will delete all
+     *     events associated with a visitor.
+     *   * `userId`: Double quoted string. Specifying this will delete all events
+     *     associated with a user.
+     *
+     *   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:
+     *     `*`
+     *
+     *   The filtering fields are assumed to have an implicit AND.
+     * @param {boolean} request.force
+     *   The `force` field is currently not supported. Purge user event requests
+     *   will permanently delete all purgeable events. Once the development is
+     *   complete:
+     *   If `force` is set to false, the method will return the expected
+     *   purge count without deleting any user events. This field will default to
+     *   false if not included in the request.
+     * @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
+     *   a long running operation. Its `promise()` method returns a promise
+     *   you can `await` for.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/user_event_service.purge_user_events.js</caption>
+     * region_tag:discoveryengine_v1beta_generated_UserEventService_PurgeUserEvents_async
+     */
+    purgeUserEvents(request?: protos.google.cloud.discoveryengine.v1beta.IPurgeUserEventsRequest, options?: CallOptions): Promise<[
+        LROperation<protos.google.cloud.discoveryengine.v1beta.IPurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1beta.IPurgeUserEventsMetadata>,
+        protos.google.longrunning.IOperation | undefined,
+        {} | undefined
+    ]>;
+    purgeUserEvents(request: protos.google.cloud.discoveryengine.v1beta.IPurgeUserEventsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IPurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1beta.IPurgeUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    purgeUserEvents(request: protos.google.cloud.discoveryengine.v1beta.IPurgeUserEventsRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IPurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1beta.IPurgeUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    /**
+     * Check the status of the long running operation returned by `purgeUserEvents()`.
+     * @param {String} name
+     *   The operation name that will be passed.
+     * @returns {Promise} - The promise which resolves to an object.
+     *   The decoded operation object has result and metadata field to get information from.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/user_event_service.purge_user_events.js</caption>
+     * region_tag:discoveryengine_v1beta_generated_UserEventService_PurgeUserEvents_async
+     */
+    checkPurgeUserEventsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.PurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1beta.PurgeUserEventsMetadata>>;
     /**
      * Bulk import of user events. Request processing might be
      * synchronous. Events that already exist are skipped.
@@ -458,6 +533,39 @@ export declare class UserEventServiceClient {
      * @returns {string} A string representing the engine.
      */
     matchEngineFromEngineName(engineName: string): string | number;
+    /**
+     * Return a fully-qualified evaluation resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} evaluation
+     * @returns {string} Resource name string.
+     */
+    evaluationPath(project: string, location: string, evaluation: string): string;
+    /**
+     * Parse the project from Evaluation resource.
+     *
+     * @param {string} evaluationName
+     *   A fully-qualified path representing Evaluation resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromEvaluationName(evaluationName: string): string | number;
+    /**
+     * Parse the location from Evaluation resource.
+     *
+     * @param {string} evaluationName
+     *   A fully-qualified path representing Evaluation resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromEvaluationName(evaluationName: string): string | number;
+    /**
+     * Parse the evaluation from Evaluation resource.
+     *
+     * @param {string} evaluationName
+     *   A fully-qualified path representing Evaluation resource.
+     * @returns {string} A string representing the evaluation.
+     */
+    matchEvaluationFromEvaluationName(evaluationName: string): string | number;
     /**
      * Return a fully-qualified project resource name string.
      *
@@ -575,6 +683,75 @@ export declare class UserEventServiceClient {
      * @returns {string} A string representing the document.
      */
     matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreBranchDocumentChunk resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} branch
+     * @param {string} document
+     * @param {string} chunk
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreBranchDocumentChunkPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string, chunk: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
+    /**
+     * Parse the branch from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the branch.
+     */
+    matchBranchFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
+    /**
+     * Parse the document from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the document.
+     */
+    matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
+    /**
+     * Parse the chunk from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the chunk.
+     */
+    matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreControl resource name string.
      *
@@ -1424,6 +1601,66 @@ export declare class UserEventServiceClient {
      * @returns {string} A string representing the document.
      */
     matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStoreBranchDocumentChunk resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} branch
+     * @param {string} document
+     * @param {string} chunk
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreBranchDocumentChunkPath(project: string, location: string, dataStore: string, branch: string, document: string, chunk: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
+    /**
+     * Parse the branch from ProjectLocationDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the branch.
+     */
+    matchBranchFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
+    /**
+     * Parse the document from ProjectLocationDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the document.
+     */
+    matchDocumentFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
+    /**
+     * Parse the chunk from ProjectLocationDataStoreBranchDocumentChunk resource.
+     *
+     * @param {string} projectLocationDataStoreBranchDocumentChunkName
+     *   A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
+     * @returns {string} A string representing the chunk.
+     */
+    matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStoreControl resource name string.
      *
@@ -1835,6 +2072,81 @@ export declare class UserEventServiceClient {
      * @returns {string} A string representing the target_site.
      */
     matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
+    /**
+     * Return a fully-qualified sampleQuery resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} sample_query_set
+     * @param {string} sample_query
+     * @returns {string} Resource name string.
+     */
+    sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
+    /**
+     * Parse the project from SampleQuery resource.
+     *
+     * @param {string} sampleQueryName
+     *   A fully-qualified path representing SampleQuery resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
+    /**
+     * Parse the location from SampleQuery resource.
+     *
+     * @param {string} sampleQueryName
+     *   A fully-qualified path representing SampleQuery resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
+    /**
+     * Parse the sample_query_set from SampleQuery resource.
+     *
+     * @param {string} sampleQueryName
+     *   A fully-qualified path representing SampleQuery resource.
+     * @returns {string} A string representing the sample_query_set.
+     */
+    matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
+    /**
+     * Parse the sample_query from SampleQuery resource.
+     *
+     * @param {string} sampleQueryName
+     *   A fully-qualified path representing SampleQuery resource.
+     * @returns {string} A string representing the sample_query.
+     */
+    matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
+    /**
+     * Return a fully-qualified sampleQuerySet resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} sample_query_set
+     * @returns {string} Resource name string.
+     */
+    sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
+    /**
+     * Parse the project from SampleQuerySet resource.
+     *
+     * @param {string} sampleQuerySetName
+     *   A fully-qualified path representing SampleQuerySet resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
+    /**
+     * Parse the location from SampleQuerySet resource.
+     *
+     * @param {string} sampleQuerySetName
+     *   A fully-qualified path representing SampleQuerySet resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
+    /**
+     * Parse the sample_query_set from SampleQuerySet resource.
+     *
+     * @param {string} sampleQuerySetName
+     *   A fully-qualified path representing SampleQuerySet resource.
+     * @returns {string} A string representing the sample_query_set.
+     */
+    matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
     /**
      * Terminate the gRPC channel and close the client.
      *