@google-cloud/discoveryengine 0.5.0 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.6.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v0.5.0...discoveryengine-v0.6.0) (2023-05-04)
+
+
+### Features
+
+* [discoveryengine] add document purge API ([#4219](https://github.com/googleapis/google-cloud-node/issues/4219)) ([454fa79](https://github.com/googleapis/google-cloud-node/commit/454fa7943ddf664bc54a67e654d7e8a39ea55fed))
+
 ## [0.5.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v0.4.1...discoveryengine-v0.5.0) (2023-04-24)
 
 

package/README.md

@@ -131,6 +131,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
 | Document_service.get_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.get_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.get_document.js,samples/README.md) |
 | Document_service.import_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.import_documents.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.import_documents.js,samples/README.md) |
 | Document_service.list_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.list_documents.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.list_documents.js,samples/README.md) |
+| Document_service.purge_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.purge_documents.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.purge_documents.js,samples/README.md) |
 | Document_service.update_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.update_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/document_service.update_document.js,samples/README.md) |
 | Recommendation_service.recommend | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/recommendation_service.recommend.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/recommendation_service.recommend.js,samples/README.md) |
 | Schema_service.create_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1beta/schema_service.create_schema.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1beta/schema_service.create_schema.js,samples/README.md) |

package/build/protos/google/cloud/discoveryengine/v1beta/common.proto

@@ -122,6 +122,8 @@ message UserInfo {
   // This should not be set when using the client side event reporting with
   // GTM or JavaScript tag in
   // [UserEventService.CollectUserEvent][google.cloud.discoveryengine.v1beta.UserEventService.CollectUserEvent]
-  // or if [direct_user_request][] is set.
+  // or if
+  // [UserEvent.direct_user_request][google.cloud.discoveryengine.v1beta.UserEvent.direct_user_request]
+  // is set.
   string user_agent = 2;
 }

package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto

@@ -22,6 +22,7 @@ import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/cloud/discoveryengine/v1beta/document.proto";
 import "google/cloud/discoveryengine/v1beta/import_config.proto";
+import "google/cloud/discoveryengine/v1beta/purge_config.proto";
 import "google/longrunning/operations.proto";
 import "google/protobuf/empty.proto";
 
@@ -122,6 +123,39 @@ service DocumentService {
       metadata_type: "google.cloud.discoveryengine.v1beta.ImportDocumentsMetadata"
     };
   }
+
+  // Permanently deletes all selected
+  // [Document][google.cloud.discoveryengine.v1beta.Document]s in a branch.
+  //
+  // This process is asynchronous. Depending on the number of
+  // [Document][google.cloud.discoveryengine.v1beta.Document]s to be deleted,
+  // this operation can take hours to complete. Before the delete operation
+  // completes, some [Document][google.cloud.discoveryengine.v1beta.Document]s
+  // might still be returned by
+  // [DocumentService.GetDocument][google.cloud.discoveryengine.v1beta.DocumentService.GetDocument]
+  // or
+  // [DocumentService.ListDocuments][google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments].
+  //
+  // To get a list of the
+  // [Document][google.cloud.discoveryengine.v1beta.Document]s to be deleted,
+  // set
+  // [PurgeDocumentsRequest.force][google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.force]
+  // to false.
+  rpc PurgeDocuments(PurgeDocumentsRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1beta/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents:purge"
+      body: "*"
+      additional_bindings {
+        post: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents:purge"
+        body: "*"
+      }
+    };
+    option (google.longrunning.operation_info) = {
+      response_type: "google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse"
+      metadata_type: "google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata"
+    };
+  }
 }
 
 // Request message for

package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto

@@ -0,0 +1,86 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.cloud.discoveryengine.v1beta;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "PurgeConfigProto";
+option java_package = "com.google.cloud.discoveryengine.v1beta";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
+
+// Request message for
+// [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments]
+// method.
+message PurgeDocumentsRequest {
+  // Required. The parent resource name, such as
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Branch"
+    }
+  ];
+
+  // Required. Filter matching documents to purge. Only currently supported
+  // value is
+  // `*` (all items).
+  string filter = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Actually performs the purge. If `force` is set to false, return the
+  // expected purge count without deleting any documents.
+  bool force = 3;
+}
+
+// Response message for
+// [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments]
+// method. If the long running operation is successfully done, then this message
+// is returned by the google.longrunning.Operations.response field.
+message PurgeDocumentsResponse {
+  // The total count of documents purged as a result of the operation.
+  int64 purge_count = 1;
+
+  // A sample of document names that will be deleted. Only populated if `force`
+  // is set to false. A max of 100 names will be returned and the names are
+  // chosen at random.
+  repeated string purge_sample = 2 [(google.api.resource_reference) = {
+    type: "discoveryengine.googleapis.com/Document"
+  }];
+}
+
+// Metadata related to the progress of the PurgeDocuments operation.
+// This will be returned by the google.longrunning.Operation.metadata field.
+message PurgeDocumentsMetadata {
+  // Operation create time.
+  google.protobuf.Timestamp create_time = 1;
+
+  // Operation last update time. If the operation is done, this is also the
+  // finish time.
+  google.protobuf.Timestamp update_time = 2;
+
+  // Count of entries that were deleted successfully.
+  int64 success_count = 3;
+
+  // Count of entries that encountered errors while processing.
+  int64 failure_count = 4;
+}

package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto

@@ -114,17 +114,19 @@ message UserEvent {
   // Token to attribute an API response to user action(s) to trigger the event.
   //
   // Highly recommended for user events that are the result of
-  // [PredictionService.Predict][]. This field enables accurate attribution of
-  // recommendation model performance.
+  // [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend].
+  // This field enables accurate attribution of recommendation model
+  // performance.
   //
   // The value must be one of:
   //
   // * [PredictResponse.attribution_token][] for events that are the result of
-  // [PredictionService.Predict][].
+  // [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend].
   // * [SearchResponse.attribution_token][google.cloud.discoveryengine.v1beta.SearchResponse.attribution_token] for events that are the result of
   // [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search].
   // * [CompleteQueryResponse.attribution_token][] for events that are the
-  // result of [SearchService.CompleteQuery][].
+  // result of
+  // [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery].
   //
   // This token enables us to accurately attribute page view or conversion
   // completion back to the event and the particular predict response containing
@@ -138,14 +140,15 @@ message UserEvent {
   // predicate from one or more fields of the documents being filtered.
   //
   // One example is for `search` events, the associated
-  // [SearchService.SearchRequest][] may contain a filter expression in
-  // [SearchService.SearchRequest.filter][] conforming to
-  // https://google.aip.dev/160#filtering.
+  // [SearchRequest][google.cloud.discoveryengine.v1beta.SearchRequest] may
+  // contain a filter expression in
+  // [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter]
+  // conforming to https://google.aip.dev/160#filtering.
   //
   // Similarly, for `view-item-list` events that are generated from a
-  // [PredictionService.PredictRequest][], this field may be populated directly
-  // from [PredictionService.PredictRequest.filter][] conforming to
-  // https://google.aip.dev/160#filtering.
+  // [RecommendationService.RecommendRequest][], this field may be populated
+  // directly from [RecommendationService.RecommendRequest.filter][] conforming
+  // to https://google.aip.dev/160#filtering.
   //
   // The value must be a UTF-8 encoded string with a length limit of 1,000
   // characters. Otherwise, an INVALID_ARGUMENT error is returned.
@@ -284,9 +287,10 @@ message SearchInfo {
   //
   // At least one of
   // [search_query][google.cloud.discoveryengine.v1beta.SearchInfo.search_query]
-  // or [page_categories][] is required for `search` events. Other event types
-  // should not set this field. Otherwise, an INVALID_ARGUMENT error is
-  // returned.
+  // or
+  // [PageInfo.page_category][google.cloud.discoveryengine.v1beta.PageInfo.page_category]
+  // is required for `search` events. Other event types should not set this
+  // field. Otherwise, an INVALID_ARGUMENT error is returned.
   string search_query = 1;
 
   // The order in which products are returned, if applicable.

package/build/protos/protos.d.ts

@@ -1070,6 +1070,20 @@ export namespace google {
                      * @returns Promise
                      */
                     public importDocuments(request: google.cloud.discoveryengine.v1beta.IImportDocumentsRequest): Promise<google.longrunning.Operation>;
+
+                    /**
+                     * Calls PurgeDocuments.
+                     * @param request PurgeDocumentsRequest message or plain object
+                     * @param callback Node-style callback called with the error, if any, and Operation
+                     */
+                    public purgeDocuments(request: google.cloud.discoveryengine.v1beta.IPurgeDocumentsRequest, callback: google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocumentsCallback): void;
+
+                    /**
+                     * Calls PurgeDocuments.
+                     * @param request PurgeDocumentsRequest message or plain object
+                     * @returns Promise
+                     */
+                    public purgeDocuments(request: google.cloud.discoveryengine.v1beta.IPurgeDocumentsRequest): Promise<google.longrunning.Operation>;
                 }
 
                 namespace DocumentService {
@@ -1115,6 +1129,13 @@ export namespace google {
                      * @param [response] Operation
                      */
                     type ImportDocumentsCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
+
+                    /**
+                     * Callback as used by {@link google.cloud.discoveryengine.v1beta.DocumentService|purgeDocuments}.
+                     * @param error Error, if any
+                     * @param [response] Operation
+                     */
+                    type PurgeDocumentsCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
                 }
 
                 /** Properties of a GetDocumentRequest. */
@@ -3993,6 +4014,333 @@ export namespace google {
                     public static getTypeUrl(typeUrlPrefix?: string): string;
                 }
 
+                /** Properties of a PurgeDocumentsRequest. */
+                interface IPurgeDocumentsRequest {
+
+                    /** PurgeDocumentsRequest parent */
+                    parent?: (string|null);
+
+                    /** PurgeDocumentsRequest filter */
+                    filter?: (string|null);
+
+                    /** PurgeDocumentsRequest force */
+                    force?: (boolean|null);
+                }
+
+                /** Represents a PurgeDocumentsRequest. */
+                class PurgeDocumentsRequest implements IPurgeDocumentsRequest {
+
+                    /**
+                     * Constructs a new PurgeDocumentsRequest.
+                     * @param [properties] Properties to set
+                     */
+                    constructor(properties?: google.cloud.discoveryengine.v1beta.IPurgeDocumentsRequest);
+
+                    /** PurgeDocumentsRequest parent. */
+                    public parent: string;
+
+                    /** PurgeDocumentsRequest filter. */
+                    public filter: string;
+
+                    /** PurgeDocumentsRequest force. */
+                    public force: boolean;
+
+                    /**
+                     * Creates a new PurgeDocumentsRequest instance using the specified properties.
+                     * @param [properties] Properties to set
+                     * @returns PurgeDocumentsRequest instance
+                     */
+                    public static create(properties?: google.cloud.discoveryengine.v1beta.IPurgeDocumentsRequest): google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest;
+
+                    /**
+                     * Encodes the specified PurgeDocumentsRequest message. Does not implicitly {@link google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.verify|verify} messages.
+                     * @param message PurgeDocumentsRequest message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encode(message: google.cloud.discoveryengine.v1beta.IPurgeDocumentsRequest, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Encodes the specified PurgeDocumentsRequest message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.verify|verify} messages.
+                     * @param message PurgeDocumentsRequest message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encodeDelimited(message: google.cloud.discoveryengine.v1beta.IPurgeDocumentsRequest, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Decodes a PurgeDocumentsRequest message from the specified reader or buffer.
+                     * @param reader Reader or buffer to decode from
+                     * @param [length] Message length if known beforehand
+                     * @returns PurgeDocumentsRequest
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest;
+
+                    /**
+                     * Decodes a PurgeDocumentsRequest message from the specified reader or buffer, length delimited.
+                     * @param reader Reader or buffer to decode from
+                     * @returns PurgeDocumentsRequest
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest;
+
+                    /**
+                     * Verifies a PurgeDocumentsRequest message.
+                     * @param message Plain object to verify
+                     * @returns `null` if valid, otherwise the reason why it is not
+                     */
+                    public static verify(message: { [k: string]: any }): (string|null);
+
+                    /**
+                     * Creates a PurgeDocumentsRequest message from a plain object. Also converts values to their respective internal types.
+                     * @param object Plain object
+                     * @returns PurgeDocumentsRequest
+                     */
+                    public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest;
+
+                    /**
+                     * Creates a plain object from a PurgeDocumentsRequest message. Also converts values to other types if specified.
+                     * @param message PurgeDocumentsRequest
+                     * @param [options] Conversion options
+                     * @returns Plain object
+                     */
+                    public static toObject(message: google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                    /**
+                     * Converts this PurgeDocumentsRequest to JSON.
+                     * @returns JSON object
+                     */
+                    public toJSON(): { [k: string]: any };
+
+                    /**
+                     * Gets the default type url for PurgeDocumentsRequest
+                     * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                     * @returns The default type url
+                     */
+                    public static getTypeUrl(typeUrlPrefix?: string): string;
+                }
+
+                /** Properties of a PurgeDocumentsResponse. */
+                interface IPurgeDocumentsResponse {
+
+                    /** PurgeDocumentsResponse purgeCount */
+                    purgeCount?: (number|Long|string|null);
+
+                    /** PurgeDocumentsResponse purgeSample */
+                    purgeSample?: (string[]|null);
+                }
+
+                /** Represents a PurgeDocumentsResponse. */
+                class PurgeDocumentsResponse implements IPurgeDocumentsResponse {
+
+                    /**
+                     * Constructs a new PurgeDocumentsResponse.
+                     * @param [properties] Properties to set
+                     */
+                    constructor(properties?: google.cloud.discoveryengine.v1beta.IPurgeDocumentsResponse);
+
+                    /** PurgeDocumentsResponse purgeCount. */
+                    public purgeCount: (number|Long|string);
+
+                    /** PurgeDocumentsResponse purgeSample. */
+                    public purgeSample: string[];
+
+                    /**
+                     * Creates a new PurgeDocumentsResponse instance using the specified properties.
+                     * @param [properties] Properties to set
+                     * @returns PurgeDocumentsResponse instance
+                     */
+                    public static create(properties?: google.cloud.discoveryengine.v1beta.IPurgeDocumentsResponse): google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse;
+
+                    /**
+                     * Encodes the specified PurgeDocumentsResponse message. Does not implicitly {@link google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse.verify|verify} messages.
+                     * @param message PurgeDocumentsResponse message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encode(message: google.cloud.discoveryengine.v1beta.IPurgeDocumentsResponse, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Encodes the specified PurgeDocumentsResponse message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse.verify|verify} messages.
+                     * @param message PurgeDocumentsResponse message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encodeDelimited(message: google.cloud.discoveryengine.v1beta.IPurgeDocumentsResponse, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Decodes a PurgeDocumentsResponse message from the specified reader or buffer.
+                     * @param reader Reader or buffer to decode from
+                     * @param [length] Message length if known beforehand
+                     * @returns PurgeDocumentsResponse
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse;
+
+                    /**
+                     * Decodes a PurgeDocumentsResponse message from the specified reader or buffer, length delimited.
+                     * @param reader Reader or buffer to decode from
+                     * @returns PurgeDocumentsResponse
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse;
+
+                    /**
+                     * Verifies a PurgeDocumentsResponse message.
+                     * @param message Plain object to verify
+                     * @returns `null` if valid, otherwise the reason why it is not
+                     */
+                    public static verify(message: { [k: string]: any }): (string|null);
+
+                    /**
+                     * Creates a PurgeDocumentsResponse message from a plain object. Also converts values to their respective internal types.
+                     * @param object Plain object
+                     * @returns PurgeDocumentsResponse
+                     */
+                    public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse;
+
+                    /**
+                     * Creates a plain object from a PurgeDocumentsResponse message. Also converts values to other types if specified.
+                     * @param message PurgeDocumentsResponse
+                     * @param [options] Conversion options
+                     * @returns Plain object
+                     */
+                    public static toObject(message: google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                    /**
+                     * Converts this PurgeDocumentsResponse to JSON.
+                     * @returns JSON object
+                     */
+                    public toJSON(): { [k: string]: any };
+
+                    /**
+                     * Gets the default type url for PurgeDocumentsResponse
+                     * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                     * @returns The default type url
+                     */
+                    public static getTypeUrl(typeUrlPrefix?: string): string;
+                }
+
+                /** Properties of a PurgeDocumentsMetadata. */
+                interface IPurgeDocumentsMetadata {
+
+                    /** PurgeDocumentsMetadata createTime */
+                    createTime?: (google.protobuf.ITimestamp|null);
+
+                    /** PurgeDocumentsMetadata updateTime */
+                    updateTime?: (google.protobuf.ITimestamp|null);
+
+                    /** PurgeDocumentsMetadata successCount */
+                    successCount?: (number|Long|string|null);
+
+                    /** PurgeDocumentsMetadata failureCount */
+                    failureCount?: (number|Long|string|null);
+                }
+
+                /** Represents a PurgeDocumentsMetadata. */
+                class PurgeDocumentsMetadata implements IPurgeDocumentsMetadata {
+
+                    /**
+                     * Constructs a new PurgeDocumentsMetadata.
+                     * @param [properties] Properties to set
+                     */
+                    constructor(properties?: google.cloud.discoveryengine.v1beta.IPurgeDocumentsMetadata);
+
+                    /** PurgeDocumentsMetadata createTime. */
+                    public createTime?: (google.protobuf.ITimestamp|null);
+
+                    /** PurgeDocumentsMetadata updateTime. */
+                    public updateTime?: (google.protobuf.ITimestamp|null);
+
+                    /** PurgeDocumentsMetadata successCount. */
+                    public successCount: (number|Long|string);
+
+                    /** PurgeDocumentsMetadata failureCount. */
+                    public failureCount: (number|Long|string);
+
+                    /**
+                     * Creates a new PurgeDocumentsMetadata instance using the specified properties.
+                     * @param [properties] Properties to set
+                     * @returns PurgeDocumentsMetadata instance
+                     */
+                    public static create(properties?: google.cloud.discoveryengine.v1beta.IPurgeDocumentsMetadata): google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata;
+
+                    /**
+                     * Encodes the specified PurgeDocumentsMetadata message. Does not implicitly {@link google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata.verify|verify} messages.
+                     * @param message PurgeDocumentsMetadata message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encode(message: google.cloud.discoveryengine.v1beta.IPurgeDocumentsMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Encodes the specified PurgeDocumentsMetadata message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata.verify|verify} messages.
+                     * @param message PurgeDocumentsMetadata message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encodeDelimited(message: google.cloud.discoveryengine.v1beta.IPurgeDocumentsMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Decodes a PurgeDocumentsMetadata message from the specified reader or buffer.
+                     * @param reader Reader or buffer to decode from
+                     * @param [length] Message length if known beforehand
+                     * @returns PurgeDocumentsMetadata
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata;
+
+                    /**
+                     * Decodes a PurgeDocumentsMetadata message from the specified reader or buffer, length delimited.
+                     * @param reader Reader or buffer to decode from
+                     * @returns PurgeDocumentsMetadata
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata;
+
+                    /**
+                     * Verifies a PurgeDocumentsMetadata message.
+                     * @param message Plain object to verify
+                     * @returns `null` if valid, otherwise the reason why it is not
+                     */
+                    public static verify(message: { [k: string]: any }): (string|null);
+
+                    /**
+                     * Creates a PurgeDocumentsMetadata message from a plain object. Also converts values to their respective internal types.
+                     * @param object Plain object
+                     * @returns PurgeDocumentsMetadata
+                     */
+                    public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata;
+
+                    /**
+                     * Creates a plain object from a PurgeDocumentsMetadata message. Also converts values to other types if specified.
+                     * @param message PurgeDocumentsMetadata
+                     * @param [options] Conversion options
+                     * @returns Plain object
+                     */
+                    public static toObject(message: google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                    /**
+                     * Converts this PurgeDocumentsMetadata to JSON.
+                     * @returns JSON object
+                     */
+                    public toJSON(): { [k: string]: any };
+
+                    /**
+                     * Gets the default type url for PurgeDocumentsMetadata
+                     * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                     * @returns The default type url
+                     */
+                    public static getTypeUrl(typeUrlPrefix?: string): string;
+                }
+
                 /** Represents a RecommendationService */
                 class RecommendationService extends $protobuf.rpc.Service {