diff --git a/java-discoveryengine/README.md b/java-discoveryengine/README.md index 94e5042a0d19..3b9129dd2f65 100644 --- a/java-discoveryengine/README.md +++ b/java-discoveryengine/README.md @@ -201,7 +201,7 @@ Java is a registered trademark of Oracle and/or its affiliates. [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html [stability-image]: https://img.shields.io/badge/stability-preview-yellow [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-discoveryengine.svg -[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-discoveryengine/0.11.0 +[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-discoveryengine/0.12.0 [authentication]: https://github.com/googleapis/google-cloud-java#authentication [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles diff --git a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceClient.java b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceClient.java index ad7ed41e8f28..2deee8d3f80f 100644 --- a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceClient.java +++ b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceClient.java @@ -997,6 +997,150 @@ public final UnaryCallable importDocumentsCal return stub.importDocumentsCallable(); } + // AUTO-GENERATED DOCUMENTATION AND METHOD. + /** + * 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. + * + *

Sample code: + * + * 

{@code
+   * // This snippet has been automatically generated and should be regarded as a code template only.
+   * // It will require modifications to work:
+   * // - It may require correct/in-range values for request initialization.
+   * // - It may require specifying regional endpoints when creating the service client as shown in
+   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+   * try (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
+   *   PurgeDocumentsRequest request =
+   *       PurgeDocumentsRequest.newBuilder()
+   *           .setParent(
+   *               BranchName.ofProjectLocationDataStoreBranchName(
+   *                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
+   *                   .toString())
+   *           .setFilter("filter-1274492040")
+   *           .setForce(true)
+   *           .build();
+   *   PurgeDocumentsResponse response = documentServiceClient.purgeDocumentsAsync(request).get();
+   * }
+   * }
+ * + * @param request The request object containing all of the parameters for the API call. + * @throws com.google.api.gax.rpc.ApiException if the remote call fails + */ + public final OperationFuture purgeDocumentsAsync( + PurgeDocumentsRequest request) { + return purgeDocumentsOperationCallable().futureCall(request); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD. + /** + * 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. + * + *

Sample code: + * + * 

{@code
+   * // This snippet has been automatically generated and should be regarded as a code template only.
+   * // It will require modifications to work:
+   * // - It may require correct/in-range values for request initialization.
+   * // - It may require specifying regional endpoints when creating the service client as shown in
+   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+   * try (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
+   *   PurgeDocumentsRequest request =
+   *       PurgeDocumentsRequest.newBuilder()
+   *           .setParent(
+   *               BranchName.ofProjectLocationDataStoreBranchName(
+   *                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
+   *                   .toString())
+   *           .setFilter("filter-1274492040")
+   *           .setForce(true)
+   *           .build();
+   *   OperationFuture future =
+   *       documentServiceClient.purgeDocumentsOperationCallable().futureCall(request);
+   *   // Do something.
+   *   PurgeDocumentsResponse response = future.get();
+   * }
+   * }
+ */ + public final OperationCallable< + PurgeDocumentsRequest, PurgeDocumentsResponse, PurgeDocumentsMetadata> + purgeDocumentsOperationCallable() { + return stub.purgeDocumentsOperationCallable(); + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD. + /** + * 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. + * + *

Sample code: + * + * 

{@code
+   * // This snippet has been automatically generated and should be regarded as a code template only.
+   * // It will require modifications to work:
+   * // - It may require correct/in-range values for request initialization.
+   * // - It may require specifying regional endpoints when creating the service client as shown in
+   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+   * try (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
+   *   PurgeDocumentsRequest request =
+   *       PurgeDocumentsRequest.newBuilder()
+   *           .setParent(
+   *               BranchName.ofProjectLocationDataStoreBranchName(
+   *                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
+   *                   .toString())
+   *           .setFilter("filter-1274492040")
+   *           .setForce(true)
+   *           .build();
+   *   ApiFuture future =
+   *       documentServiceClient.purgeDocumentsCallable().futureCall(request);
+   *   // Do something.
+   *   Operation response = future.get();
+   * }
+   * }
+ */ + public final UnaryCallable purgeDocumentsCallable() { + return stub.purgeDocumentsCallable(); + } + @Override public final void close() { stub.close(); diff --git a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceSettings.java b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceSettings.java index 56e1fab9b396..01724f282961 100644 --- a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceSettings.java +++ b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceSettings.java @@ -118,6 +118,18 @@ public UnaryCallSettings importDocumentsSetti return ((DocumentServiceStubSettings) getStubSettings()).importDocumentsOperationSettings(); } + /** Returns the object with the settings used for calls to purgeDocuments. */ + public UnaryCallSettings purgeDocumentsSettings() { + return ((DocumentServiceStubSettings) getStubSettings()).purgeDocumentsSettings(); + } + + /** Returns the object with the settings used for calls to purgeDocuments. */ + public OperationCallSettings< + PurgeDocumentsRequest, PurgeDocumentsResponse, PurgeDocumentsMetadata> + purgeDocumentsOperationSettings() { + return ((DocumentServiceStubSettings) getStubSettings()).purgeDocumentsOperationSettings(); + } + public static final DocumentServiceSettings create(DocumentServiceStubSettings stub) throws IOException { return new DocumentServiceSettings.Builder(stub.toBuilder()).build(); @@ -272,6 +284,18 @@ public UnaryCallSettings.Builder importDocume return getStubSettingsBuilder().importDocumentsOperationSettings(); } + /** Returns the builder for the settings used for calls to purgeDocuments. */ + public UnaryCallSettings.Builder purgeDocumentsSettings() { + return getStubSettingsBuilder().purgeDocumentsSettings(); + } + + /** Returns the builder for the settings used for calls to purgeDocuments. */ + public OperationCallSettings.Builder< + PurgeDocumentsRequest, PurgeDocumentsResponse, PurgeDocumentsMetadata> + purgeDocumentsOperationSettings() { + return getStubSettingsBuilder().purgeDocumentsOperationSettings(); + } + @Override public DocumentServiceSettings build() throws IOException { return new DocumentServiceSettings(this); diff --git a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/gapic_metadata.json b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/gapic_metadata.json index d08b1f533686..45762cae2b9d 100644 --- a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/gapic_metadata.json +++ b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/gapic_metadata.json @@ -37,6 +37,9 @@ "ListDocuments": { "methods": ["listDocuments", "listDocuments", "listDocuments", "listDocumentsPagedCallable", "listDocumentsCallable"] }, + "PurgeDocuments": { + "methods": ["purgeDocumentsAsync", "purgeDocumentsOperationCallable", "purgeDocumentsCallable"] + }, "UpdateDocument": { "methods": ["updateDocument", "updateDocumentCallable"] } diff --git a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/stub/DocumentServiceStub.java b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/stub/DocumentServiceStub.java index 473f7ea3a9c6..0cb8e3381463 100644 --- a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/stub/DocumentServiceStub.java +++ b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/stub/DocumentServiceStub.java @@ -31,6 +31,9 @@ import com.google.cloud.discoveryengine.v1beta.ImportDocumentsResponse; import com.google.cloud.discoveryengine.v1beta.ListDocumentsRequest; import com.google.cloud.discoveryengine.v1beta.ListDocumentsResponse; +import com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata; +import com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest; +import com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse; import com.google.cloud.discoveryengine.v1beta.UpdateDocumentRequest; import com.google.longrunning.Operation; import com.google.longrunning.stub.OperationsStub; @@ -89,6 +92,15 @@ public UnaryCallable importDocumentsCallable( throw new UnsupportedOperationException("Not implemented: importDocumentsCallable()"); } + public OperationCallable + purgeDocumentsOperationCallable() { + throw new UnsupportedOperationException("Not implemented: purgeDocumentsOperationCallable()"); + } + + public UnaryCallable purgeDocumentsCallable() { + throw new UnsupportedOperationException("Not implemented: purgeDocumentsCallable()"); + } + @Override public abstract void close(); } diff --git a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/stub/DocumentServiceStubSettings.java b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/stub/DocumentServiceStubSettings.java index 40bf069580d0..2026ff1071f4 100644 --- a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/stub/DocumentServiceStubSettings.java +++ b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/stub/DocumentServiceStubSettings.java @@ -56,6 +56,9 @@ import com.google.cloud.discoveryengine.v1beta.ImportDocumentsResponse; import com.google.cloud.discoveryengine.v1beta.ListDocumentsRequest; import com.google.cloud.discoveryengine.v1beta.ListDocumentsResponse; +import com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata; +import com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest; +import com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse; import com.google.cloud.discoveryengine.v1beta.UpdateDocumentRequest; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableMap; @@ -124,6 +127,10 @@ public class DocumentServiceStubSettings extends StubSettings importDocumentsOperationSettings; + private final UnaryCallSettings purgeDocumentsSettings; + private final OperationCallSettings< + PurgeDocumentsRequest, PurgeDocumentsResponse, PurgeDocumentsMetadata> + purgeDocumentsOperationSettings; private static final PagedListDescriptor LIST_DOCUMENTS_PAGE_STR_DESC = @@ -216,6 +223,18 @@ public UnaryCallSettings importDocumentsSetti return importDocumentsOperationSettings; } + /** Returns the object with the settings used for calls to purgeDocuments. */ + public UnaryCallSettings purgeDocumentsSettings() { + return purgeDocumentsSettings; + } + + /** Returns the object with the settings used for calls to purgeDocuments. */ + public OperationCallSettings< + PurgeDocumentsRequest, PurgeDocumentsResponse, PurgeDocumentsMetadata> + purgeDocumentsOperationSettings() { + return purgeDocumentsOperationSettings; + } + public DocumentServiceStub createStub() throws IOException { if (getTransportChannelProvider() .getTransportName() @@ -329,6 +348,8 @@ protected DocumentServiceStubSettings(Builder settingsBuilder) throws IOExceptio deleteDocumentSettings = settingsBuilder.deleteDocumentSettings().build(); importDocumentsSettings = settingsBuilder.importDocumentsSettings().build(); importDocumentsOperationSettings = settingsBuilder.importDocumentsOperationSettings().build(); + purgeDocumentsSettings = settingsBuilder.purgeDocumentsSettings().build(); + purgeDocumentsOperationSettings = settingsBuilder.purgeDocumentsOperationSettings().build(); } /** Builder for DocumentServiceStubSettings. */ @@ -346,6 +367,11 @@ public static class Builder extends StubSettings.Builder importDocumentsOperationSettings; + private final UnaryCallSettings.Builder + purgeDocumentsSettings; + private final OperationCallSettings.Builder< + PurgeDocumentsRequest, PurgeDocumentsResponse, PurgeDocumentsMetadata> + purgeDocumentsOperationSettings; private static final ImmutableMap> RETRYABLE_CODE_DEFINITIONS; @@ -405,6 +431,8 @@ protected Builder(ClientContext clientContext) { deleteDocumentSettings = UnaryCallSettings.newUnaryCallSettingsBuilder(); importDocumentsSettings = UnaryCallSettings.newUnaryCallSettingsBuilder(); importDocumentsOperationSettings = OperationCallSettings.newBuilder(); + purgeDocumentsSettings = UnaryCallSettings.newUnaryCallSettingsBuilder(); + purgeDocumentsOperationSettings = OperationCallSettings.newBuilder(); unaryMethodSettingsBuilders = ImmutableList.>of( @@ -413,7 +441,8 @@ protected Builder(ClientContext clientContext) { createDocumentSettings, updateDocumentSettings, deleteDocumentSettings, - importDocumentsSettings); + importDocumentsSettings, + purgeDocumentsSettings); initDefaults(this); } @@ -427,6 +456,8 @@ protected Builder(DocumentServiceStubSettings settings) { deleteDocumentSettings = settings.deleteDocumentSettings.toBuilder(); importDocumentsSettings = settings.importDocumentsSettings.toBuilder(); importDocumentsOperationSettings = settings.importDocumentsOperationSettings.toBuilder(); + purgeDocumentsSettings = settings.purgeDocumentsSettings.toBuilder(); + purgeDocumentsOperationSettings = settings.purgeDocumentsOperationSettings.toBuilder(); unaryMethodSettingsBuilders = ImmutableList.>of( @@ -435,7 +466,8 @@ protected Builder(DocumentServiceStubSettings settings) { createDocumentSettings, updateDocumentSettings, deleteDocumentSettings, - importDocumentsSettings); + importDocumentsSettings, + purgeDocumentsSettings); } private static Builder createDefault() { @@ -495,6 +527,11 @@ private static Builder initDefaults(Builder builder) { .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_2_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_2_params")); + builder + .purgeDocumentsSettings() + .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_1_codes")) + .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_1_params")); + builder .importDocumentsOperationSettings() .setInitialCallSettings( @@ -519,6 +556,30 @@ private static Builder initDefaults(Builder builder) { .setTotalTimeout(Duration.ofMillis(300000L)) .build())); + builder + .purgeDocumentsOperationSettings() + .setInitialCallSettings( + UnaryCallSettings + .newUnaryCallSettingsBuilder() + .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_1_codes")) + .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_1_params")) + .build()) + .setResponseTransformer( + ProtoOperationTransformers.ResponseTransformer.create(PurgeDocumentsResponse.class)) + .setMetadataTransformer( + ProtoOperationTransformers.MetadataTransformer.create(PurgeDocumentsMetadata.class)) + .setPollingAlgorithm( + OperationTimedPollAlgorithm.create( + RetrySettings.newBuilder() + .setInitialRetryDelay(Duration.ofMillis(5000L)) + .setRetryDelayMultiplier(1.5) + .setMaxRetryDelay(Duration.ofMillis(45000L)) + .setInitialRpcTimeout(Duration.ZERO) + .setRpcTimeoutMultiplier(1.0) + .setMaxRpcTimeout(Duration.ZERO) + .setTotalTimeout(Duration.ofMillis(300000L)) + .build())); + return builder; } @@ -578,6 +639,20 @@ public UnaryCallSettings.Builder importDocume return importDocumentsOperationSettings; } + /** Returns the builder for the settings used for calls to purgeDocuments. */ + public UnaryCallSettings.Builder purgeDocumentsSettings() { + return purgeDocumentsSettings; + } + + /** Returns the builder for the settings used for calls to purgeDocuments. */ + @BetaApi( + "The surface for use by generated code is not stable yet and may change in the future.") + public OperationCallSettings.Builder< + PurgeDocumentsRequest, PurgeDocumentsResponse, PurgeDocumentsMetadata> + purgeDocumentsOperationSettings() { + return purgeDocumentsOperationSettings; + } + @Override public DocumentServiceStubSettings build() throws IOException { return new DocumentServiceStubSettings(this); diff --git a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/stub/GrpcDocumentServiceStub.java b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/stub/GrpcDocumentServiceStub.java index f94edffa9257..29464937c7cf 100644 --- a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/stub/GrpcDocumentServiceStub.java +++ b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/stub/GrpcDocumentServiceStub.java @@ -35,6 +35,9 @@ import com.google.cloud.discoveryengine.v1beta.ImportDocumentsResponse; import com.google.cloud.discoveryengine.v1beta.ListDocumentsRequest; import com.google.cloud.discoveryengine.v1beta.ListDocumentsResponse; +import com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata; +import com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest; +import com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse; import com.google.cloud.discoveryengine.v1beta.UpdateDocumentRequest; import com.google.common.collect.ImmutableMap; import com.google.longrunning.Operation; @@ -119,6 +122,17 @@ public class GrpcDocumentServiceStub extends DocumentServiceStub { .setResponseMarshaller(ProtoUtils.marshaller(Operation.getDefaultInstance())) .build(); + private static final MethodDescriptor + purgeDocumentsMethodDescriptor = + MethodDescriptor.newBuilder() + .setType(MethodDescriptor.MethodType.UNARY) + .setFullMethodName( + "google.cloud.discoveryengine.v1beta.DocumentService/PurgeDocuments") + .setRequestMarshaller( + ProtoUtils.marshaller(PurgeDocumentsRequest.getDefaultInstance())) + .setResponseMarshaller(ProtoUtils.marshaller(Operation.getDefaultInstance())) + .build(); + private final UnaryCallable getDocumentCallable; private final UnaryCallable listDocumentsCallable; private final UnaryCallable @@ -130,6 +144,10 @@ public class GrpcDocumentServiceStub extends DocumentServiceStub { private final OperationCallable< ImportDocumentsRequest, ImportDocumentsResponse, ImportDocumentsMetadata> importDocumentsOperationCallable; + private final UnaryCallable purgeDocumentsCallable; + private final OperationCallable< + PurgeDocumentsRequest, PurgeDocumentsResponse, PurgeDocumentsMetadata> + purgeDocumentsOperationCallable; private final BackgroundResource backgroundResources; private final GrpcOperationsStub operationsStub; @@ -235,6 +253,16 @@ protected GrpcDocumentServiceStub( return params.build(); }) .build(); + GrpcCallSettings purgeDocumentsTransportSettings = + GrpcCallSettings.newBuilder() + .setMethodDescriptor(purgeDocumentsMethodDescriptor) + .setParamsExtractor( + request -> { + ImmutableMap.Builder params = ImmutableMap.builder(); + params.put("parent", String.valueOf(request.getParent())); + return params.build(); + }) + .build(); this.getDocumentCallable = callableFactory.createUnaryCallable( @@ -263,6 +291,15 @@ protected GrpcDocumentServiceStub( settings.importDocumentsOperationSettings(), clientContext, operationsStub); + this.purgeDocumentsCallable = + callableFactory.createUnaryCallable( + purgeDocumentsTransportSettings, settings.purgeDocumentsSettings(), clientContext); + this.purgeDocumentsOperationCallable = + callableFactory.createOperationCallable( + purgeDocumentsTransportSettings, + settings.purgeDocumentsOperationSettings(), + clientContext, + operationsStub); this.backgroundResources = new BackgroundResourceAggregation(clientContext.getBackgroundResources()); @@ -314,6 +351,17 @@ public UnaryCallable importDocumentsCallable( return importDocumentsOperationCallable; } + @Override + public UnaryCallable purgeDocumentsCallable() { + return purgeDocumentsCallable; + } + + @Override + public OperationCallable + purgeDocumentsOperationCallable() { + return purgeDocumentsOperationCallable; + } + @Override public final void close() { try { diff --git a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/stub/HttpJsonDocumentServiceStub.java b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/stub/HttpJsonDocumentServiceStub.java index 151bf011195d..fdecb2503ec5 100644 --- a/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/stub/HttpJsonDocumentServiceStub.java +++ b/java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/stub/HttpJsonDocumentServiceStub.java @@ -43,6 +43,9 @@ import com.google.cloud.discoveryengine.v1beta.ImportDocumentsResponse; import com.google.cloud.discoveryengine.v1beta.ListDocumentsRequest; import com.google.cloud.discoveryengine.v1beta.ListDocumentsResponse; +import com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata; +import com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest; +import com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse; import com.google.cloud.discoveryengine.v1beta.UpdateDocumentRequest; import com.google.common.collect.ImmutableMap; import com.google.longrunning.Operation; @@ -68,6 +71,8 @@ public class HttpJsonDocumentServiceStub extends DocumentServiceStub { private static final TypeRegistry typeRegistry = TypeRegistry.newBuilder() .add(ImportDocumentsMetadata.getDescriptor()) + .add(PurgeDocumentsMetadata.getDescriptor()) + .add(PurgeDocumentsResponse.getDescriptor()) .add(ImportDocumentsResponse.getDescriptor()) .build(); @@ -310,6 +315,49 @@ public class HttpJsonDocumentServiceStub extends DocumentServiceStub { HttpJsonOperationSnapshot.create(response)) .build(); + private static final ApiMethodDescriptor + purgeDocumentsMethodDescriptor = + ApiMethodDescriptor.newBuilder() + .setFullMethodName( + "google.cloud.discoveryengine.v1beta.DocumentService/PurgeDocuments") + .setHttpMethod("POST") + .setType(ApiMethodDescriptor.MethodType.UNARY) + .setRequestFormatter( + ProtoMessageRequestFormatter.newBuilder() + .setPath( + "/v1beta/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents:purge", + request -> { + Map fields = new HashMap<>(); + ProtoRestSerializer serializer = + ProtoRestSerializer.create(); + serializer.putPathParam(fields, "parent", request.getParent()); + return fields; + }) + .setAdditionalPaths( + "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents:purge") + .setQueryParamsExtractor( + request -> { + Map> fields = new HashMap<>(); + ProtoRestSerializer serializer = + ProtoRestSerializer.create(); + serializer.putQueryParam(fields, "$alt", "json;enum-encoding=int"); + return fields; + }) + .setRequestBodyExtractor( + request -> + ProtoRestSerializer.create() + .toBody("*", request.toBuilder().clearParent().build(), true)) + .build()) + .setResponseParser( + ProtoMessageResponseParser.newBuilder() + .setDefaultInstance(Operation.getDefaultInstance()) + .setDefaultTypeRegistry(typeRegistry) + .build()) + .setOperationSnapshotFactory( + (PurgeDocumentsRequest request, Operation response) -> + HttpJsonOperationSnapshot.create(response)) + .build(); + private final UnaryCallable getDocumentCallable; private final UnaryCallable listDocumentsCallable; private final UnaryCallable @@ -321,6 +369,10 @@ public class HttpJsonDocumentServiceStub extends DocumentServiceStub { private final OperationCallable< ImportDocumentsRequest, ImportDocumentsResponse, ImportDocumentsMetadata> importDocumentsOperationCallable; + private final UnaryCallable purgeDocumentsCallable; + private final OperationCallable< + PurgeDocumentsRequest, PurgeDocumentsResponse, PurgeDocumentsMetadata> + purgeDocumentsOperationCallable; private final BackgroundResource backgroundResources; private final HttpJsonOperationsStub httpJsonOperationsStub; @@ -491,6 +543,11 @@ protected HttpJsonDocumentServiceStub( .setMethodDescriptor(importDocumentsMethodDescriptor) .setTypeRegistry(typeRegistry) .build(); + HttpJsonCallSettings purgeDocumentsTransportSettings = + HttpJsonCallSettings.newBuilder() + .setMethodDescriptor(purgeDocumentsMethodDescriptor) + .setTypeRegistry(typeRegistry) + .build(); this.getDocumentCallable = callableFactory.createUnaryCallable( @@ -519,6 +576,15 @@ protected HttpJsonDocumentServiceStub( settings.importDocumentsOperationSettings(), clientContext, httpJsonOperationsStub); + this.purgeDocumentsCallable = + callableFactory.createUnaryCallable( + purgeDocumentsTransportSettings, settings.purgeDocumentsSettings(), clientContext); + this.purgeDocumentsOperationCallable = + callableFactory.createOperationCallable( + purgeDocumentsTransportSettings, + settings.purgeDocumentsOperationSettings(), + clientContext, + httpJsonOperationsStub); this.backgroundResources = new BackgroundResourceAggregation(clientContext.getBackgroundResources()); @@ -533,6 +599,7 @@ public static List getMethodDescriptors() { methodDescriptors.add(updateDocumentMethodDescriptor); methodDescriptors.add(deleteDocumentMethodDescriptor); methodDescriptors.add(importDocumentsMethodDescriptor); + methodDescriptors.add(purgeDocumentsMethodDescriptor); return methodDescriptors; } @@ -582,6 +649,17 @@ public UnaryCallable importDocumentsCallable( return importDocumentsOperationCallable; } + @Override + public UnaryCallable purgeDocumentsCallable() { + return purgeDocumentsCallable; + } + + @Override + public OperationCallable + purgeDocumentsOperationCallable() { + return purgeDocumentsOperationCallable; + } + @Override public final void close() { try { diff --git a/java-discoveryengine/google-cloud-discoveryengine/src/test/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceClientHttpJsonTest.java b/java-discoveryengine/google-cloud-discoveryengine/src/test/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceClientHttpJsonTest.java index 7596035e5230..43f23ab7bf98 100644 --- a/java-discoveryengine/google-cloud-discoveryengine/src/test/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceClientHttpJsonTest.java +++ b/java-discoveryengine/google-cloud-discoveryengine/src/test/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceClientHttpJsonTest.java @@ -651,4 +651,70 @@ public void importDocumentsExceptionTest() throws Exception { } catch (ExecutionException e) { } } + + @Test + public void purgeDocumentsTest() throws Exception { + PurgeDocumentsResponse expectedResponse = + PurgeDocumentsResponse.newBuilder() + .setPurgeCount(575305851) + .addAllPurgeSample(new ArrayList()) + .build(); + Operation resultOperation = + Operation.newBuilder() + .setName("purgeDocumentsTest") + .setDone(true) + .setResponse(Any.pack(expectedResponse)) + .build(); + mockService.addResponse(resultOperation); + + PurgeDocumentsRequest request = + PurgeDocumentsRequest.newBuilder() + .setParent( + BranchName.ofProjectLocationDataStoreBranchName( + "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]") + .toString()) + .setFilter("filter-1274492040") + .setForce(true) + .build(); + + PurgeDocumentsResponse actualResponse = client.purgeDocumentsAsync(request).get(); + Assert.assertEquals(expectedResponse, actualResponse); + + List actualRequests = mockService.getRequestPaths(); + Assert.assertEquals(1, actualRequests.size()); + + String apiClientHeaderKey = + mockService + .getRequestHeaders() + .get(ApiClientHeaderProvider.getDefaultApiClientHeaderKey()) + .iterator() + .next(); + Assert.assertTrue( + GaxHttpJsonProperties.getDefaultApiClientHeaderPattern() + .matcher(apiClientHeaderKey) + .matches()); + } + + @Test + public void purgeDocumentsExceptionTest() throws Exception { + ApiException exception = + ApiExceptionFactory.createException( + new Exception(), FakeStatusCode.of(StatusCode.Code.INVALID_ARGUMENT), false); + mockService.addException(exception); + + try { + PurgeDocumentsRequest request = + PurgeDocumentsRequest.newBuilder() + .setParent( + BranchName.ofProjectLocationDataStoreBranchName( + "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]") + .toString()) + .setFilter("filter-1274492040") + .setForce(true) + .build(); + client.purgeDocumentsAsync(request).get(); + Assert.fail("No exception raised"); + } catch (ExecutionException e) { + } + } } diff --git a/java-discoveryengine/google-cloud-discoveryengine/src/test/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceClientTest.java b/java-discoveryengine/google-cloud-discoveryengine/src/test/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceClientTest.java index 091b221a5e1e..b1af4593c36c 100644 --- a/java-discoveryengine/google-cloud-discoveryengine/src/test/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceClientTest.java +++ b/java-discoveryengine/google-cloud-discoveryengine/src/test/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceClientTest.java @@ -574,4 +574,69 @@ public void importDocumentsExceptionTest() throws Exception { Assert.assertEquals(StatusCode.Code.INVALID_ARGUMENT, apiException.getStatusCode().getCode()); } } + + @Test + public void purgeDocumentsTest() throws Exception { + PurgeDocumentsResponse expectedResponse = + PurgeDocumentsResponse.newBuilder() + .setPurgeCount(575305851) + .addAllPurgeSample(new ArrayList()) + .build(); + Operation resultOperation = + Operation.newBuilder() + .setName("purgeDocumentsTest") + .setDone(true) + .setResponse(Any.pack(expectedResponse)) + .build(); + mockDocumentService.addResponse(resultOperation); + + PurgeDocumentsRequest request = + PurgeDocumentsRequest.newBuilder() + .setParent( + BranchName.ofProjectLocationDataStoreBranchName( + "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]") + .toString()) + .setFilter("filter-1274492040") + .setForce(true) + .build(); + + PurgeDocumentsResponse actualResponse = client.purgeDocumentsAsync(request).get(); + Assert.assertEquals(expectedResponse, actualResponse); + + List actualRequests = mockDocumentService.getRequests(); + Assert.assertEquals(1, actualRequests.size()); + PurgeDocumentsRequest actualRequest = ((PurgeDocumentsRequest) actualRequests.get(0)); + + Assert.assertEquals(request.getParent(), actualRequest.getParent()); + Assert.assertEquals(request.getFilter(), actualRequest.getFilter()); + Assert.assertEquals(request.getForce(), actualRequest.getForce()); + Assert.assertTrue( + channelProvider.isHeaderSent( + ApiClientHeaderProvider.getDefaultApiClientHeaderKey(), + GaxGrpcProperties.getDefaultApiClientHeaderPattern())); + } + + @Test + public void purgeDocumentsExceptionTest() throws Exception { + StatusRuntimeException exception = new StatusRuntimeException(io.grpc.Status.INVALID_ARGUMENT); + mockDocumentService.addException(exception); + + try { + PurgeDocumentsRequest request = + PurgeDocumentsRequest.newBuilder() + .setParent( + BranchName.ofProjectLocationDataStoreBranchName( + "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]") + .toString()) + .setFilter("filter-1274492040") + .setForce(true) + .build(); + client.purgeDocumentsAsync(request).get(); + Assert.fail("No exception raised"); + } catch (ExecutionException e) { + Assert.assertEquals(InvalidArgumentException.class, e.getCause().getClass()); + InvalidArgumentException apiException = ((InvalidArgumentException) e.getCause()); + Assert.assertEquals(StatusCode.Code.INVALID_ARGUMENT, apiException.getStatusCode().getCode()); + } + } } diff --git a/java-discoveryengine/google-cloud-discoveryengine/src/test/java/com/google/cloud/discoveryengine/v1beta/MockDocumentServiceImpl.java b/java-discoveryengine/google-cloud-discoveryengine/src/test/java/com/google/cloud/discoveryengine/v1beta/MockDocumentServiceImpl.java index 03d616f75092..aeb4ff0eed44 100644 --- a/java-discoveryengine/google-cloud-discoveryengine/src/test/java/com/google/cloud/discoveryengine/v1beta/MockDocumentServiceImpl.java +++ b/java-discoveryengine/google-cloud-discoveryengine/src/test/java/com/google/cloud/discoveryengine/v1beta/MockDocumentServiceImpl.java @@ -184,4 +184,25 @@ public void importDocuments( Exception.class.getName()))); } } + + @Override + public void purgeDocuments( + PurgeDocumentsRequest request, StreamObserver responseObserver) { + Object response = responses.poll(); + if (response instanceof Operation) { + requests.add(request); + responseObserver.onNext(((Operation) response)); + responseObserver.onCompleted(); + } else if (response instanceof Exception) { + responseObserver.onError(((Exception) response)); + } else { + responseObserver.onError( + new IllegalArgumentException( + String.format( + "Unrecognized response type %s for method PurgeDocuments, expected %s or %s", + response == null ? "null" : response.getClass().getName(), + Operation.class.getName(), + Exception.class.getName()))); + } + } } diff --git a/java-discoveryengine/grpc-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceGrpc.java b/java-discoveryengine/grpc-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceGrpc.java index 4ae6c21a5271..021d0ef3d4ac 100644 --- a/java-discoveryengine/grpc-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceGrpc.java +++ b/java-discoveryengine/grpc-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceGrpc.java @@ -315,6 +315,52 @@ private DocumentServiceGrpc() {} return getImportDocumentsMethod; } + private static volatile io.grpc.MethodDescriptor< + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest, + com.google.longrunning.Operation> + getPurgeDocumentsMethod; + + @io.grpc.stub.annotations.RpcMethod( + fullMethodName = SERVICE_NAME + '/' + "PurgeDocuments", + requestType = com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.class, + responseType = com.google.longrunning.Operation.class, + methodType = io.grpc.MethodDescriptor.MethodType.UNARY) + public static io.grpc.MethodDescriptor< + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest, + com.google.longrunning.Operation> + getPurgeDocumentsMethod() { + io.grpc.MethodDescriptor< + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest, + com.google.longrunning.Operation> + getPurgeDocumentsMethod; + if ((getPurgeDocumentsMethod = DocumentServiceGrpc.getPurgeDocumentsMethod) == null) { + synchronized (DocumentServiceGrpc.class) { + if ((getPurgeDocumentsMethod = DocumentServiceGrpc.getPurgeDocumentsMethod) == null) { + DocumentServiceGrpc.getPurgeDocumentsMethod = + getPurgeDocumentsMethod = + io.grpc.MethodDescriptor + . + newBuilder() + .setType(io.grpc.MethodDescriptor.MethodType.UNARY) + .setFullMethodName(generateFullMethodName(SERVICE_NAME, "PurgeDocuments")) + .setSampledToLocalTracing(true) + .setRequestMarshaller( + io.grpc.protobuf.ProtoUtils.marshaller( + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest + .getDefaultInstance())) + .setResponseMarshaller( + io.grpc.protobuf.ProtoUtils.marshaller( + com.google.longrunning.Operation.getDefaultInstance())) + .setSchemaDescriptor( + new DocumentServiceMethodDescriptorSupplier("PurgeDocuments")) + .build(); + } + } + } + return getPurgeDocumentsMethod; + } + /** Creates a new async stub that supports all call types for the service */ public static DocumentServiceStub newStub(io.grpc.Channel channel) { io.grpc.stub.AbstractStub.StubFactory factory = @@ -459,6 +505,34 @@ default void importDocuments( io.grpc.stub.ServerCalls.asyncUnimplementedUnaryCall( getImportDocumentsMethod(), responseObserver); } + + /** + * + * + * 
+     * 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.
+     *
+ */ + default void purgeDocuments( + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest request, + io.grpc.stub.StreamObserver responseObserver) { + io.grpc.stub.ServerCalls.asyncUnimplementedUnaryCall( + getPurgeDocumentsMethod(), responseObserver); + } } /** @@ -603,6 +677,36 @@ public void importDocuments( request, responseObserver); } + + /** + * + * + * 
+     * 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.
+     *
+ */ + public void purgeDocuments( + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest request, + io.grpc.stub.StreamObserver responseObserver) { + io.grpc.stub.ClientCalls.asyncUnaryCall( + getChannel().newCall(getPurgeDocumentsMethod(), getCallOptions()), + request, + responseObserver); + } } /** @@ -708,6 +812,33 @@ public com.google.longrunning.Operation importDocuments( return io.grpc.stub.ClientCalls.blockingUnaryCall( getChannel(), getImportDocumentsMethod(), getCallOptions(), request); } + + /** + * + * + * 
+     * 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.
+     *
+ */ + public com.google.longrunning.Operation purgeDocuments( + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest request) { + return io.grpc.stub.ClientCalls.blockingUnaryCall( + getChannel(), getPurgeDocumentsMethod(), getCallOptions(), request); + } } /** @@ -817,6 +948,33 @@ protected DocumentServiceFutureStub build( return io.grpc.stub.ClientCalls.futureUnaryCall( getChannel().newCall(getImportDocumentsMethod(), getCallOptions()), request); } + + /** + * + * + * 
+     * 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.
+     *
+ */ + public com.google.common.util.concurrent.ListenableFuture + purgeDocuments(com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest request) { + return io.grpc.stub.ClientCalls.futureUnaryCall( + getChannel().newCall(getPurgeDocumentsMethod(), getCallOptions()), request); + } } private static final int METHODID_GET_DOCUMENT = 0; @@ -825,6 +983,7 @@ protected DocumentServiceFutureStub build( private static final int METHODID_UPDATE_DOCUMENT = 3; private static final int METHODID_DELETE_DOCUMENT = 4; private static final int METHODID_IMPORT_DOCUMENTS = 5; + private static final int METHODID_PURGE_DOCUMENTS = 6; private static final class MethodHandlers implements io.grpc.stub.ServerCalls.UnaryMethod, @@ -878,6 +1037,11 @@ public void invoke(Req request, io.grpc.stub.StreamObserver responseObserv (com.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest) request, (io.grpc.stub.StreamObserver) responseObserver); break; + case METHODID_PURGE_DOCUMENTS: + serviceImpl.purgeDocuments( + (com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest) request, + (io.grpc.stub.StreamObserver) responseObserver); + break; default: throw new AssertionError(); } @@ -936,6 +1100,12 @@ public static final io.grpc.ServerServiceDefinition bindService(AsyncService ser new MethodHandlers< com.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest, com.google.longrunning.Operation>(service, METHODID_IMPORT_DOCUMENTS))) + .addMethod( + getPurgeDocumentsMethod(), + io.grpc.stub.ServerCalls.asyncUnaryCall( + new MethodHandlers< + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest, + com.google.longrunning.Operation>(service, METHODID_PURGE_DOCUMENTS))) .build(); } @@ -993,6 +1163,7 @@ public static io.grpc.ServiceDescriptor getServiceDescriptor() { .addMethod(getUpdateDocumentMethod()) .addMethod(getDeleteDocumentMethod()) .addMethod(getImportDocumentsMethod()) + .addMethod(getPurgeDocumentsMethod()) .build(); } } diff --git a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceProto.java b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceProto.java index 9c53270bc1d0..04de49c48cfe 100644 --- a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceProto.java +++ b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceProto.java @@ -68,87 +68,99 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() { + "source.proto\0322google/cloud/discoveryengi" + "ne/v1beta/document.proto\0327google/cloud/d" + "iscoveryengine/v1beta/import_config.prot" - + "o\032#google/longrunning/operations.proto\032\033" - + "google/protobuf/empty.proto\"S\n\022GetDocume" - + "ntRequest\022=\n\004name\030\001 \001(\tB/\340A\002\372A)\n\'discove" - + "ryengine.googleapis.com/Document\"|\n\024List" - + "DocumentsRequest\022=\n\006parent\030\001 \001(\tB-\340A\002\372A\'" - + "\n%discoveryengine.googleapis.com/Branch\022" - + "\021\n\tpage_size\030\002 \001(\005\022\022\n\npage_token\030\003 \001(\t\"r" - + "\n\025ListDocumentsResponse\022@\n\tdocuments\030\001 \003" - + "(\0132-.google.cloud.discoveryengine.v1beta" - + ".Document\022\027\n\017next_page_token\030\002 \001(\t\"\266\001\n\025C" - + "reateDocumentRequest\022=\n\006parent\030\001 \001(\tB-\340A" - + "\002\372A\'\n%discoveryengine.googleapis.com/Bra" - + "nch\022D\n\010document\030\002 \001(\0132-.google.cloud.dis" - + "coveryengine.v1beta.DocumentB\003\340A\002\022\030\n\013doc" - + "ument_id\030\003 \001(\tB\003\340A\002\"t\n\025UpdateDocumentReq" - + "uest\022D\n\010document\030\001 \001(\0132-.google.cloud.di" - + "scoveryengine.v1beta.DocumentB\003\340A\002\022\025\n\ral" - + "low_missing\030\002 \001(\010\"V\n\025DeleteDocumentReque" - + "st\022=\n\004name\030\001 \001(\tB/\340A\002\372A)\n\'discoveryengin" - + "e.googleapis.com/Document2\331\020\n\017DocumentSe" - + "rvice\022\254\002\n\013GetDocument\0227.google.cloud.dis" - + "coveryengine.v1beta.GetDocumentRequest\032-" + + "o\0326google/cloud/discoveryengine/v1beta/p" + + "urge_config.proto\032#google/longrunning/op" + + "erations.proto\032\033google/protobuf/empty.pr" + + "oto\"S\n\022GetDocumentRequest\022=\n\004name\030\001 \001(\tB" + + "/\340A\002\372A)\n\'discoveryengine.googleapis.com/" + + "Document\"|\n\024ListDocumentsRequest\022=\n\006pare" + + "nt\030\001 \001(\tB-\340A\002\372A\'\n%discoveryengine.google" + + "apis.com/Branch\022\021\n\tpage_size\030\002 \001(\005\022\022\n\npa" + + "ge_token\030\003 \001(\t\"r\n\025ListDocumentsResponse\022" + + "@\n\tdocuments\030\001 \003(\0132-.google.cloud.discov" + + "eryengine.v1beta.Document\022\027\n\017next_page_t" + + "oken\030\002 \001(\t\"\266\001\n\025CreateDocumentRequest\022=\n\006" + + "parent\030\001 \001(\tB-\340A\002\372A\'\n%discoveryengine.go" + + "ogleapis.com/Branch\022D\n\010document\030\002 \001(\0132-." + + "google.cloud.discoveryengine.v1beta.Docu" + + "mentB\003\340A\002\022\030\n\013document_id\030\003 \001(\tB\003\340A\002\"t\n\025U" + + "pdateDocumentRequest\022D\n\010document\030\001 \001(\0132-" + ".google.cloud.discoveryengine.v1beta.Doc" - + "ument\"\264\001\202\323\344\223\002\246\001\022I/v1beta/{name=projects/" - + "*/locations/*/dataStores/*/branches/*/do" - + "cuments/*}ZY\022W/v1beta/{name=projects/*/l" - + "ocations/*/collections/*/dataStores/*/br" - + "anches/*/documents/*}\332A\004name\022\277\002\n\rListDoc" - + "uments\0229.google.cloud.discoveryengine.v1" - + "beta.ListDocumentsRequest\032:.google.cloud" - + ".discoveryengine.v1beta.ListDocumentsRes" - + "ponse\"\266\001\202\323\344\223\002\246\001\022I/v1beta/{parent=project" - + "s/*/locations/*/dataStores/*/branches/*}" - + "/documentsZY\022W/v1beta/{parent=projects/*" - + "/locations/*/collections/*/dataStores/*/" - + "branches/*}/documents\332A\006parent\022\335\002\n\016Creat" - + "eDocument\022:.google.cloud.discoveryengine" - + ".v1beta.CreateDocumentRequest\032-.google.c" - + "loud.discoveryengine.v1beta.Document\"\337\001\202" - + "\323\344\223\002\272\001\"I/v1beta/{parent=projects/*/locat" - + "ions/*/dataStores/*/branches/*}/document" - + "s:\010documentZc\"W/v1beta/{parent=projects/" - + "*/locations/*/collections/*/dataStores/*" - + "/branches/*}/documents:\010document\332A\033paren" - + "t,document,document_id\022\321\002\n\016UpdateDocumen" - + "t\022:.google.cloud.discoveryengine.v1beta." - + "UpdateDocumentRequest\032-.google.cloud.dis" - + "coveryengine.v1beta.Document\"\323\001\202\323\344\223\002\314\0012R" - + "/v1beta/{document.name=projects/*/locati" - + "ons/*/dataStores/*/branches/*/documents/" - + "*}:\010documentZl2`/v1beta/{document.name=p" - + "rojects/*/locations/*/collections/*/data" - + "Stores/*/branches/*/documents/*}:\010docume" - + "nt\022\233\002\n\016DeleteDocument\022:.google.cloud.dis" - + "coveryengine.v1beta.DeleteDocumentReques" - + "t\032\026.google.protobuf.Empty\"\264\001\202\323\344\223\002\246\001*I/v1" - + "beta/{name=projects/*/locations/*/dataSt" - + "ores/*/branches/*/documents/*}ZY*W/v1bet" - + "a/{name=projects/*/locations/*/collectio" - + "ns/*/dataStores/*/branches/*/documents/*" - + "}\332A\004name\022\256\003\n\017ImportDocuments\022;.google.cl" - + "oud.discoveryengine.v1beta.ImportDocumen" - + "tsRequest\032\035.google.longrunning.Operation" - + "\"\276\002\202\323\344\223\002\272\001\"P/v1beta/{parent=projects/*/l" - + "ocations/*/dataStores/*/branches/*}/docu" - + "ments:import:\001*Zc\"^/v1beta/{parent=proje" - + "cts/*/locations/*/collections/*/dataStor" - + "es/*/branches/*}/documents:import:\001*\312Az\n" - + ";google.cloud.discoveryengine.v1beta.Imp" - + "ortDocumentsResponse\022;google.cloud.disco" - + "veryengine.v1beta.ImportDocumentsMetadat" - + "a\032R\312A\036discoveryengine.googleapis.com\322A.h" - + "ttps://www.googleapis.com/auth/cloud-pla" - + "tformB\233\002\n\'com.google.cloud.discoveryengi" - + "ne.v1betaB\024DocumentServiceProtoP\001ZQcloud" - + ".google.com/go/discoveryengine/apiv1beta" - + "/discoveryenginepb;discoveryenginepb\242\002\017D" - + "ISCOVERYENGINE\252\002#Google.Cloud.DiscoveryE" - + "ngine.V1Beta\312\002#Google\\Cloud\\DiscoveryEng" - + "ine\\V1beta\352\002&Google::Cloud::DiscoveryEng" - + "ine::V1betab\006proto3" + + "umentB\003\340A\002\022\025\n\rallow_missing\030\002 \001(\010\"V\n\025Del" + + "eteDocumentRequest\022=\n\004name\030\001 \001(\tB/\340A\002\372A)" + + "\n\'discoveryengine.googleapis.com/Documen" + + "t2\204\024\n\017DocumentService\022\254\002\n\013GetDocument\0227." + + "google.cloud.discoveryengine.v1beta.GetD" + + "ocumentRequest\032-.google.cloud.discoverye" + + "ngine.v1beta.Document\"\264\001\202\323\344\223\002\246\001\022I/v1beta" + + "/{name=projects/*/locations/*/dataStores" + + "/*/branches/*/documents/*}ZY\022W/v1beta/{n" + + "ame=projects/*/locations/*/collections/*" + + "/dataStores/*/branches/*/documents/*}\332A\004" + + "name\022\277\002\n\rListDocuments\0229.google.cloud.di" + + "scoveryengine.v1beta.ListDocumentsReques" + + "t\032:.google.cloud.discoveryengine.v1beta." + + "ListDocumentsResponse\"\266\001\202\323\344\223\002\246\001\022I/v1beta" + + "/{parent=projects/*/locations/*/dataStor" + + "es/*/branches/*}/documentsZY\022W/v1beta/{p" + + "arent=projects/*/locations/*/collections" + + "/*/dataStores/*/branches/*}/documents\332A\006" + + "parent\022\335\002\n\016CreateDocument\022:.google.cloud" + + ".discoveryengine.v1beta.CreateDocumentRe" + + "quest\032-.google.cloud.discoveryengine.v1b" + + "eta.Document\"\337\001\202\323\344\223\002\272\001\"I/v1beta/{parent=" + + "projects/*/locations/*/dataStores/*/bran" + + "ches/*}/documents:\010documentZc\"W/v1beta/{" + + "parent=projects/*/locations/*/collection" + + "s/*/dataStores/*/branches/*}/documents:\010" + + "document\332A\033parent,document,document_id\022\321" + + "\002\n\016UpdateDocument\022:.google.cloud.discove" + + "ryengine.v1beta.UpdateDocumentRequest\032-." + + "google.cloud.discoveryengine.v1beta.Docu" + + "ment\"\323\001\202\323\344\223\002\314\0012R/v1beta/{document.name=p" + + "rojects/*/locations/*/dataStores/*/branc" + + "hes/*/documents/*}:\010documentZl2`/v1beta/" + + "{document.name=projects/*/locations/*/co" + + "llections/*/dataStores/*/branches/*/docu" + + "ments/*}:\010document\022\233\002\n\016DeleteDocument\022:." + + "google.cloud.discoveryengine.v1beta.Dele" + + "teDocumentRequest\032\026.google.protobuf.Empt" + + "y\"\264\001\202\323\344\223\002\246\001*I/v1beta/{name=projects/*/lo" + + "cations/*/dataStores/*/branches/*/docume" + + "nts/*}ZY*W/v1beta/{name=projects/*/locat" + + "ions/*/collections/*/dataStores/*/branch" + + "es/*/documents/*}\332A\004name\022\256\003\n\017ImportDocum" + + "ents\022;.google.cloud.discoveryengine.v1be" + + "ta.ImportDocumentsRequest\032\035.google.longr" + + "unning.Operation\"\276\002\202\323\344\223\002\272\001\"P/v1beta/{par" + + "ent=projects/*/locations/*/dataStores/*/" + + "branches/*}/documents:import:\001*Zc\"^/v1be" + + "ta/{parent=projects/*/locations/*/collec" + + "tions/*/dataStores/*/branches/*}/documen" + + "ts:import:\001*\312Az\n;google.cloud.discoverye" + + "ngine.v1beta.ImportDocumentsResponse\022;go" + + "ogle.cloud.discoveryengine.v1beta.Import" + + "DocumentsMetadata\022\250\003\n\016PurgeDocuments\022:.g" + + "oogle.cloud.discoveryengine.v1beta.Purge" + + "DocumentsRequest\032\035.google.longrunning.Op" + + "eration\"\272\002\202\323\344\223\002\270\001\"O/v1beta/{parent=proje" + + "cts/*/locations/*/dataStores/*/branches/" + + "*}/documents:purge:\001*Zb\"]/v1beta/{parent" + + "=projects/*/locations/*/collections/*/da" + + "taStores/*/branches/*}/documents:purge:\001" + + "*\312Ax\n:google.cloud.discoveryengine.v1bet" + + "a.PurgeDocumentsResponse\022:google.cloud.d" + + "iscoveryengine.v1beta.PurgeDocumentsMeta" + + "data\032R\312A\036discoveryengine.googleapis.com\322" + + "A.https://www.googleapis.com/auth/cloud-" + + "platformB\233\002\n\'com.google.cloud.discoverye" + + "ngine.v1betaB\024DocumentServiceProtoP\001ZQcl" + + "oud.google.com/go/discoveryengine/apiv1b" + + "eta/discoveryenginepb;discoveryenginepb\242" + + "\002\017DISCOVERYENGINE\252\002#Google.Cloud.Discove" + + "ryEngine.V1Beta\312\002#Google\\Cloud\\Discovery" + + "Engine\\V1beta\352\002&Google::Cloud::Discovery" + + "Engine::V1betab\006proto3" }; descriptor = com.google.protobuf.Descriptors.FileDescriptor.internalBuildGeneratedFileFrom( @@ -160,6 +172,7 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() { com.google.api.ResourceProto.getDescriptor(), com.google.cloud.discoveryengine.v1beta.DocumentProto.getDescriptor(), com.google.cloud.discoveryengine.v1beta.ImportConfigProto.getDescriptor(), + com.google.cloud.discoveryengine.v1beta.PurgeConfigProto.getDescriptor(), com.google.longrunning.OperationsProto.getDescriptor(), com.google.protobuf.EmptyProto.getDescriptor(), }); @@ -228,6 +241,7 @@ public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() { com.google.api.ResourceProto.getDescriptor(); com.google.cloud.discoveryengine.v1beta.DocumentProto.getDescriptor(); com.google.cloud.discoveryengine.v1beta.ImportConfigProto.getDescriptor(); + com.google.cloud.discoveryengine.v1beta.PurgeConfigProto.getDescriptor(); com.google.longrunning.OperationsProto.getDescriptor(); com.google.protobuf.EmptyProto.getDescriptor(); } diff --git a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeConfigProto.java b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeConfigProto.java new file mode 100644 index 000000000000..d074823510c9 --- /dev/null +++ b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeConfigProto.java @@ -0,0 +1,119 @@ +/* + * Copyright 2020 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 + * + * https://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. + */ +// Generated by the protocol buffer compiler. DO NOT EDIT! +// source: google/cloud/discoveryengine/v1beta/purge_config.proto + +package com.google.cloud.discoveryengine.v1beta; + +public final class PurgeConfigProto { + private PurgeConfigProto() {} + + public static void registerAllExtensions(com.google.protobuf.ExtensionRegistryLite registry) {} + + public static void registerAllExtensions(com.google.protobuf.ExtensionRegistry registry) { + registerAllExtensions((com.google.protobuf.ExtensionRegistryLite) registry); + } + + static final com.google.protobuf.Descriptors.Descriptor + internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsRequest_descriptor; + static final com.google.protobuf.GeneratedMessageV3.FieldAccessorTable + internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsRequest_fieldAccessorTable; + static final com.google.protobuf.Descriptors.Descriptor + internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsResponse_descriptor; + static final com.google.protobuf.GeneratedMessageV3.FieldAccessorTable + internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsResponse_fieldAccessorTable; + static final com.google.protobuf.Descriptors.Descriptor + internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsMetadata_descriptor; + static final com.google.protobuf.GeneratedMessageV3.FieldAccessorTable + internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsMetadata_fieldAccessorTable; + + public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor() { + return descriptor; + } + + private static com.google.protobuf.Descriptors.FileDescriptor descriptor; + + static { + java.lang.String[] descriptorData = { + "\n6google/cloud/discoveryengine/v1beta/pu" + + "rge_config.proto\022#google.cloud.discovery" + + "engine.v1beta\032\037google/api/field_behavior" + + ".proto\032\031google/api/resource.proto\032\037googl" + + "e/protobuf/timestamp.proto\"z\n\025PurgeDocum" + + "entsRequest\022=\n\006parent\030\001 \001(\tB-\340A\002\372A\'\n%dis" + + "coveryengine.googleapis.com/Branch\022\023\n\006fi" + + "lter\030\002 \001(\tB\003\340A\002\022\r\n\005force\030\003 \001(\010\"q\n\026PurgeD" + + "ocumentsResponse\022\023\n\013purge_count\030\001 \001(\003\022B\n" + + "\014purge_sample\030\002 \003(\tB,\372A)\n\'discoveryengin" + + "e.googleapis.com/Document\"\250\001\n\026PurgeDocum" + + "entsMetadata\022/\n\013create_time\030\001 \001(\0132\032.goog" + + "le.protobuf.Timestamp\022/\n\013update_time\030\002 \001" + + "(\0132\032.google.protobuf.Timestamp\022\025\n\rsucces" + + "s_count\030\003 \001(\003\022\025\n\rfailure_count\030\004 \001(\003B\227\002\n" + + "\'com.google.cloud.discoveryengine.v1beta" + + "B\020PurgeConfigProtoP\001ZQcloud.google.com/g" + + "o/discoveryengine/apiv1beta/discoveryeng" + + "inepb;discoveryenginepb\242\002\017DISCOVERYENGIN" + + "E\252\002#Google.Cloud.DiscoveryEngine.V1Beta\312" + + "\002#Google\\Cloud\\DiscoveryEngine\\V1beta\352\002&" + + "Google::Cloud::DiscoveryEngine::V1betab\006" + + "proto3" + }; + descriptor = + com.google.protobuf.Descriptors.FileDescriptor.internalBuildGeneratedFileFrom( + descriptorData, + new com.google.protobuf.Descriptors.FileDescriptor[] { + com.google.api.FieldBehaviorProto.getDescriptor(), + com.google.api.ResourceProto.getDescriptor(), + com.google.protobuf.TimestampProto.getDescriptor(), + }); + internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsRequest_descriptor = + getDescriptor().getMessageTypes().get(0); + internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsRequest_fieldAccessorTable = + new com.google.protobuf.GeneratedMessageV3.FieldAccessorTable( + internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsRequest_descriptor, + new java.lang.String[] { + "Parent", "Filter", "Force", + }); + internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsResponse_descriptor = + getDescriptor().getMessageTypes().get(1); + internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsResponse_fieldAccessorTable = + new com.google.protobuf.GeneratedMessageV3.FieldAccessorTable( + internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsResponse_descriptor, + new java.lang.String[] { + "PurgeCount", "PurgeSample", + }); + internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsMetadata_descriptor = + getDescriptor().getMessageTypes().get(2); + internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsMetadata_fieldAccessorTable = + new com.google.protobuf.GeneratedMessageV3.FieldAccessorTable( + internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsMetadata_descriptor, + new java.lang.String[] { + "CreateTime", "UpdateTime", "SuccessCount", "FailureCount", + }); + com.google.protobuf.ExtensionRegistry registry = + com.google.protobuf.ExtensionRegistry.newInstance(); + registry.add(com.google.api.FieldBehaviorProto.fieldBehavior); + registry.add(com.google.api.ResourceProto.resourceReference); + com.google.protobuf.Descriptors.FileDescriptor.internalUpdateFileDescriptor( + descriptor, registry); + com.google.api.FieldBehaviorProto.getDescriptor(); + com.google.api.ResourceProto.getDescriptor(); + com.google.protobuf.TimestampProto.getDescriptor(); + } + + // @@protoc_insertion_point(outer_class_scope) +} diff --git a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeDocumentsMetadata.java b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeDocumentsMetadata.java new file mode 100644 index 000000000000..b30576cc3593 --- /dev/null +++ b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeDocumentsMetadata.java @@ -0,0 +1,1173 @@ +/* + * Copyright 2020 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 + * + * https://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. + */ +// Generated by the protocol buffer compiler. DO NOT EDIT! +// source: google/cloud/discoveryengine/v1beta/purge_config.proto + +package com.google.cloud.discoveryengine.v1beta; + +/** + * + * + * 
+ * Metadata related to the progress of the PurgeDocuments operation.
+ * This will be returned by the google.longrunning.Operation.metadata field.
+ *
+ * + * Protobuf type {@code google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata} + */ +public final class PurgeDocumentsMetadata extends com.google.protobuf.GeneratedMessageV3 + implements + // @@protoc_insertion_point(message_implements:google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata) + PurgeDocumentsMetadataOrBuilder { + private static final long serialVersionUID = 0L; + // Use PurgeDocumentsMetadata.newBuilder() to construct. + private PurgeDocumentsMetadata(com.google.protobuf.GeneratedMessageV3.Builder builder) { + super(builder); + } + + private PurgeDocumentsMetadata() {} + + @java.lang.Override + @SuppressWarnings({"unused"}) + protected java.lang.Object newInstance(UnusedPrivateParameter unused) { + return new PurgeDocumentsMetadata(); + } + + @java.lang.Override + public final com.google.protobuf.UnknownFieldSet getUnknownFields() { + return this.unknownFields; + } + + public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { + return com.google.cloud.discoveryengine.v1beta.PurgeConfigProto + .internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsMetadata_descriptor; + } + + @java.lang.Override + protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable + internalGetFieldAccessorTable() { + return com.google.cloud.discoveryengine.v1beta.PurgeConfigProto + .internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsMetadata_fieldAccessorTable + .ensureFieldAccessorsInitialized( + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata.class, + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata.Builder.class); + } + + public static final int CREATE_TIME_FIELD_NUMBER = 1; + private com.google.protobuf.Timestamp createTime_; + /** + * + * + * 
+   * Operation create time.
+   *
+ * + * .google.protobuf.Timestamp create_time = 1; + * + * @return Whether the createTime field is set. + */ + @java.lang.Override + public boolean hasCreateTime() { + return createTime_ != null; + } + /** + * + * + * 
+   * Operation create time.
+   *
+ * + * .google.protobuf.Timestamp create_time = 1; + * + * @return The createTime. + */ + @java.lang.Override + public com.google.protobuf.Timestamp getCreateTime() { + return createTime_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : createTime_; + } + /** + * + * + * 
+   * Operation create time.
+   *
+ * + * .google.protobuf.Timestamp create_time = 1; + */ + @java.lang.Override + public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder() { + return createTime_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : createTime_; + } + + public static final int UPDATE_TIME_FIELD_NUMBER = 2; + private com.google.protobuf.Timestamp updateTime_; + /** + * + * + * 
+   * Operation last update time. If the operation is done, this is also the
+   * finish time.
+   *
+ * + * .google.protobuf.Timestamp update_time = 2; + * + * @return Whether the updateTime field is set. + */ + @java.lang.Override + public boolean hasUpdateTime() { + return updateTime_ != null; + } + /** + * + * + * 
+   * Operation last update time. If the operation is done, this is also the
+   * finish time.
+   *
+ * + * .google.protobuf.Timestamp update_time = 2; + * + * @return The updateTime. + */ + @java.lang.Override + public com.google.protobuf.Timestamp getUpdateTime() { + return updateTime_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : updateTime_; + } + /** + * + * + * 
+   * Operation last update time. If the operation is done, this is also the
+   * finish time.
+   *
+ * + * .google.protobuf.Timestamp update_time = 2; + */ + @java.lang.Override + public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder() { + return updateTime_ == null ? com.google.protobuf.Timestamp.getDefaultInstance() : updateTime_; + } + + public static final int SUCCESS_COUNT_FIELD_NUMBER = 3; + private long successCount_ = 0L; + /** + * + * + * 
+   * Count of entries that were deleted successfully.
+   *
+ * + * int64 success_count = 3; + * + * @return The successCount. + */ + @java.lang.Override + public long getSuccessCount() { + return successCount_; + } + + public static final int FAILURE_COUNT_FIELD_NUMBER = 4; + private long failureCount_ = 0L; + /** + * + * + * 
+   * Count of entries that encountered errors while processing.
+   *
+ * + * int64 failure_count = 4; + * + * @return The failureCount. + */ + @java.lang.Override + public long getFailureCount() { + return failureCount_; + } + + private byte memoizedIsInitialized = -1; + + @java.lang.Override + public final boolean isInitialized() { + byte isInitialized = memoizedIsInitialized; + if (isInitialized == 1) return true; + if (isInitialized == 0) return false; + + memoizedIsInitialized = 1; + return true; + } + + @java.lang.Override + public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException { + if (createTime_ != null) { + output.writeMessage(1, getCreateTime()); + } + if (updateTime_ != null) { + output.writeMessage(2, getUpdateTime()); + } + if (successCount_ != 0L) { + output.writeInt64(3, successCount_); + } + if (failureCount_ != 0L) { + output.writeInt64(4, failureCount_); + } + getUnknownFields().writeTo(output); + } + + @java.lang.Override + public int getSerializedSize() { + int size = memoizedSize; + if (size != -1) return size; + + size = 0; + if (createTime_ != null) { + size += com.google.protobuf.CodedOutputStream.computeMessageSize(1, getCreateTime()); + } + if (updateTime_ != null) { + size += com.google.protobuf.CodedOutputStream.computeMessageSize(2, getUpdateTime()); + } + if (successCount_ != 0L) { + size += com.google.protobuf.CodedOutputStream.computeInt64Size(3, successCount_); + } + if (failureCount_ != 0L) { + size += com.google.protobuf.CodedOutputStream.computeInt64Size(4, failureCount_); + } + size += getUnknownFields().getSerializedSize(); + memoizedSize = size; + return size; + } + + @java.lang.Override + public boolean equals(final java.lang.Object obj) { + if (obj == this) { + return true; + } + if (!(obj instanceof com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata)) { + return super.equals(obj); + } + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata other = + (com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata) obj; + + if (hasCreateTime() != other.hasCreateTime()) return false; + if (hasCreateTime()) { + if (!getCreateTime().equals(other.getCreateTime())) return false; + } + if (hasUpdateTime() != other.hasUpdateTime()) return false; + if (hasUpdateTime()) { + if (!getUpdateTime().equals(other.getUpdateTime())) return false; + } + if (getSuccessCount() != other.getSuccessCount()) return false; + if (getFailureCount() != other.getFailureCount()) return false; + if (!getUnknownFields().equals(other.getUnknownFields())) return false; + return true; + } + + @java.lang.Override + public int hashCode() { + if (memoizedHashCode != 0) { + return memoizedHashCode; + } + int hash = 41; + hash = (19 * hash) + getDescriptor().hashCode(); + if (hasCreateTime()) { + hash = (37 * hash) + CREATE_TIME_FIELD_NUMBER; + hash = (53 * hash) + getCreateTime().hashCode(); + } + if (hasUpdateTime()) { + hash = (37 * hash) + UPDATE_TIME_FIELD_NUMBER; + hash = (53 * hash) + getUpdateTime().hashCode(); + } + hash = (37 * hash) + SUCCESS_COUNT_FIELD_NUMBER; + hash = (53 * hash) + com.google.protobuf.Internal.hashLong(getSuccessCount()); + hash = (37 * hash) + FAILURE_COUNT_FIELD_NUMBER; + hash = (53 * hash) + com.google.protobuf.Internal.hashLong(getFailureCount()); + hash = (29 * hash) + getUnknownFields().hashCode(); + memoizedHashCode = hash; + return hash; + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata parseFrom( + java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException { + return PARSER.parseFrom(data); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata parseFrom( + java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException { + return PARSER.parseFrom(data, extensionRegistry); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata parseFrom( + com.google.protobuf.ByteString data) + throws com.google.protobuf.InvalidProtocolBufferException { + return PARSER.parseFrom(data); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata parseFrom( + com.google.protobuf.ByteString data, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException { + return PARSER.parseFrom(data, extensionRegistry); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata parseFrom( + byte[] data) throws com.google.protobuf.InvalidProtocolBufferException { + return PARSER.parseFrom(data); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata parseFrom( + byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException { + return PARSER.parseFrom(data, extensionRegistry); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata parseFrom( + java.io.InputStream input) throws java.io.IOException { + return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata parseFrom( + java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws java.io.IOException { + return com.google.protobuf.GeneratedMessageV3.parseWithIOException( + PARSER, input, extensionRegistry); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata parseDelimitedFrom( + java.io.InputStream input) throws java.io.IOException { + return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException(PARSER, input); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata parseDelimitedFrom( + java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws java.io.IOException { + return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException( + PARSER, input, extensionRegistry); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata parseFrom( + com.google.protobuf.CodedInputStream input) throws java.io.IOException { + return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata parseFrom( + com.google.protobuf.CodedInputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws java.io.IOException { + return com.google.protobuf.GeneratedMessageV3.parseWithIOException( + PARSER, input, extensionRegistry); + } + + @java.lang.Override + public Builder newBuilderForType() { + return newBuilder(); + } + + public static Builder newBuilder() { + return DEFAULT_INSTANCE.toBuilder(); + } + + public static Builder newBuilder( + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata prototype) { + return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype); + } + + @java.lang.Override + public Builder toBuilder() { + return this == DEFAULT_INSTANCE ? new Builder() : new Builder().mergeFrom(this); + } + + @java.lang.Override + protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) { + Builder builder = new Builder(parent); + return builder; + } + /** + * + * + * 
+   * Metadata related to the progress of the PurgeDocuments operation.
+   * This will be returned by the google.longrunning.Operation.metadata field.
+   *
+ * + * Protobuf type {@code google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata} + */ + public static final class Builder extends com.google.protobuf.GeneratedMessageV3.Builder + implements + // @@protoc_insertion_point(builder_implements:google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata) + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadataOrBuilder { + public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { + return com.google.cloud.discoveryengine.v1beta.PurgeConfigProto + .internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsMetadata_descriptor; + } + + @java.lang.Override + protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable + internalGetFieldAccessorTable() { + return com.google.cloud.discoveryengine.v1beta.PurgeConfigProto + .internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsMetadata_fieldAccessorTable + .ensureFieldAccessorsInitialized( + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata.class, + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata.Builder.class); + } + + // Construct using com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata.newBuilder() + private Builder() {} + + private Builder(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) { + super(parent); + } + + @java.lang.Override + public Builder clear() { + super.clear(); + bitField0_ = 0; + createTime_ = null; + if (createTimeBuilder_ != null) { + createTimeBuilder_.dispose(); + createTimeBuilder_ = null; + } + updateTime_ = null; + if (updateTimeBuilder_ != null) { + updateTimeBuilder_.dispose(); + updateTimeBuilder_ = null; + } + successCount_ = 0L; + failureCount_ = 0L; + return this; + } + + @java.lang.Override + public com.google.protobuf.Descriptors.Descriptor getDescriptorForType() { + return com.google.cloud.discoveryengine.v1beta.PurgeConfigProto + .internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsMetadata_descriptor; + } + + @java.lang.Override + public com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata + getDefaultInstanceForType() { + return com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata.getDefaultInstance(); + } + + @java.lang.Override + public com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata build() { + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata result = buildPartial(); + if (!result.isInitialized()) { + throw newUninitializedMessageException(result); + } + return result; + } + + @java.lang.Override + public com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata buildPartial() { + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata result = + new com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata(this); + if (bitField0_ != 0) { + buildPartial0(result); + } + onBuilt(); + return result; + } + + private void buildPartial0( + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata result) { + int from_bitField0_ = bitField0_; + if (((from_bitField0_ & 0x00000001) != 0)) { + result.createTime_ = createTimeBuilder_ == null ? createTime_ : createTimeBuilder_.build(); + } + if (((from_bitField0_ & 0x00000002) != 0)) { + result.updateTime_ = updateTimeBuilder_ == null ? updateTime_ : updateTimeBuilder_.build(); + } + if (((from_bitField0_ & 0x00000004) != 0)) { + result.successCount_ = successCount_; + } + if (((from_bitField0_ & 0x00000008) != 0)) { + result.failureCount_ = failureCount_; + } + } + + @java.lang.Override + public Builder clone() { + return super.clone(); + } + + @java.lang.Override + public Builder setField( + com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value) { + return super.setField(field, value); + } + + @java.lang.Override + public Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) { + return super.clearField(field); + } + + @java.lang.Override + public Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) { + return super.clearOneof(oneof); + } + + @java.lang.Override + public Builder setRepeatedField( + com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value) { + return super.setRepeatedField(field, index, value); + } + + @java.lang.Override + public Builder addRepeatedField( + com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value) { + return super.addRepeatedField(field, value); + } + + @java.lang.Override + public Builder mergeFrom(com.google.protobuf.Message other) { + if (other instanceof com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata) { + return mergeFrom((com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata) other); + } else { + super.mergeFrom(other); + return this; + } + } + + public Builder mergeFrom(com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata other) { + if (other + == com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata.getDefaultInstance()) + return this; + if (other.hasCreateTime()) { + mergeCreateTime(other.getCreateTime()); + } + if (other.hasUpdateTime()) { + mergeUpdateTime(other.getUpdateTime()); + } + if (other.getSuccessCount() != 0L) { + setSuccessCount(other.getSuccessCount()); + } + if (other.getFailureCount() != 0L) { + setFailureCount(other.getFailureCount()); + } + this.mergeUnknownFields(other.getUnknownFields()); + onChanged(); + return this; + } + + @java.lang.Override + public final boolean isInitialized() { + return true; + } + + @java.lang.Override + public Builder mergeFrom( + com.google.protobuf.CodedInputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws java.io.IOException { + if (extensionRegistry == null) { + throw new java.lang.NullPointerException(); + } + try { + boolean done = false; + while (!done) { + int tag = input.readTag(); + switch (tag) { + case 0: + done = true; + break; + case 10: + { + input.readMessage(getCreateTimeFieldBuilder().getBuilder(), extensionRegistry); + bitField0_ |= 0x00000001; + break; + } // case 10 + case 18: + { + input.readMessage(getUpdateTimeFieldBuilder().getBuilder(), extensionRegistry); + bitField0_ |= 0x00000002; + break; + } // case 18 + case 24: + { + successCount_ = input.readInt64(); + bitField0_ |= 0x00000004; + break; + } // case 24 + case 32: + { + failureCount_ = input.readInt64(); + bitField0_ |= 0x00000008; + break; + } // case 32 + default: + { + if (!super.parseUnknownField(input, extensionRegistry, tag)) { + done = true; // was an endgroup tag + } + break; + } // default: + } // switch (tag) + } // while (!done) + } catch (com.google.protobuf.InvalidProtocolBufferException e) { + throw e.unwrapIOException(); + } finally { + onChanged(); + } // finally + return this; + } + + private int bitField0_; + + private com.google.protobuf.Timestamp createTime_; + private com.google.protobuf.SingleFieldBuilderV3< + com.google.protobuf.Timestamp, + com.google.protobuf.Timestamp.Builder, + com.google.protobuf.TimestampOrBuilder> + createTimeBuilder_; + /** + * + * + * 
+     * Operation create time.
+     *
+ * + * .google.protobuf.Timestamp create_time = 1; + * + * @return Whether the createTime field is set. + */ + public boolean hasCreateTime() { + return ((bitField0_ & 0x00000001) != 0); + } + /** + * + * + * 
+     * Operation create time.
+     *
+ * + * .google.protobuf.Timestamp create_time = 1; + * + * @return The createTime. + */ + public com.google.protobuf.Timestamp getCreateTime() { + if (createTimeBuilder_ == null) { + return createTime_ == null + ? com.google.protobuf.Timestamp.getDefaultInstance() + : createTime_; + } else { + return createTimeBuilder_.getMessage(); + } + } + /** + * + * + * 
+     * Operation create time.
+     *
+ * + * .google.protobuf.Timestamp create_time = 1; + */ + public Builder setCreateTime(com.google.protobuf.Timestamp value) { + if (createTimeBuilder_ == null) { + if (value == null) { + throw new NullPointerException(); + } + createTime_ = value; + } else { + createTimeBuilder_.setMessage(value); + } + bitField0_ |= 0x00000001; + onChanged(); + return this; + } + /** + * + * + * 
+     * Operation create time.
+     *
+ * + * .google.protobuf.Timestamp create_time = 1; + */ + public Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue) { + if (createTimeBuilder_ == null) { + createTime_ = builderForValue.build(); + } else { + createTimeBuilder_.setMessage(builderForValue.build()); + } + bitField0_ |= 0x00000001; + onChanged(); + return this; + } + /** + * + * + * 
+     * Operation create time.
+     *
+ * + * .google.protobuf.Timestamp create_time = 1; + */ + public Builder mergeCreateTime(com.google.protobuf.Timestamp value) { + if (createTimeBuilder_ == null) { + if (((bitField0_ & 0x00000001) != 0) + && createTime_ != null + && createTime_ != com.google.protobuf.Timestamp.getDefaultInstance()) { + getCreateTimeBuilder().mergeFrom(value); + } else { + createTime_ = value; + } + } else { + createTimeBuilder_.mergeFrom(value); + } + bitField0_ |= 0x00000001; + onChanged(); + return this; + } + /** + * + * + * 
+     * Operation create time.
+     *
+ * + * .google.protobuf.Timestamp create_time = 1; + */ + public Builder clearCreateTime() { + bitField0_ = (bitField0_ & ~0x00000001); + createTime_ = null; + if (createTimeBuilder_ != null) { + createTimeBuilder_.dispose(); + createTimeBuilder_ = null; + } + onChanged(); + return this; + } + /** + * + * + * 
+     * Operation create time.
+     *
+ * + * .google.protobuf.Timestamp create_time = 1; + */ + public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder() { + bitField0_ |= 0x00000001; + onChanged(); + return getCreateTimeFieldBuilder().getBuilder(); + } + /** + * + * + * 
+     * Operation create time.
+     *
+ * + * .google.protobuf.Timestamp create_time = 1; + */ + public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder() { + if (createTimeBuilder_ != null) { + return createTimeBuilder_.getMessageOrBuilder(); + } else { + return createTime_ == null + ? com.google.protobuf.Timestamp.getDefaultInstance() + : createTime_; + } + } + /** + * + * + * 
+     * Operation create time.
+     *
+ * + * .google.protobuf.Timestamp create_time = 1; + */ + private com.google.protobuf.SingleFieldBuilderV3< + com.google.protobuf.Timestamp, + com.google.protobuf.Timestamp.Builder, + com.google.protobuf.TimestampOrBuilder> + getCreateTimeFieldBuilder() { + if (createTimeBuilder_ == null) { + createTimeBuilder_ = + new com.google.protobuf.SingleFieldBuilderV3< + com.google.protobuf.Timestamp, + com.google.protobuf.Timestamp.Builder, + com.google.protobuf.TimestampOrBuilder>( + getCreateTime(), getParentForChildren(), isClean()); + createTime_ = null; + } + return createTimeBuilder_; + } + + private com.google.protobuf.Timestamp updateTime_; + private com.google.protobuf.SingleFieldBuilderV3< + com.google.protobuf.Timestamp, + com.google.protobuf.Timestamp.Builder, + com.google.protobuf.TimestampOrBuilder> + updateTimeBuilder_; + /** + * + * + * 
+     * Operation last update time. If the operation is done, this is also the
+     * finish time.
+     *
+ * + * .google.protobuf.Timestamp update_time = 2; + * + * @return Whether the updateTime field is set. + */ + public boolean hasUpdateTime() { + return ((bitField0_ & 0x00000002) != 0); + } + /** + * + * + * 
+     * Operation last update time. If the operation is done, this is also the
+     * finish time.
+     *
+ * + * .google.protobuf.Timestamp update_time = 2; + * + * @return The updateTime. + */ + public com.google.protobuf.Timestamp getUpdateTime() { + if (updateTimeBuilder_ == null) { + return updateTime_ == null + ? com.google.protobuf.Timestamp.getDefaultInstance() + : updateTime_; + } else { + return updateTimeBuilder_.getMessage(); + } + } + /** + * + * + * 
+     * Operation last update time. If the operation is done, this is also the
+     * finish time.
+     *
+ * + * .google.protobuf.Timestamp update_time = 2; + */ + public Builder setUpdateTime(com.google.protobuf.Timestamp value) { + if (updateTimeBuilder_ == null) { + if (value == null) { + throw new NullPointerException(); + } + updateTime_ = value; + } else { + updateTimeBuilder_.setMessage(value); + } + bitField0_ |= 0x00000002; + onChanged(); + return this; + } + /** + * + * + * 
+     * Operation last update time. If the operation is done, this is also the
+     * finish time.
+     *
+ * + * .google.protobuf.Timestamp update_time = 2; + */ + public Builder setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue) { + if (updateTimeBuilder_ == null) { + updateTime_ = builderForValue.build(); + } else { + updateTimeBuilder_.setMessage(builderForValue.build()); + } + bitField0_ |= 0x00000002; + onChanged(); + return this; + } + /** + * + * + * 
+     * Operation last update time. If the operation is done, this is also the
+     * finish time.
+     *
+ * + * .google.protobuf.Timestamp update_time = 2; + */ + public Builder mergeUpdateTime(com.google.protobuf.Timestamp value) { + if (updateTimeBuilder_ == null) { + if (((bitField0_ & 0x00000002) != 0) + && updateTime_ != null + && updateTime_ != com.google.protobuf.Timestamp.getDefaultInstance()) { + getUpdateTimeBuilder().mergeFrom(value); + } else { + updateTime_ = value; + } + } else { + updateTimeBuilder_.mergeFrom(value); + } + bitField0_ |= 0x00000002; + onChanged(); + return this; + } + /** + * + * + * 
+     * Operation last update time. If the operation is done, this is also the
+     * finish time.
+     *
+ * + * .google.protobuf.Timestamp update_time = 2; + */ + public Builder clearUpdateTime() { + bitField0_ = (bitField0_ & ~0x00000002); + updateTime_ = null; + if (updateTimeBuilder_ != null) { + updateTimeBuilder_.dispose(); + updateTimeBuilder_ = null; + } + onChanged(); + return this; + } + /** + * + * + * 
+     * Operation last update time. If the operation is done, this is also the
+     * finish time.
+     *
+ * + * .google.protobuf.Timestamp update_time = 2; + */ + public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder() { + bitField0_ |= 0x00000002; + onChanged(); + return getUpdateTimeFieldBuilder().getBuilder(); + } + /** + * + * + * 
+     * Operation last update time. If the operation is done, this is also the
+     * finish time.
+     *
+ * + * .google.protobuf.Timestamp update_time = 2; + */ + public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder() { + if (updateTimeBuilder_ != null) { + return updateTimeBuilder_.getMessageOrBuilder(); + } else { + return updateTime_ == null + ? com.google.protobuf.Timestamp.getDefaultInstance() + : updateTime_; + } + } + /** + * + * + * 
+     * Operation last update time. If the operation is done, this is also the
+     * finish time.
+     *
+ * + * .google.protobuf.Timestamp update_time = 2; + */ + private com.google.protobuf.SingleFieldBuilderV3< + com.google.protobuf.Timestamp, + com.google.protobuf.Timestamp.Builder, + com.google.protobuf.TimestampOrBuilder> + getUpdateTimeFieldBuilder() { + if (updateTimeBuilder_ == null) { + updateTimeBuilder_ = + new com.google.protobuf.SingleFieldBuilderV3< + com.google.protobuf.Timestamp, + com.google.protobuf.Timestamp.Builder, + com.google.protobuf.TimestampOrBuilder>( + getUpdateTime(), getParentForChildren(), isClean()); + updateTime_ = null; + } + return updateTimeBuilder_; + } + + private long successCount_; + /** + * + * + * 
+     * Count of entries that were deleted successfully.
+     *
+ * + * int64 success_count = 3; + * + * @return The successCount. + */ + @java.lang.Override + public long getSuccessCount() { + return successCount_; + } + /** + * + * + * 
+     * Count of entries that were deleted successfully.
+     *
+ * + * int64 success_count = 3; + * + * @param value The successCount to set. + * @return This builder for chaining. + */ + public Builder setSuccessCount(long value) { + + successCount_ = value; + bitField0_ |= 0x00000004; + onChanged(); + return this; + } + /** + * + * + * 
+     * Count of entries that were deleted successfully.
+     *
+ * + * int64 success_count = 3; + * + * @return This builder for chaining. + */ + public Builder clearSuccessCount() { + bitField0_ = (bitField0_ & ~0x00000004); + successCount_ = 0L; + onChanged(); + return this; + } + + private long failureCount_; + /** + * + * + * 
+     * Count of entries that encountered errors while processing.
+     *
+ * + * int64 failure_count = 4; + * + * @return The failureCount. + */ + @java.lang.Override + public long getFailureCount() { + return failureCount_; + } + /** + * + * + * 
+     * Count of entries that encountered errors while processing.
+     *
+ * + * int64 failure_count = 4; + * + * @param value The failureCount to set. + * @return This builder for chaining. + */ + public Builder setFailureCount(long value) { + + failureCount_ = value; + bitField0_ |= 0x00000008; + onChanged(); + return this; + } + /** + * + * + * 
+     * Count of entries that encountered errors while processing.
+     *
+ * + * int64 failure_count = 4; + * + * @return This builder for chaining. + */ + public Builder clearFailureCount() { + bitField0_ = (bitField0_ & ~0x00000008); + failureCount_ = 0L; + onChanged(); + return this; + } + + @java.lang.Override + public final Builder setUnknownFields(final com.google.protobuf.UnknownFieldSet unknownFields) { + return super.setUnknownFields(unknownFields); + } + + @java.lang.Override + public final Builder mergeUnknownFields( + final com.google.protobuf.UnknownFieldSet unknownFields) { + return super.mergeUnknownFields(unknownFields); + } + + // @@protoc_insertion_point(builder_scope:google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata) + } + + // @@protoc_insertion_point(class_scope:google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata) + private static final com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata + DEFAULT_INSTANCE; + + static { + DEFAULT_INSTANCE = new com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata(); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata + getDefaultInstance() { + return DEFAULT_INSTANCE; + } + + private static final com.google.protobuf.Parser PARSER = + new com.google.protobuf.AbstractParser() { + @java.lang.Override + public PurgeDocumentsMetadata parsePartialFrom( + com.google.protobuf.CodedInputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException { + Builder builder = newBuilder(); + try { + builder.mergeFrom(input, extensionRegistry); + } catch (com.google.protobuf.InvalidProtocolBufferException e) { + throw e.setUnfinishedMessage(builder.buildPartial()); + } catch (com.google.protobuf.UninitializedMessageException e) { + throw e.asInvalidProtocolBufferException().setUnfinishedMessage(builder.buildPartial()); + } catch (java.io.IOException e) { + throw new com.google.protobuf.InvalidProtocolBufferException(e) + .setUnfinishedMessage(builder.buildPartial()); + } + return builder.buildPartial(); + } + }; + + public static com.google.protobuf.Parser parser() { + return PARSER; + } + + @java.lang.Override + public com.google.protobuf.Parser getParserForType() { + return PARSER; + } + + @java.lang.Override + public com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata + getDefaultInstanceForType() { + return DEFAULT_INSTANCE; + } +} diff --git a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeDocumentsMetadataOrBuilder.java b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeDocumentsMetadataOrBuilder.java new file mode 100644 index 000000000000..ecb70a50f2ed --- /dev/null +++ b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeDocumentsMetadataOrBuilder.java @@ -0,0 +1,124 @@ +/* + * Copyright 2020 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 + * + * https://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. + */ +// Generated by the protocol buffer compiler. DO NOT EDIT! +// source: google/cloud/discoveryengine/v1beta/purge_config.proto + +package com.google.cloud.discoveryengine.v1beta; + +public interface PurgeDocumentsMetadataOrBuilder + extends + // @@protoc_insertion_point(interface_extends:google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata) + com.google.protobuf.MessageOrBuilder { + + /** + * + * + * 
+   * Operation create time.
+   *
+ * + * .google.protobuf.Timestamp create_time = 1; + * + * @return Whether the createTime field is set. + */ + boolean hasCreateTime(); + /** + * + * + * 
+   * Operation create time.
+   *
+ * + * .google.protobuf.Timestamp create_time = 1; + * + * @return The createTime. + */ + com.google.protobuf.Timestamp getCreateTime(); + /** + * + * + * 
+   * Operation create time.
+   *
+ * + * .google.protobuf.Timestamp create_time = 1; + */ + com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder(); + + /** + * + * + * 
+   * Operation last update time. If the operation is done, this is also the
+   * finish time.
+   *
+ * + * .google.protobuf.Timestamp update_time = 2; + * + * @return Whether the updateTime field is set. + */ + boolean hasUpdateTime(); + /** + * + * + * 
+   * Operation last update time. If the operation is done, this is also the
+   * finish time.
+   *
+ * + * .google.protobuf.Timestamp update_time = 2; + * + * @return The updateTime. + */ + com.google.protobuf.Timestamp getUpdateTime(); + /** + * + * + * 
+   * Operation last update time. If the operation is done, this is also the
+   * finish time.
+   *
+ * + * .google.protobuf.Timestamp update_time = 2; + */ + com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder(); + + /** + * + * + * 
+   * Count of entries that were deleted successfully.
+   *
+ * + * int64 success_count = 3; + * + * @return The successCount. + */ + long getSuccessCount(); + + /** + * + * + * 
+   * Count of entries that encountered errors while processing.
+   *
+ * + * int64 failure_count = 4; + * + * @return The failureCount. + */ + long getFailureCount(); +} diff --git a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeDocumentsRequest.java b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeDocumentsRequest.java new file mode 100644 index 000000000000..63bd2f9bd8c1 --- /dev/null +++ b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeDocumentsRequest.java @@ -0,0 +1,952 @@ +/* + * Copyright 2020 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 + * + * https://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. + */ +// Generated by the protocol buffer compiler. DO NOT EDIT! +// source: google/cloud/discoveryengine/v1beta/purge_config.proto + +package com.google.cloud.discoveryengine.v1beta; + +/** + * + * + * 
+ * Request message for
+ * [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments]
+ * method.
+ *
+ * + * Protobuf type {@code google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest} + */ +public final class PurgeDocumentsRequest extends com.google.protobuf.GeneratedMessageV3 + implements + // @@protoc_insertion_point(message_implements:google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest) + PurgeDocumentsRequestOrBuilder { + private static final long serialVersionUID = 0L; + // Use PurgeDocumentsRequest.newBuilder() to construct. + private PurgeDocumentsRequest(com.google.protobuf.GeneratedMessageV3.Builder builder) { + super(builder); + } + + private PurgeDocumentsRequest() { + parent_ = ""; + filter_ = ""; + } + + @java.lang.Override + @SuppressWarnings({"unused"}) + protected java.lang.Object newInstance(UnusedPrivateParameter unused) { + return new PurgeDocumentsRequest(); + } + + @java.lang.Override + public final com.google.protobuf.UnknownFieldSet getUnknownFields() { + return this.unknownFields; + } + + public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { + return com.google.cloud.discoveryengine.v1beta.PurgeConfigProto + .internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsRequest_descriptor; + } + + @java.lang.Override + protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable + internalGetFieldAccessorTable() { + return com.google.cloud.discoveryengine.v1beta.PurgeConfigProto + .internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsRequest_fieldAccessorTable + .ensureFieldAccessorsInitialized( + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.class, + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.Builder.class); + } + + public static final int PARENT_FIELD_NUMBER = 1; + + @SuppressWarnings("serial") + private volatile java.lang.Object parent_ = ""; + /** + * + * + * 
+   * 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) = { ... } + * + * + * @return The parent. + */ + @java.lang.Override + public java.lang.String getParent() { + java.lang.Object ref = parent_; + if (ref instanceof java.lang.String) { + return (java.lang.String) ref; + } else { + com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref; + java.lang.String s = bs.toStringUtf8(); + parent_ = s; + return s; + } + } + /** + * + * + * 
+   * 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) = { ... } + * + * + * @return The bytes for parent. + */ + @java.lang.Override + public com.google.protobuf.ByteString getParentBytes() { + java.lang.Object ref = parent_; + if (ref instanceof java.lang.String) { + com.google.protobuf.ByteString b = + com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref); + parent_ = b; + return b; + } else { + return (com.google.protobuf.ByteString) ref; + } + } + + public static final int FILTER_FIELD_NUMBER = 2; + + @SuppressWarnings("serial") + private volatile java.lang.Object filter_ = ""; + /** + * + * + * 
+   * Required. Filter matching documents to purge. Only currently supported
+   * value is
+   * `*` (all items).
+   *
+ * + * string filter = 2 [(.google.api.field_behavior) = REQUIRED]; + * + * @return The filter. + */ + @java.lang.Override + public java.lang.String getFilter() { + java.lang.Object ref = filter_; + if (ref instanceof java.lang.String) { + return (java.lang.String) ref; + } else { + com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref; + java.lang.String s = bs.toStringUtf8(); + filter_ = s; + return s; + } + } + /** + * + * + * 
+   * Required. Filter matching documents to purge. Only currently supported
+   * value is
+   * `*` (all items).
+   *
+ * + * string filter = 2 [(.google.api.field_behavior) = REQUIRED]; + * + * @return The bytes for filter. + */ + @java.lang.Override + public com.google.protobuf.ByteString getFilterBytes() { + java.lang.Object ref = filter_; + if (ref instanceof java.lang.String) { + com.google.protobuf.ByteString b = + com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref); + filter_ = b; + return b; + } else { + return (com.google.protobuf.ByteString) ref; + } + } + + public static final int FORCE_FIELD_NUMBER = 3; + private boolean force_ = false; + /** + * + * + * 
+   * Actually performs the purge. If `force` is set to false, return the
+   * expected purge count without deleting any documents.
+   *
+ * + * bool force = 3; + * + * @return The force. + */ + @java.lang.Override + public boolean getForce() { + return force_; + } + + private byte memoizedIsInitialized = -1; + + @java.lang.Override + public final boolean isInitialized() { + byte isInitialized = memoizedIsInitialized; + if (isInitialized == 1) return true; + if (isInitialized == 0) return false; + + memoizedIsInitialized = 1; + return true; + } + + @java.lang.Override + public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException { + if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(parent_)) { + com.google.protobuf.GeneratedMessageV3.writeString(output, 1, parent_); + } + if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(filter_)) { + com.google.protobuf.GeneratedMessageV3.writeString(output, 2, filter_); + } + if (force_ != false) { + output.writeBool(3, force_); + } + getUnknownFields().writeTo(output); + } + + @java.lang.Override + public int getSerializedSize() { + int size = memoizedSize; + if (size != -1) return size; + + size = 0; + if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(parent_)) { + size += com.google.protobuf.GeneratedMessageV3.computeStringSize(1, parent_); + } + if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(filter_)) { + size += com.google.protobuf.GeneratedMessageV3.computeStringSize(2, filter_); + } + if (force_ != false) { + size += com.google.protobuf.CodedOutputStream.computeBoolSize(3, force_); + } + size += getUnknownFields().getSerializedSize(); + memoizedSize = size; + return size; + } + + @java.lang.Override + public boolean equals(final java.lang.Object obj) { + if (obj == this) { + return true; + } + if (!(obj instanceof com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest)) { + return super.equals(obj); + } + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest other = + (com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest) obj; + + if (!getParent().equals(other.getParent())) return false; + if (!getFilter().equals(other.getFilter())) return false; + if (getForce() != other.getForce()) return false; + if (!getUnknownFields().equals(other.getUnknownFields())) return false; + return true; + } + + @java.lang.Override + public int hashCode() { + if (memoizedHashCode != 0) { + return memoizedHashCode; + } + int hash = 41; + hash = (19 * hash) + getDescriptor().hashCode(); + hash = (37 * hash) + PARENT_FIELD_NUMBER; + hash = (53 * hash) + getParent().hashCode(); + hash = (37 * hash) + FILTER_FIELD_NUMBER; + hash = (53 * hash) + getFilter().hashCode(); + hash = (37 * hash) + FORCE_FIELD_NUMBER; + hash = (53 * hash) + com.google.protobuf.Internal.hashBoolean(getForce()); + hash = (29 * hash) + getUnknownFields().hashCode(); + memoizedHashCode = hash; + return hash; + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest parseFrom( + java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException { + return PARSER.parseFrom(data); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest parseFrom( + java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException { + return PARSER.parseFrom(data, extensionRegistry); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest parseFrom( + com.google.protobuf.ByteString data) + throws com.google.protobuf.InvalidProtocolBufferException { + return PARSER.parseFrom(data); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest parseFrom( + com.google.protobuf.ByteString data, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException { + return PARSER.parseFrom(data, extensionRegistry); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest parseFrom(byte[] data) + throws com.google.protobuf.InvalidProtocolBufferException { + return PARSER.parseFrom(data); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest parseFrom( + byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException { + return PARSER.parseFrom(data, extensionRegistry); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest parseFrom( + java.io.InputStream input) throws java.io.IOException { + return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest parseFrom( + java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws java.io.IOException { + return com.google.protobuf.GeneratedMessageV3.parseWithIOException( + PARSER, input, extensionRegistry); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest parseDelimitedFrom( + java.io.InputStream input) throws java.io.IOException { + return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException(PARSER, input); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest parseDelimitedFrom( + java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws java.io.IOException { + return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException( + PARSER, input, extensionRegistry); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest parseFrom( + com.google.protobuf.CodedInputStream input) throws java.io.IOException { + return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest parseFrom( + com.google.protobuf.CodedInputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws java.io.IOException { + return com.google.protobuf.GeneratedMessageV3.parseWithIOException( + PARSER, input, extensionRegistry); + } + + @java.lang.Override + public Builder newBuilderForType() { + return newBuilder(); + } + + public static Builder newBuilder() { + return DEFAULT_INSTANCE.toBuilder(); + } + + public static Builder newBuilder( + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest prototype) { + return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype); + } + + @java.lang.Override + public Builder toBuilder() { + return this == DEFAULT_INSTANCE ? new Builder() : new Builder().mergeFrom(this); + } + + @java.lang.Override + protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) { + Builder builder = new Builder(parent); + return builder; + } + /** + * + * + * 
+   * Request message for
+   * [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments]
+   * method.
+   *
+ * + * Protobuf type {@code google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest} + */ + public static final class Builder extends com.google.protobuf.GeneratedMessageV3.Builder + implements + // @@protoc_insertion_point(builder_implements:google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest) + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequestOrBuilder { + public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { + return com.google.cloud.discoveryengine.v1beta.PurgeConfigProto + .internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsRequest_descriptor; + } + + @java.lang.Override + protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable + internalGetFieldAccessorTable() { + return com.google.cloud.discoveryengine.v1beta.PurgeConfigProto + .internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsRequest_fieldAccessorTable + .ensureFieldAccessorsInitialized( + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.class, + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.Builder.class); + } + + // Construct using com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.newBuilder() + private Builder() {} + + private Builder(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) { + super(parent); + } + + @java.lang.Override + public Builder clear() { + super.clear(); + bitField0_ = 0; + parent_ = ""; + filter_ = ""; + force_ = false; + return this; + } + + @java.lang.Override + public com.google.protobuf.Descriptors.Descriptor getDescriptorForType() { + return com.google.cloud.discoveryengine.v1beta.PurgeConfigProto + .internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsRequest_descriptor; + } + + @java.lang.Override + public com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest + getDefaultInstanceForType() { + return com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.getDefaultInstance(); + } + + @java.lang.Override + public com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest build() { + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest result = buildPartial(); + if (!result.isInitialized()) { + throw newUninitializedMessageException(result); + } + return result; + } + + @java.lang.Override + public com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest buildPartial() { + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest result = + new com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest(this); + if (bitField0_ != 0) { + buildPartial0(result); + } + onBuilt(); + return result; + } + + private void buildPartial0( + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest result) { + int from_bitField0_ = bitField0_; + if (((from_bitField0_ & 0x00000001) != 0)) { + result.parent_ = parent_; + } + if (((from_bitField0_ & 0x00000002) != 0)) { + result.filter_ = filter_; + } + if (((from_bitField0_ & 0x00000004) != 0)) { + result.force_ = force_; + } + } + + @java.lang.Override + public Builder clone() { + return super.clone(); + } + + @java.lang.Override + public Builder setField( + com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value) { + return super.setField(field, value); + } + + @java.lang.Override + public Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) { + return super.clearField(field); + } + + @java.lang.Override + public Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) { + return super.clearOneof(oneof); + } + + @java.lang.Override + public Builder setRepeatedField( + com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value) { + return super.setRepeatedField(field, index, value); + } + + @java.lang.Override + public Builder addRepeatedField( + com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value) { + return super.addRepeatedField(field, value); + } + + @java.lang.Override + public Builder mergeFrom(com.google.protobuf.Message other) { + if (other instanceof com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest) { + return mergeFrom((com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest) other); + } else { + super.mergeFrom(other); + return this; + } + } + + public Builder mergeFrom(com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest other) { + if (other + == com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.getDefaultInstance()) + return this; + if (!other.getParent().isEmpty()) { + parent_ = other.parent_; + bitField0_ |= 0x00000001; + onChanged(); + } + if (!other.getFilter().isEmpty()) { + filter_ = other.filter_; + bitField0_ |= 0x00000002; + onChanged(); + } + if (other.getForce() != false) { + setForce(other.getForce()); + } + this.mergeUnknownFields(other.getUnknownFields()); + onChanged(); + return this; + } + + @java.lang.Override + public final boolean isInitialized() { + return true; + } + + @java.lang.Override + public Builder mergeFrom( + com.google.protobuf.CodedInputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws java.io.IOException { + if (extensionRegistry == null) { + throw new java.lang.NullPointerException(); + } + try { + boolean done = false; + while (!done) { + int tag = input.readTag(); + switch (tag) { + case 0: + done = true; + break; + case 10: + { + parent_ = input.readStringRequireUtf8(); + bitField0_ |= 0x00000001; + break; + } // case 10 + case 18: + { + filter_ = input.readStringRequireUtf8(); + bitField0_ |= 0x00000002; + break; + } // case 18 + case 24: + { + force_ = input.readBool(); + bitField0_ |= 0x00000004; + break; + } // case 24 + default: + { + if (!super.parseUnknownField(input, extensionRegistry, tag)) { + done = true; // was an endgroup tag + } + break; + } // default: + } // switch (tag) + } // while (!done) + } catch (com.google.protobuf.InvalidProtocolBufferException e) { + throw e.unwrapIOException(); + } finally { + onChanged(); + } // finally + return this; + } + + private int bitField0_; + + private java.lang.Object parent_ = ""; + /** + * + * + * 
+     * 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) = { ... } + * + * + * @return The parent. + */ + public java.lang.String getParent() { + java.lang.Object ref = parent_; + if (!(ref instanceof java.lang.String)) { + com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref; + java.lang.String s = bs.toStringUtf8(); + parent_ = s; + return s; + } else { + return (java.lang.String) ref; + } + } + /** + * + * + * 
+     * 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) = { ... } + * + * + * @return The bytes for parent. + */ + public com.google.protobuf.ByteString getParentBytes() { + java.lang.Object ref = parent_; + if (ref instanceof String) { + com.google.protobuf.ByteString b = + com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref); + parent_ = b; + return b; + } else { + return (com.google.protobuf.ByteString) ref; + } + } + /** + * + * + * 
+     * 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) = { ... } + * + * + * @param value The parent to set. + * @return This builder for chaining. + */ + public Builder setParent(java.lang.String value) { + if (value == null) { + throw new NullPointerException(); + } + parent_ = value; + bitField0_ |= 0x00000001; + onChanged(); + return this; + } + /** + * + * + * 
+     * 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) = { ... } + * + * + * @return This builder for chaining. + */ + public Builder clearParent() { + parent_ = getDefaultInstance().getParent(); + bitField0_ = (bitField0_ & ~0x00000001); + onChanged(); + return this; + } + /** + * + * + * 
+     * 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) = { ... } + * + * + * @param value The bytes for parent to set. + * @return This builder for chaining. + */ + public Builder setParentBytes(com.google.protobuf.ByteString value) { + if (value == null) { + throw new NullPointerException(); + } + checkByteStringIsUtf8(value); + parent_ = value; + bitField0_ |= 0x00000001; + onChanged(); + return this; + } + + private java.lang.Object filter_ = ""; + /** + * + * + * 
+     * Required. Filter matching documents to purge. Only currently supported
+     * value is
+     * `*` (all items).
+     *
+ * + * string filter = 2 [(.google.api.field_behavior) = REQUIRED]; + * + * @return The filter. + */ + public java.lang.String getFilter() { + java.lang.Object ref = filter_; + if (!(ref instanceof java.lang.String)) { + com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref; + java.lang.String s = bs.toStringUtf8(); + filter_ = s; + return s; + } else { + return (java.lang.String) ref; + } + } + /** + * + * + * 
+     * Required. Filter matching documents to purge. Only currently supported
+     * value is
+     * `*` (all items).
+     *
+ * + * string filter = 2 [(.google.api.field_behavior) = REQUIRED]; + * + * @return The bytes for filter. + */ + public com.google.protobuf.ByteString getFilterBytes() { + java.lang.Object ref = filter_; + if (ref instanceof String) { + com.google.protobuf.ByteString b = + com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref); + filter_ = b; + return b; + } else { + return (com.google.protobuf.ByteString) ref; + } + } + /** + * + * + * 
+     * Required. Filter matching documents to purge. Only currently supported
+     * value is
+     * `*` (all items).
+     *
+ * + * string filter = 2 [(.google.api.field_behavior) = REQUIRED]; + * + * @param value The filter to set. + * @return This builder for chaining. + */ + public Builder setFilter(java.lang.String value) { + if (value == null) { + throw new NullPointerException(); + } + filter_ = value; + bitField0_ |= 0x00000002; + onChanged(); + return this; + } + /** + * + * + * 
+     * Required. Filter matching documents to purge. Only currently supported
+     * value is
+     * `*` (all items).
+     *
+ * + * string filter = 2 [(.google.api.field_behavior) = REQUIRED]; + * + * @return This builder for chaining. + */ + public Builder clearFilter() { + filter_ = getDefaultInstance().getFilter(); + bitField0_ = (bitField0_ & ~0x00000002); + onChanged(); + return this; + } + /** + * + * + * 
+     * Required. Filter matching documents to purge. Only currently supported
+     * value is
+     * `*` (all items).
+     *
+ * + * string filter = 2 [(.google.api.field_behavior) = REQUIRED]; + * + * @param value The bytes for filter to set. + * @return This builder for chaining. + */ + public Builder setFilterBytes(com.google.protobuf.ByteString value) { + if (value == null) { + throw new NullPointerException(); + } + checkByteStringIsUtf8(value); + filter_ = value; + bitField0_ |= 0x00000002; + onChanged(); + return this; + } + + private boolean force_; + /** + * + * + * 
+     * Actually performs the purge. If `force` is set to false, return the
+     * expected purge count without deleting any documents.
+     *
+ * + * bool force = 3; + * + * @return The force. + */ + @java.lang.Override + public boolean getForce() { + return force_; + } + /** + * + * + * 
+     * Actually performs the purge. If `force` is set to false, return the
+     * expected purge count without deleting any documents.
+     *
+ * + * bool force = 3; + * + * @param value The force to set. + * @return This builder for chaining. + */ + public Builder setForce(boolean value) { + + force_ = value; + bitField0_ |= 0x00000004; + onChanged(); + return this; + } + /** + * + * + * 
+     * Actually performs the purge. If `force` is set to false, return the
+     * expected purge count without deleting any documents.
+     *
+ * + * bool force = 3; + * + * @return This builder for chaining. + */ + public Builder clearForce() { + bitField0_ = (bitField0_ & ~0x00000004); + force_ = false; + onChanged(); + return this; + } + + @java.lang.Override + public final Builder setUnknownFields(final com.google.protobuf.UnknownFieldSet unknownFields) { + return super.setUnknownFields(unknownFields); + } + + @java.lang.Override + public final Builder mergeUnknownFields( + final com.google.protobuf.UnknownFieldSet unknownFields) { + return super.mergeUnknownFields(unknownFields); + } + + // @@protoc_insertion_point(builder_scope:google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest) + } + + // @@protoc_insertion_point(class_scope:google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest) + private static final com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest + DEFAULT_INSTANCE; + + static { + DEFAULT_INSTANCE = new com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest(); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest getDefaultInstance() { + return DEFAULT_INSTANCE; + } + + private static final com.google.protobuf.Parser PARSER = + new com.google.protobuf.AbstractParser() { + @java.lang.Override + public PurgeDocumentsRequest parsePartialFrom( + com.google.protobuf.CodedInputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException { + Builder builder = newBuilder(); + try { + builder.mergeFrom(input, extensionRegistry); + } catch (com.google.protobuf.InvalidProtocolBufferException e) { + throw e.setUnfinishedMessage(builder.buildPartial()); + } catch (com.google.protobuf.UninitializedMessageException e) { + throw e.asInvalidProtocolBufferException().setUnfinishedMessage(builder.buildPartial()); + } catch (java.io.IOException e) { + throw new com.google.protobuf.InvalidProtocolBufferException(e) + .setUnfinishedMessage(builder.buildPartial()); + } + return builder.buildPartial(); + } + }; + + public static com.google.protobuf.Parser parser() { + return PARSER; + } + + @java.lang.Override + public com.google.protobuf.Parser getParserForType() { + return PARSER; + } + + @java.lang.Override + public com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest getDefaultInstanceForType() { + return DEFAULT_INSTANCE; + } +} diff --git a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeDocumentsRequestOrBuilder.java b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeDocumentsRequestOrBuilder.java new file mode 100644 index 000000000000..077e95c55a31 --- /dev/null +++ b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeDocumentsRequestOrBuilder.java @@ -0,0 +1,99 @@ +/* + * Copyright 2020 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 + * + * https://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. + */ +// Generated by the protocol buffer compiler. DO NOT EDIT! +// source: google/cloud/discoveryengine/v1beta/purge_config.proto + +package com.google.cloud.discoveryengine.v1beta; + +public interface PurgeDocumentsRequestOrBuilder + extends + // @@protoc_insertion_point(interface_extends:google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest) + com.google.protobuf.MessageOrBuilder { + + /** + * + * + * 
+   * 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) = { ... } + * + * + * @return The parent. + */ + java.lang.String getParent(); + /** + * + * + * 
+   * 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) = { ... } + * + * + * @return The bytes for parent. + */ + com.google.protobuf.ByteString getParentBytes(); + + /** + * + * + * 
+   * Required. Filter matching documents to purge. Only currently supported
+   * value is
+   * `*` (all items).
+   *
+ * + * string filter = 2 [(.google.api.field_behavior) = REQUIRED]; + * + * @return The filter. + */ + java.lang.String getFilter(); + /** + * + * + * 
+   * Required. Filter matching documents to purge. Only currently supported
+   * value is
+   * `*` (all items).
+   *
+ * + * string filter = 2 [(.google.api.field_behavior) = REQUIRED]; + * + * @return The bytes for filter. + */ + com.google.protobuf.ByteString getFilterBytes(); + + /** + * + * + * 
+   * Actually performs the purge. If `force` is set to false, return the
+   * expected purge count without deleting any documents.
+   *
+ * + * bool force = 3; + * + * @return The force. + */ + boolean getForce(); +} diff --git a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeDocumentsResponse.java b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeDocumentsResponse.java new file mode 100644 index 000000000000..21b97e860404 --- /dev/null +++ b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeDocumentsResponse.java @@ -0,0 +1,856 @@ +/* + * Copyright 2020 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 + * + * https://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. + */ +// Generated by the protocol buffer compiler. DO NOT EDIT! +// source: google/cloud/discoveryengine/v1beta/purge_config.proto + +package com.google.cloud.discoveryengine.v1beta; + +/** + * + * + * 
+ * 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.
+ *
+ * + * Protobuf type {@code google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse} + */ +public final class PurgeDocumentsResponse extends com.google.protobuf.GeneratedMessageV3 + implements + // @@protoc_insertion_point(message_implements:google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse) + PurgeDocumentsResponseOrBuilder { + private static final long serialVersionUID = 0L; + // Use PurgeDocumentsResponse.newBuilder() to construct. + private PurgeDocumentsResponse(com.google.protobuf.GeneratedMessageV3.Builder builder) { + super(builder); + } + + private PurgeDocumentsResponse() { + purgeSample_ = com.google.protobuf.LazyStringArrayList.EMPTY; + } + + @java.lang.Override + @SuppressWarnings({"unused"}) + protected java.lang.Object newInstance(UnusedPrivateParameter unused) { + return new PurgeDocumentsResponse(); + } + + @java.lang.Override + public final com.google.protobuf.UnknownFieldSet getUnknownFields() { + return this.unknownFields; + } + + public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { + return com.google.cloud.discoveryengine.v1beta.PurgeConfigProto + .internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsResponse_descriptor; + } + + @java.lang.Override + protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable + internalGetFieldAccessorTable() { + return com.google.cloud.discoveryengine.v1beta.PurgeConfigProto + .internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsResponse_fieldAccessorTable + .ensureFieldAccessorsInitialized( + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse.class, + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse.Builder.class); + } + + public static final int PURGE_COUNT_FIELD_NUMBER = 1; + private long purgeCount_ = 0L; + /** + * + * + * 
+   * The total count of documents purged as a result of the operation.
+   *
+ * + * int64 purge_count = 1; + * + * @return The purgeCount. + */ + @java.lang.Override + public long getPurgeCount() { + return purgeCount_; + } + + public static final int PURGE_SAMPLE_FIELD_NUMBER = 2; + + @SuppressWarnings("serial") + private com.google.protobuf.LazyStringList purgeSample_; + /** + * + * + * 
+   * 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) = { ... } + * + * @return A list containing the purgeSample. + */ + public com.google.protobuf.ProtocolStringList getPurgeSampleList() { + return purgeSample_; + } + /** + * + * + * 
+   * 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) = { ... } + * + * @return The count of purgeSample. + */ + public int getPurgeSampleCount() { + return purgeSample_.size(); + } + /** + * + * + * 
+   * 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) = { ... } + * + * @param index The index of the element to return. + * @return The purgeSample at the given index. + */ + public java.lang.String getPurgeSample(int index) { + return purgeSample_.get(index); + } + /** + * + * + * 
+   * 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) = { ... } + * + * @param index The index of the value to return. + * @return The bytes of the purgeSample at the given index. + */ + public com.google.protobuf.ByteString getPurgeSampleBytes(int index) { + return purgeSample_.getByteString(index); + } + + private byte memoizedIsInitialized = -1; + + @java.lang.Override + public final boolean isInitialized() { + byte isInitialized = memoizedIsInitialized; + if (isInitialized == 1) return true; + if (isInitialized == 0) return false; + + memoizedIsInitialized = 1; + return true; + } + + @java.lang.Override + public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException { + if (purgeCount_ != 0L) { + output.writeInt64(1, purgeCount_); + } + for (int i = 0; i < purgeSample_.size(); i++) { + com.google.protobuf.GeneratedMessageV3.writeString(output, 2, purgeSample_.getRaw(i)); + } + getUnknownFields().writeTo(output); + } + + @java.lang.Override + public int getSerializedSize() { + int size = memoizedSize; + if (size != -1) return size; + + size = 0; + if (purgeCount_ != 0L) { + size += com.google.protobuf.CodedOutputStream.computeInt64Size(1, purgeCount_); + } + { + int dataSize = 0; + for (int i = 0; i < purgeSample_.size(); i++) { + dataSize += computeStringSizeNoTag(purgeSample_.getRaw(i)); + } + size += dataSize; + size += 1 * getPurgeSampleList().size(); + } + size += getUnknownFields().getSerializedSize(); + memoizedSize = size; + return size; + } + + @java.lang.Override + public boolean equals(final java.lang.Object obj) { + if (obj == this) { + return true; + } + if (!(obj instanceof com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse)) { + return super.equals(obj); + } + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse other = + (com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse) obj; + + if (getPurgeCount() != other.getPurgeCount()) return false; + if (!getPurgeSampleList().equals(other.getPurgeSampleList())) return false; + if (!getUnknownFields().equals(other.getUnknownFields())) return false; + return true; + } + + @java.lang.Override + public int hashCode() { + if (memoizedHashCode != 0) { + return memoizedHashCode; + } + int hash = 41; + hash = (19 * hash) + getDescriptor().hashCode(); + hash = (37 * hash) + PURGE_COUNT_FIELD_NUMBER; + hash = (53 * hash) + com.google.protobuf.Internal.hashLong(getPurgeCount()); + if (getPurgeSampleCount() > 0) { + hash = (37 * hash) + PURGE_SAMPLE_FIELD_NUMBER; + hash = (53 * hash) + getPurgeSampleList().hashCode(); + } + hash = (29 * hash) + getUnknownFields().hashCode(); + memoizedHashCode = hash; + return hash; + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse parseFrom( + java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException { + return PARSER.parseFrom(data); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse parseFrom( + java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException { + return PARSER.parseFrom(data, extensionRegistry); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse parseFrom( + com.google.protobuf.ByteString data) + throws com.google.protobuf.InvalidProtocolBufferException { + return PARSER.parseFrom(data); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse parseFrom( + com.google.protobuf.ByteString data, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException { + return PARSER.parseFrom(data, extensionRegistry); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse parseFrom( + byte[] data) throws com.google.protobuf.InvalidProtocolBufferException { + return PARSER.parseFrom(data); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse parseFrom( + byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException { + return PARSER.parseFrom(data, extensionRegistry); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse parseFrom( + java.io.InputStream input) throws java.io.IOException { + return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse parseFrom( + java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws java.io.IOException { + return com.google.protobuf.GeneratedMessageV3.parseWithIOException( + PARSER, input, extensionRegistry); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse parseDelimitedFrom( + java.io.InputStream input) throws java.io.IOException { + return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException(PARSER, input); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse parseDelimitedFrom( + java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws java.io.IOException { + return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException( + PARSER, input, extensionRegistry); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse parseFrom( + com.google.protobuf.CodedInputStream input) throws java.io.IOException { + return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse parseFrom( + com.google.protobuf.CodedInputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws java.io.IOException { + return com.google.protobuf.GeneratedMessageV3.parseWithIOException( + PARSER, input, extensionRegistry); + } + + @java.lang.Override + public Builder newBuilderForType() { + return newBuilder(); + } + + public static Builder newBuilder() { + return DEFAULT_INSTANCE.toBuilder(); + } + + public static Builder newBuilder( + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse prototype) { + return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype); + } + + @java.lang.Override + public Builder toBuilder() { + return this == DEFAULT_INSTANCE ? new Builder() : new Builder().mergeFrom(this); + } + + @java.lang.Override + protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) { + Builder builder = new Builder(parent); + return builder; + } + /** + * + * + * 
+   * 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.
+   *
+ * + * Protobuf type {@code google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse} + */ + public static final class Builder extends com.google.protobuf.GeneratedMessageV3.Builder + implements + // @@protoc_insertion_point(builder_implements:google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse) + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponseOrBuilder { + public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { + return com.google.cloud.discoveryengine.v1beta.PurgeConfigProto + .internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsResponse_descriptor; + } + + @java.lang.Override + protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable + internalGetFieldAccessorTable() { + return com.google.cloud.discoveryengine.v1beta.PurgeConfigProto + .internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsResponse_fieldAccessorTable + .ensureFieldAccessorsInitialized( + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse.class, + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse.Builder.class); + } + + // Construct using com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse.newBuilder() + private Builder() {} + + private Builder(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) { + super(parent); + } + + @java.lang.Override + public Builder clear() { + super.clear(); + bitField0_ = 0; + purgeCount_ = 0L; + purgeSample_ = com.google.protobuf.LazyStringArrayList.EMPTY; + bitField0_ = (bitField0_ & ~0x00000002); + return this; + } + + @java.lang.Override + public com.google.protobuf.Descriptors.Descriptor getDescriptorForType() { + return com.google.cloud.discoveryengine.v1beta.PurgeConfigProto + .internal_static_google_cloud_discoveryengine_v1beta_PurgeDocumentsResponse_descriptor; + } + + @java.lang.Override + public com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse + getDefaultInstanceForType() { + return com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse.getDefaultInstance(); + } + + @java.lang.Override + public com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse build() { + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse result = buildPartial(); + if (!result.isInitialized()) { + throw newUninitializedMessageException(result); + } + return result; + } + + @java.lang.Override + public com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse buildPartial() { + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse result = + new com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse(this); + buildPartialRepeatedFields(result); + if (bitField0_ != 0) { + buildPartial0(result); + } + onBuilt(); + return result; + } + + private void buildPartialRepeatedFields( + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse result) { + if (((bitField0_ & 0x00000002) != 0)) { + purgeSample_ = purgeSample_.getUnmodifiableView(); + bitField0_ = (bitField0_ & ~0x00000002); + } + result.purgeSample_ = purgeSample_; + } + + private void buildPartial0( + com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse result) { + int from_bitField0_ = bitField0_; + if (((from_bitField0_ & 0x00000001) != 0)) { + result.purgeCount_ = purgeCount_; + } + } + + @java.lang.Override + public Builder clone() { + return super.clone(); + } + + @java.lang.Override + public Builder setField( + com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value) { + return super.setField(field, value); + } + + @java.lang.Override + public Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) { + return super.clearField(field); + } + + @java.lang.Override + public Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) { + return super.clearOneof(oneof); + } + + @java.lang.Override + public Builder setRepeatedField( + com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value) { + return super.setRepeatedField(field, index, value); + } + + @java.lang.Override + public Builder addRepeatedField( + com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value) { + return super.addRepeatedField(field, value); + } + + @java.lang.Override + public Builder mergeFrom(com.google.protobuf.Message other) { + if (other instanceof com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse) { + return mergeFrom((com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse) other); + } else { + super.mergeFrom(other); + return this; + } + } + + public Builder mergeFrom(com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse other) { + if (other + == com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse.getDefaultInstance()) + return this; + if (other.getPurgeCount() != 0L) { + setPurgeCount(other.getPurgeCount()); + } + if (!other.purgeSample_.isEmpty()) { + if (purgeSample_.isEmpty()) { + purgeSample_ = other.purgeSample_; + bitField0_ = (bitField0_ & ~0x00000002); + } else { + ensurePurgeSampleIsMutable(); + purgeSample_.addAll(other.purgeSample_); + } + onChanged(); + } + this.mergeUnknownFields(other.getUnknownFields()); + onChanged(); + return this; + } + + @java.lang.Override + public final boolean isInitialized() { + return true; + } + + @java.lang.Override + public Builder mergeFrom( + com.google.protobuf.CodedInputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws java.io.IOException { + if (extensionRegistry == null) { + throw new java.lang.NullPointerException(); + } + try { + boolean done = false; + while (!done) { + int tag = input.readTag(); + switch (tag) { + case 0: + done = true; + break; + case 8: + { + purgeCount_ = input.readInt64(); + bitField0_ |= 0x00000001; + break; + } // case 8 + case 18: + { + java.lang.String s = input.readStringRequireUtf8(); + ensurePurgeSampleIsMutable(); + purgeSample_.add(s); + break; + } // case 18 + default: + { + if (!super.parseUnknownField(input, extensionRegistry, tag)) { + done = true; // was an endgroup tag + } + break; + } // default: + } // switch (tag) + } // while (!done) + } catch (com.google.protobuf.InvalidProtocolBufferException e) { + throw e.unwrapIOException(); + } finally { + onChanged(); + } // finally + return this; + } + + private int bitField0_; + + private long purgeCount_; + /** + * + * + * 
+     * The total count of documents purged as a result of the operation.
+     *
+ * + * int64 purge_count = 1; + * + * @return The purgeCount. + */ + @java.lang.Override + public long getPurgeCount() { + return purgeCount_; + } + /** + * + * + * 
+     * The total count of documents purged as a result of the operation.
+     *
+ * + * int64 purge_count = 1; + * + * @param value The purgeCount to set. + * @return This builder for chaining. + */ + public Builder setPurgeCount(long value) { + + purgeCount_ = value; + bitField0_ |= 0x00000001; + onChanged(); + return this; + } + /** + * + * + * 
+     * The total count of documents purged as a result of the operation.
+     *
+ * + * int64 purge_count = 1; + * + * @return This builder for chaining. + */ + public Builder clearPurgeCount() { + bitField0_ = (bitField0_ & ~0x00000001); + purgeCount_ = 0L; + onChanged(); + return this; + } + + private com.google.protobuf.LazyStringList purgeSample_ = + com.google.protobuf.LazyStringArrayList.EMPTY; + + private void ensurePurgeSampleIsMutable() { + if (!((bitField0_ & 0x00000002) != 0)) { + purgeSample_ = new com.google.protobuf.LazyStringArrayList(purgeSample_); + bitField0_ |= 0x00000002; + } + } + /** + * + * + * 
+     * 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) = { ... } + * + * @return A list containing the purgeSample. + */ + public com.google.protobuf.ProtocolStringList getPurgeSampleList() { + return purgeSample_.getUnmodifiableView(); + } + /** + * + * + * 
+     * 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) = { ... } + * + * @return The count of purgeSample. + */ + public int getPurgeSampleCount() { + return purgeSample_.size(); + } + /** + * + * + * 
+     * 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) = { ... } + * + * @param index The index of the element to return. + * @return The purgeSample at the given index. + */ + public java.lang.String getPurgeSample(int index) { + return purgeSample_.get(index); + } + /** + * + * + * 
+     * 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) = { ... } + * + * @param index The index of the value to return. + * @return The bytes of the purgeSample at the given index. + */ + public com.google.protobuf.ByteString getPurgeSampleBytes(int index) { + return purgeSample_.getByteString(index); + } + /** + * + * + * 
+     * 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) = { ... } + * + * @param index The index to set the value at. + * @param value The purgeSample to set. + * @return This builder for chaining. + */ + public Builder setPurgeSample(int index, java.lang.String value) { + if (value == null) { + throw new NullPointerException(); + } + ensurePurgeSampleIsMutable(); + purgeSample_.set(index, value); + onChanged(); + return this; + } + /** + * + * + * 
+     * 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) = { ... } + * + * @param value The purgeSample to add. + * @return This builder for chaining. + */ + public Builder addPurgeSample(java.lang.String value) { + if (value == null) { + throw new NullPointerException(); + } + ensurePurgeSampleIsMutable(); + purgeSample_.add(value); + onChanged(); + return this; + } + /** + * + * + * 
+     * 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) = { ... } + * + * @param values The purgeSample to add. + * @return This builder for chaining. + */ + public Builder addAllPurgeSample(java.lang.Iterable values) { + ensurePurgeSampleIsMutable(); + com.google.protobuf.AbstractMessageLite.Builder.addAll(values, purgeSample_); + onChanged(); + return this; + } + /** + * + * + * 
+     * 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) = { ... } + * + * @return This builder for chaining. + */ + public Builder clearPurgeSample() { + purgeSample_ = com.google.protobuf.LazyStringArrayList.EMPTY; + bitField0_ = (bitField0_ & ~0x00000002); + onChanged(); + return this; + } + /** + * + * + * 
+     * 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) = { ... } + * + * @param value The bytes of the purgeSample to add. + * @return This builder for chaining. + */ + public Builder addPurgeSampleBytes(com.google.protobuf.ByteString value) { + if (value == null) { + throw new NullPointerException(); + } + checkByteStringIsUtf8(value); + ensurePurgeSampleIsMutable(); + purgeSample_.add(value); + onChanged(); + return this; + } + + @java.lang.Override + public final Builder setUnknownFields(final com.google.protobuf.UnknownFieldSet unknownFields) { + return super.setUnknownFields(unknownFields); + } + + @java.lang.Override + public final Builder mergeUnknownFields( + final com.google.protobuf.UnknownFieldSet unknownFields) { + return super.mergeUnknownFields(unknownFields); + } + + // @@protoc_insertion_point(builder_scope:google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse) + } + + // @@protoc_insertion_point(class_scope:google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse) + private static final com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse + DEFAULT_INSTANCE; + + static { + DEFAULT_INSTANCE = new com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse(); + } + + public static com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse + getDefaultInstance() { + return DEFAULT_INSTANCE; + } + + private static final com.google.protobuf.Parser PARSER = + new com.google.protobuf.AbstractParser() { + @java.lang.Override + public PurgeDocumentsResponse parsePartialFrom( + com.google.protobuf.CodedInputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException { + Builder builder = newBuilder(); + try { + builder.mergeFrom(input, extensionRegistry); + } catch (com.google.protobuf.InvalidProtocolBufferException e) { + throw e.setUnfinishedMessage(builder.buildPartial()); + } catch (com.google.protobuf.UninitializedMessageException e) { + throw e.asInvalidProtocolBufferException().setUnfinishedMessage(builder.buildPartial()); + } catch (java.io.IOException e) { + throw new com.google.protobuf.InvalidProtocolBufferException(e) + .setUnfinishedMessage(builder.buildPartial()); + } + return builder.buildPartial(); + } + }; + + public static com.google.protobuf.Parser parser() { + return PARSER; + } + + @java.lang.Override + public com.google.protobuf.Parser getParserForType() { + return PARSER; + } + + @java.lang.Override + public com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse + getDefaultInstanceForType() { + return DEFAULT_INSTANCE; + } +} diff --git a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeDocumentsResponseOrBuilder.java b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeDocumentsResponseOrBuilder.java new file mode 100644 index 000000000000..db40beaac429 --- /dev/null +++ b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/PurgeDocumentsResponseOrBuilder.java @@ -0,0 +1,97 @@ +/* + * Copyright 2020 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 + * + * https://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. + */ +// Generated by the protocol buffer compiler. DO NOT EDIT! +// source: google/cloud/discoveryengine/v1beta/purge_config.proto + +package com.google.cloud.discoveryengine.v1beta; + +public interface PurgeDocumentsResponseOrBuilder + extends + // @@protoc_insertion_point(interface_extends:google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse) + com.google.protobuf.MessageOrBuilder { + + /** + * + * + * 
+   * The total count of documents purged as a result of the operation.
+   *
+ * + * int64 purge_count = 1; + * + * @return The purgeCount. + */ + long getPurgeCount(); + + /** + * + * + * 
+   * 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) = { ... } + * + * @return A list containing the purgeSample. + */ + java.util.List getPurgeSampleList(); + /** + * + * + * 
+   * 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) = { ... } + * + * @return The count of purgeSample. + */ + int getPurgeSampleCount(); + /** + * + * + * 
+   * 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) = { ... } + * + * @param index The index of the element to return. + * @return The purgeSample at the given index. + */ + java.lang.String getPurgeSample(int index); + /** + * + * + * 
+   * 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) = { ... } + * + * @param index The index of the value to return. + * @return The bytes of the purgeSample at the given index. + */ + com.google.protobuf.ByteString getPurgeSampleBytes(int index); +} diff --git a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/SearchInfo.java b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/SearchInfo.java index 0f7f551fa248..26d25a6a6ce5 100644 --- a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/SearchInfo.java +++ b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/SearchInfo.java @@ -85,9 +85,10 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { * characters. Otherwise, an INVALID_ARGUMENT error is returned. * 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; @@ -118,9 +119,10 @@ public java.lang.String getSearchQuery() { * characters. Otherwise, an INVALID_ARGUMENT error is returned. * 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; @@ -661,9 +663,10 @@ public Builder mergeFrom( * characters. Otherwise, an INVALID_ARGUMENT error is returned. * 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; @@ -693,9 +696,10 @@ public java.lang.String getSearchQuery() { * characters. Otherwise, an INVALID_ARGUMENT error is returned. * 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; @@ -725,9 +729,10 @@ public com.google.protobuf.ByteString getSearchQueryBytes() { * characters. Otherwise, an INVALID_ARGUMENT error is returned. * 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; @@ -756,9 +761,10 @@ public Builder setSearchQuery(java.lang.String value) { * characters. Otherwise, an INVALID_ARGUMENT error is returned. * 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; @@ -783,9 +789,10 @@ public Builder clearSearchQuery() { * characters. Otherwise, an INVALID_ARGUMENT error is returned. * 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; diff --git a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/SearchInfoOrBuilder.java b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/SearchInfoOrBuilder.java index f55cff566a35..ff5cf489a992 100644 --- a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/SearchInfoOrBuilder.java +++ b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/SearchInfoOrBuilder.java @@ -35,9 +35,10 @@ public interface SearchInfoOrBuilder * characters. Otherwise, an INVALID_ARGUMENT error is returned. * 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; @@ -57,9 +58,10 @@ public interface SearchInfoOrBuilder * characters. Otherwise, an INVALID_ARGUMENT error is returned. * 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; diff --git a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/UserEvent.java b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/UserEvent.java index ae200b4868ff..01a6ca265ddc 100644 --- a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/UserEvent.java +++ b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/UserEvent.java @@ -492,15 +492,17 @@ public com.google.cloud.discoveryengine.v1beta.PageInfoOrBuilder getPageInfoOrBu * 
    * 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
    * this clicked/purchased product. If user clicks on product K in the
@@ -531,15 +533,17 @@ public java.lang.String getAttributionToken() {
    * 
    * 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
    * this clicked/purchased product. If user clicks on product K in the
@@ -576,13 +580,14 @@ public com.google.protobuf.ByteString getAttributionTokenBytes() {
    * The filter syntax consists of an expression language for constructing a
    * 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.
    * 

@@ -610,13 +615,14 @@ public java.lang.String getFilter() {
    * The filter syntax consists of an expression language for constructing a
    * 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.
    *
@@ -3435,15 +3441,17 @@ public com.google.cloud.discoveryengine.v1beta.PageInfoOrBuilder getPageInfoOrBu * 
      * 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
      * this clicked/purchased product. If user clicks on product K in the
@@ -3473,15 +3481,17 @@ public java.lang.String getAttributionToken() {
      * 
      * 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
      * this clicked/purchased product. If user clicks on product K in the
@@ -3511,15 +3521,17 @@ public com.google.protobuf.ByteString getAttributionTokenBytes() {
      * 
      * 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
      * this clicked/purchased product. If user clicks on product K in the
@@ -3548,15 +3560,17 @@ public Builder setAttributionToken(java.lang.String value) {
      * 
      * 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
      * this clicked/purchased product. If user clicks on product K in the
@@ -3581,15 +3595,17 @@ public Builder clearAttributionToken() {
      * 
      * 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
      * this clicked/purchased product. If user clicks on product K in the
@@ -3622,13 +3638,14 @@ public Builder setAttributionTokenBytes(com.google.protobuf.ByteString value) {
      * The filter syntax consists of an expression language for constructing a
      * 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.
      * 

@@ -3655,13 +3672,14 @@ public java.lang.String getFilter() {
      * The filter syntax consists of an expression language for constructing a
      * 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.
      * 

@@ -3688,13 +3706,14 @@ public com.google.protobuf.ByteString getFilterBytes() {
      * The filter syntax consists of an expression language for constructing a
      * 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.
      * 

@@ -3720,13 +3739,14 @@ public Builder setFilter(java.lang.String value) {
      * The filter syntax consists of an expression language for constructing a
      * 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.
      * 

@@ -3748,13 +3768,14 @@ public Builder clearFilter() {
      * The filter syntax consists of an expression language for constructing a
      * 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.
      *
diff --git a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/UserEventOrBuilder.java b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/UserEventOrBuilder.java index 07ad83763062..6e2c09f22094 100644 --- a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/UserEventOrBuilder.java +++ b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/UserEventOrBuilder.java @@ -301,15 +301,17 @@ public interface UserEventOrBuilder * 
    * 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
    * this clicked/purchased product. If user clicks on product K in the
@@ -329,15 +331,17 @@ public interface UserEventOrBuilder
    * 
    * 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
    * this clicked/purchased product. If user clicks on product K in the
@@ -359,13 +363,14 @@ public interface UserEventOrBuilder
    * The filter syntax consists of an expression language for constructing a
    * 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.
    * 

@@ -382,13 +387,14 @@ public interface UserEventOrBuilder
    * The filter syntax consists of an expression language for constructing a
    * 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.
    *
diff --git a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/UserInfo.java b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/UserInfo.java index 71040ac4ce8b..d96f05ba81b3 100644 --- a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/UserInfo.java +++ b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/UserInfo.java @@ -148,7 +148,9 @@ public com.google.protobuf.ByteString getUserIdBytes() { * 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; @@ -178,7 +180,9 @@ public java.lang.String getUserAgent() { * 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; @@ -717,7 +721,9 @@ public Builder setUserIdBytes(com.google.protobuf.ByteString value) { * 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; @@ -746,7 +752,9 @@ public java.lang.String getUserAgent() { * 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; @@ -775,7 +783,9 @@ public com.google.protobuf.ByteString getUserAgentBytes() { * 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; @@ -803,7 +813,9 @@ public Builder setUserAgent(java.lang.String value) { * 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; @@ -827,7 +839,9 @@ public Builder clearUserAgent() { * 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; diff --git a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/UserInfoOrBuilder.java b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/UserInfoOrBuilder.java index e02a43465d05..7d60a53e911e 100644 --- a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/UserInfoOrBuilder.java +++ b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/java/com/google/cloud/discoveryengine/v1beta/UserInfoOrBuilder.java @@ -73,7 +73,9 @@ public interface UserInfoOrBuilder * 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; @@ -92,7 +94,9 @@ public interface UserInfoOrBuilder * 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; diff --git a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/proto/google/cloud/discoveryengine/v1beta/common.proto b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/proto/google/cloud/discoveryengine/v1beta/common.proto index fe32a04cec61..36a799a9b064 100644 --- a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/proto/google/cloud/discoveryengine/v1beta/common.proto +++ b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/proto/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; } diff --git a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/proto/google/cloud/discoveryengine/v1beta/document_service.proto b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/proto/google/cloud/discoveryengine/v1beta/document_service.proto index b343eb5e8640..e76d7ce56cab 100644 --- a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/proto/google/cloud/discoveryengine/v1beta/document_service.proto +++ b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/proto/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 diff --git a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/proto/google/cloud/discoveryengine/v1beta/purge_config.proto b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/proto/google/cloud/discoveryengine/v1beta/purge_config.proto new file mode 100644 index 000000000000..559bc4a021cd --- /dev/null +++ b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/proto/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; +} diff --git a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/proto/google/cloud/discoveryengine/v1beta/user_event.proto b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/proto/google/cloud/discoveryengine/v1beta/user_event.proto index 9001c005c7df..4efcf7ca90e3 100644 --- a/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/proto/google/cloud/discoveryengine/v1beta/user_event.proto +++ b/java-discoveryengine/proto-google-cloud-discoveryengine-v1beta/src/main/proto/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. diff --git a/java-discoveryengine/samples/snippets/generated/com/google/cloud/discoveryengine/v1beta/documentservice/purgedocuments/AsyncPurgeDocuments.java b/java-discoveryengine/samples/snippets/generated/com/google/cloud/discoveryengine/v1beta/documentservice/purgedocuments/AsyncPurgeDocuments.java new file mode 100644 index 000000000000..df022db4d950 --- /dev/null +++ b/java-discoveryengine/samples/snippets/generated/com/google/cloud/discoveryengine/v1beta/documentservice/purgedocuments/AsyncPurgeDocuments.java @@ -0,0 +1,55 @@ +/* + * 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 + * + * https://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. + */ + +package com.google.cloud.discoveryengine.v1beta.samples; + +// [START discoveryengine_v1beta_generated_DocumentService_PurgeDocuments_async] +import com.google.api.core.ApiFuture; +import com.google.cloud.discoveryengine.v1beta.BranchName; +import com.google.cloud.discoveryengine.v1beta.DocumentServiceClient; +import com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest; +import com.google.longrunning.Operation; + +public class AsyncPurgeDocuments { + + public static void main(String[] args) throws Exception { + asyncPurgeDocuments(); + } + + public static void asyncPurgeDocuments() throws Exception { + // This snippet has been automatically generated and should be regarded as a code template only. + // It will require modifications to work: + // - It may require correct/in-range values for request initialization. + // - It may require specifying regional endpoints when creating the service client as shown in + // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library + try (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) { + PurgeDocumentsRequest request = + PurgeDocumentsRequest.newBuilder() + .setParent( + BranchName.ofProjectLocationDataStoreBranchName( + "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]") + .toString()) + .setFilter("filter-1274492040") + .setForce(true) + .build(); + ApiFuture future = + documentServiceClient.purgeDocumentsCallable().futureCall(request); + // Do something. + Operation response = future.get(); + } + } +} +// [END discoveryengine_v1beta_generated_DocumentService_PurgeDocuments_async] diff --git a/java-discoveryengine/samples/snippets/generated/com/google/cloud/discoveryengine/v1beta/documentservice/purgedocuments/AsyncPurgeDocumentsLRO.java b/java-discoveryengine/samples/snippets/generated/com/google/cloud/discoveryengine/v1beta/documentservice/purgedocuments/AsyncPurgeDocumentsLRO.java new file mode 100644 index 000000000000..29c041321db5 --- /dev/null +++ b/java-discoveryengine/samples/snippets/generated/com/google/cloud/discoveryengine/v1beta/documentservice/purgedocuments/AsyncPurgeDocumentsLRO.java @@ -0,0 +1,56 @@ +/* + * 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 + * + * https://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. + */ + +package com.google.cloud.discoveryengine.v1beta.samples; + +// [START discoveryengine_v1beta_generated_DocumentService_PurgeDocuments_LRO_async] +import com.google.api.gax.longrunning.OperationFuture; +import com.google.cloud.discoveryengine.v1beta.BranchName; +import com.google.cloud.discoveryengine.v1beta.DocumentServiceClient; +import com.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata; +import com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest; +import com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse; + +public class AsyncPurgeDocumentsLRO { + + public static void main(String[] args) throws Exception { + asyncPurgeDocumentsLRO(); + } + + public static void asyncPurgeDocumentsLRO() throws Exception { + // This snippet has been automatically generated and should be regarded as a code template only. + // It will require modifications to work: + // - It may require correct/in-range values for request initialization. + // - It may require specifying regional endpoints when creating the service client as shown in + // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library + try (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) { + PurgeDocumentsRequest request = + PurgeDocumentsRequest.newBuilder() + .setParent( + BranchName.ofProjectLocationDataStoreBranchName( + "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]") + .toString()) + .setFilter("filter-1274492040") + .setForce(true) + .build(); + OperationFuture future = + documentServiceClient.purgeDocumentsOperationCallable().futureCall(request); + // Do something. + PurgeDocumentsResponse response = future.get(); + } + } +} +// [END discoveryengine_v1beta_generated_DocumentService_PurgeDocuments_LRO_async] diff --git a/java-discoveryengine/samples/snippets/generated/com/google/cloud/discoveryengine/v1beta/documentservice/purgedocuments/SyncPurgeDocuments.java b/java-discoveryengine/samples/snippets/generated/com/google/cloud/discoveryengine/v1beta/documentservice/purgedocuments/SyncPurgeDocuments.java new file mode 100644 index 000000000000..3fa025538520 --- /dev/null +++ b/java-discoveryengine/samples/snippets/generated/com/google/cloud/discoveryengine/v1beta/documentservice/purgedocuments/SyncPurgeDocuments.java @@ -0,0 +1,51 @@ +/* + * 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 + * + * https://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. + */ + +package com.google.cloud.discoveryengine.v1beta.samples; + +// [START discoveryengine_v1beta_generated_DocumentService_PurgeDocuments_sync] +import com.google.cloud.discoveryengine.v1beta.BranchName; +import com.google.cloud.discoveryengine.v1beta.DocumentServiceClient; +import com.google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest; +import com.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse; + +public class SyncPurgeDocuments { + + public static void main(String[] args) throws Exception { + syncPurgeDocuments(); + } + + public static void syncPurgeDocuments() throws Exception { + // This snippet has been automatically generated and should be regarded as a code template only. + // It will require modifications to work: + // - It may require correct/in-range values for request initialization. + // - It may require specifying regional endpoints when creating the service client as shown in + // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library + try (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) { + PurgeDocumentsRequest request = + PurgeDocumentsRequest.newBuilder() + .setParent( + BranchName.ofProjectLocationDataStoreBranchName( + "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]") + .toString()) + .setFilter("filter-1274492040") + .setForce(true) + .build(); + PurgeDocumentsResponse response = documentServiceClient.purgeDocumentsAsync(request).get(); + } + } +} +// [END discoveryengine_v1beta_generated_DocumentService_PurgeDocuments_sync]