Skip to content

Commit

Permalink
feat: [discoveryengine] add document purge API (#9396)
Browse files Browse the repository at this point in the history 
- [ ] Regenerate this pull request now.

docs: keep the API doc up-to-date with recent changes

PiperOrigin-RevId: 528071547

Source-Link: https://github.com/googleapis/googleapis/commit/32e0dc1277f6b7a98cc2ed9ac29bf9c8770901ab

Source-Link: https://github.com/googleapis/googleapis-gen/commit/f5843c4bc40eda236e54d363d794200f77de7d89
Copy-Tag: eyJwIjoiamF2YS1kaXNjb3ZlcnllbmdpbmUvLk93bEJvdC55YW1sIiwiaCI6ImY1ODQzYzRiYzQwZWRhMjM2ZTU0ZDM2M2Q3OTQyMDBmNzdkZTdkODkifQ==
  • Loading branch information
@gcf-owl-bot
gcf-owl-bot[bot] authored May 9, 2023
1 parent bc46b1b commit 23b1396
Show file tree
Hide file tree
Showing 33 changed files with 4,706 additions and 223 deletions.
2 changes: 1 addition & 1 deletion java-discoveryengine/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
144 changes: 144 additions & 0 deletions ...ryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceClient.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -997,6 +997,150 @@ public final UnaryCallable<ImportDocumentsRequest, Operation> importDocumentsCal
return stub.importDocumentsCallable();
}

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Permanently deletes all selected [Document][google.cloud.discoveryengine.v1beta.Document]s in a
* branch.
*
* <p>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].
*
* <p>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.
*
* <p>Sample code:
*
* <pre>{@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();
* }
* }</pre>
*
* @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<PurgeDocumentsResponse, PurgeDocumentsMetadata> 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.
*
* <p>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].
*
* <p>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.
*
* <p>Sample code:
*
* <pre>{@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<PurgeDocumentsResponse, PurgeDocumentsMetadata> future =
* documentServiceClient.purgeDocumentsOperationCallable().futureCall(request);
* // Do something.
* PurgeDocumentsResponse response = future.get();
* }
* }</pre>
*/
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.
*
* <p>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].
*
* <p>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.
*
* <p>Sample code:
*
* <pre>{@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<Operation> future =
* documentServiceClient.purgeDocumentsCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<PurgeDocumentsRequest, Operation> purgeDocumentsCallable() {
return stub.purgeDocumentsCallable();
}

@Override
public final void close() {
stub.close();
Expand Down
24 changes: 24 additions & 0 deletions ...engine/src/main/java/com/google/cloud/discoveryengine/v1beta/DocumentServiceSettings.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,18 @@ public UnaryCallSettings<ImportDocumentsRequest, Operation> importDocumentsSetti
return ((DocumentServiceStubSettings) getStubSettings()).importDocumentsOperationSettings();
}

/** Returns the object with the settings used for calls to purgeDocuments. */
public UnaryCallSettings<PurgeDocumentsRequest, Operation> 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();
Expand Down Expand Up @@ -272,6 +284,18 @@ public UnaryCallSettings.Builder<ImportDocumentsRequest, Operation> importDocume
return getStubSettingsBuilder().importDocumentsOperationSettings();
}

/** Returns the builder for the settings used for calls to purgeDocuments. */
public UnaryCallSettings.Builder<PurgeDocumentsRequest, Operation> 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);
Expand Down
3 changes: 3 additions & 0 deletions ...discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/gapic_metadata.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@
"ListDocuments": {
"methods": ["listDocuments", "listDocuments", "listDocuments", "listDocumentsPagedCallable", "listDocumentsCallable"]
},
"PurgeDocuments": {
"methods": ["purgeDocumentsAsync", "purgeDocumentsOperationCallable", "purgeDocumentsCallable"]
},
"UpdateDocument": {
"methods": ["updateDocument", "updateDocumentCallable"]
}
Expand Down
12 changes: 12 additions & 0 deletions ...ngine/src/main/java/com/google/cloud/discoveryengine/v1beta/stub/DocumentServiceStub.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -89,6 +92,15 @@ public UnaryCallable<ImportDocumentsRequest, Operation> importDocumentsCallable(
throw new UnsupportedOperationException("Not implemented: importDocumentsCallable()");
}

public OperationCallable<PurgeDocumentsRequest, PurgeDocumentsResponse, PurgeDocumentsMetadata>
purgeDocumentsOperationCallable() {
throw new UnsupportedOperationException("Not implemented: purgeDocumentsOperationCallable()");
}

public UnaryCallable<PurgeDocumentsRequest, Operation> purgeDocumentsCallable() {
throw new UnsupportedOperationException("Not implemented: purgeDocumentsCallable()");
}

@Override
public abstract void close();
}
79 changes: 77 additions & 2 deletions ...c/main/java/com/google/cloud/discoveryengine/v1beta/stub/DocumentServiceStubSettings.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -124,6 +127,10 @@ public class DocumentServiceStubSettings extends StubSettings<DocumentServiceStu
private final OperationCallSettings<
ImportDocumentsRequest, ImportDocumentsResponse, ImportDocumentsMetadata>
importDocumentsOperationSettings;
private final UnaryCallSettings<PurgeDocumentsRequest, Operation> purgeDocumentsSettings;
private final OperationCallSettings<
PurgeDocumentsRequest, PurgeDocumentsResponse, PurgeDocumentsMetadata>
purgeDocumentsOperationSettings;

private static final PagedListDescriptor<ListDocumentsRequest, ListDocumentsResponse, Document>
LIST_DOCUMENTS_PAGE_STR_DESC =
Expand Down Expand Up @@ -216,6 +223,18 @@ public UnaryCallSettings<ImportDocumentsRequest, Operation> importDocumentsSetti
return importDocumentsOperationSettings;
}

/** Returns the object with the settings used for calls to purgeDocuments. */
public UnaryCallSettings<PurgeDocumentsRequest, Operation> 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()
Expand Down Expand Up @@ -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. */
Expand All @@ -346,6 +367,11 @@ public static class Builder extends StubSettings.Builder<DocumentServiceStubSett
private final OperationCallSettings.Builder<
ImportDocumentsRequest, ImportDocumentsResponse, ImportDocumentsMetadata>
importDocumentsOperationSettings;
private final UnaryCallSettings.Builder<PurgeDocumentsRequest, Operation>
purgeDocumentsSettings;
private final OperationCallSettings.Builder<
PurgeDocumentsRequest, PurgeDocumentsResponse, PurgeDocumentsMetadata>
purgeDocumentsOperationSettings;
private static final ImmutableMap<String, ImmutableSet<StatusCode.Code>>
RETRYABLE_CODE_DEFINITIONS;

Expand Down Expand Up @@ -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.<UnaryCallSettings.Builder<?, ?>>of(
Expand All @@ -413,7 +441,8 @@ protected Builder(ClientContext clientContext) {
createDocumentSettings,
updateDocumentSettings,
deleteDocumentSettings,
importDocumentsSettings);
importDocumentsSettings,
purgeDocumentsSettings);
initDefaults(this);
}

Expand All @@ -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.<UnaryCallSettings.Builder<?, ?>>of(
Expand All @@ -435,7 +466,8 @@ protected Builder(DocumentServiceStubSettings settings) {
createDocumentSettings,
updateDocumentSettings,
deleteDocumentSettings,
importDocumentsSettings);
importDocumentsSettings,
purgeDocumentsSettings);
}

private static Builder createDefault() {
Expand Down Expand Up @@ -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(
Expand All @@ -519,6 +556,30 @@ private static Builder initDefaults(Builder builder) {
.setTotalTimeout(Duration.ofMillis(300000L))
.build()));

builder
.purgeDocumentsOperationSettings()
.setInitialCallSettings(
UnaryCallSettings
.<PurgeDocumentsRequest, OperationSnapshot>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;
}

Expand Down Expand Up @@ -578,6 +639,20 @@ public UnaryCallSettings.Builder<ImportDocumentsRequest, Operation> importDocume
return importDocumentsOperationSettings;
}

/** Returns the builder for the settings used for calls to purgeDocuments. */
public UnaryCallSettings.Builder<PurgeDocumentsRequest, Operation> 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);
Expand Down
Loading

0 comments on commit 23b1396

Please sign in to comment.