Skip to content

Commit 5ef6254

Browse files
gcf-owl-bot[bot]tom-andersen
gcf-owl-bot[bot]
and
tom-andersen
authored
feat: add bulk delete api (#1704)
* feat: add bulk delete api docs: update field api description PiperOrigin-RevId: 642337904 Source-Link: googleapis/googleapis@9aab32e Source-Link: https://github.com/googleapis/googleapis-gen/commit/757cf9d8e2d139d7b2871ce013d5e2edc40176d3 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNzU3Y2Y5ZDhlMmQxMzlkN2IyODcxY2UwMTNkNWUyZWRjNDAxNzZkMyJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Accept API change. --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Tom Andersen <tom-andersen@users.noreply.github.com>
1 parent 321e25c commit 5ef6254

36 files changed

+6561
-474
lines changed

‎google-cloud-firestore-admin/src/main/java/com/google/cloud/firestore/v1/FirestoreAdminClient.java

+222-10
Large diffs are not rendered by default.

‎google-cloud-firestore-admin/src/main/java/com/google/cloud/firestore/v1/FirestoreAdminSettings.java

+28
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@
3535
import com.google.cloud.firestore.v1.stub.FirestoreAdminStubSettings;
3636
import com.google.firestore.admin.v1.Backup;
3737
import com.google.firestore.admin.v1.BackupSchedule;
38+
import com.google.firestore.admin.v1.BulkDeleteDocumentsMetadata;
39+
import com.google.firestore.admin.v1.BulkDeleteDocumentsRequest;
40+
import com.google.firestore.admin.v1.BulkDeleteDocumentsResponse;
3841
import com.google.firestore.admin.v1.CreateBackupScheduleRequest;
3942
import com.google.firestore.admin.v1.CreateDatabaseMetadata;
4043
import com.google.firestore.admin.v1.CreateDatabaseRequest;
@@ -193,6 +196,18 @@ public UnaryCallSettings<ImportDocumentsRequest, Operation> importDocumentsSetti
193196
return ((FirestoreAdminStubSettings) getStubSettings()).importDocumentsOperationSettings();
194197
}
195198

199+
/** Returns the object with the settings used for calls to bulkDeleteDocuments. */
200+
public UnaryCallSettings<BulkDeleteDocumentsRequest, Operation> bulkDeleteDocumentsSettings() {
201+
return ((FirestoreAdminStubSettings) getStubSettings()).bulkDeleteDocumentsSettings();
202+
}
203+
204+
/** Returns the object with the settings used for calls to bulkDeleteDocuments. */
205+
public OperationCallSettings<
206+
BulkDeleteDocumentsRequest, BulkDeleteDocumentsResponse, BulkDeleteDocumentsMetadata>
207+
bulkDeleteDocumentsOperationSettings() {
208+
return ((FirestoreAdminStubSettings) getStubSettings()).bulkDeleteDocumentsOperationSettings();
209+
}
210+
196211
/** Returns the object with the settings used for calls to createDatabase. */
197212
public UnaryCallSettings<CreateDatabaseRequest, Operation> createDatabaseSettings() {
198213
return ((FirestoreAdminStubSettings) getStubSettings()).createDatabaseSettings();
@@ -475,6 +490,19 @@ public UnaryCallSettings.Builder<ImportDocumentsRequest, Operation> importDocume
475490
return getStubSettingsBuilder().importDocumentsOperationSettings();
476491
}
477492

493+
/** Returns the builder for the settings used for calls to bulkDeleteDocuments. */
494+
public UnaryCallSettings.Builder<BulkDeleteDocumentsRequest, Operation>
495+
bulkDeleteDocumentsSettings() {
496+
return getStubSettingsBuilder().bulkDeleteDocumentsSettings();
497+
}
498+
499+
/** Returns the builder for the settings used for calls to bulkDeleteDocuments. */
500+
public OperationCallSettings.Builder<
501+
BulkDeleteDocumentsRequest, BulkDeleteDocumentsResponse, BulkDeleteDocumentsMetadata>
502+
bulkDeleteDocumentsOperationSettings() {
503+
return getStubSettingsBuilder().bulkDeleteDocumentsOperationSettings();
504+
}
505+
478506
/** Returns the builder for the settings used for calls to createDatabase. */
479507
public UnaryCallSettings.Builder<CreateDatabaseRequest, Operation> createDatabaseSettings() {
480508
return getStubSettingsBuilder().createDatabaseSettings();

‎google-cloud-firestore-admin/src/main/java/com/google/cloud/firestore/v1/gapic_metadata.json

+3
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
"grpc": {
1111
"libraryClient": "FirestoreAdminClient",
1212
"rpcs": {
13+
"BulkDeleteDocuments": {
14+
"methods": ["bulkDeleteDocumentsAsync", "bulkDeleteDocumentsAsync", "bulkDeleteDocumentsAsync", "bulkDeleteDocumentsOperationCallable", "bulkDeleteDocumentsCallable"]
15+
},
1316
"CreateBackupSchedule": {
1417
"methods": ["createBackupSchedule", "createBackupSchedule", "createBackupSchedule", "createBackupScheduleCallable"]
1518
},

‎google-cloud-firestore-admin/src/main/java/com/google/cloud/firestore/v1/stub/FirestoreAdminStub.java

+14
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@
2424
import com.google.api.gax.rpc.UnaryCallable;
2525
import com.google.firestore.admin.v1.Backup;
2626
import com.google.firestore.admin.v1.BackupSchedule;
27+
import com.google.firestore.admin.v1.BulkDeleteDocumentsMetadata;
28+
import com.google.firestore.admin.v1.BulkDeleteDocumentsRequest;
29+
import com.google.firestore.admin.v1.BulkDeleteDocumentsResponse;
2730
import com.google.firestore.admin.v1.CreateBackupScheduleRequest;
2831
import com.google.firestore.admin.v1.CreateDatabaseMetadata;
2932
import com.google.firestore.admin.v1.CreateDatabaseRequest;
@@ -150,6 +153,17 @@ public UnaryCallable<ImportDocumentsRequest, Operation> importDocumentsCallable(
150153
throw new UnsupportedOperationException("Not implemented: importDocumentsCallable()");
151154
}
152155

156+
public OperationCallable<
157+
BulkDeleteDocumentsRequest, BulkDeleteDocumentsResponse, BulkDeleteDocumentsMetadata>
158+
bulkDeleteDocumentsOperationCallable() {
159+
throw new UnsupportedOperationException(
160+
"Not implemented: bulkDeleteDocumentsOperationCallable()");
161+
}
162+
163+
public UnaryCallable<BulkDeleteDocumentsRequest, Operation> bulkDeleteDocumentsCallable() {
164+
throw new UnsupportedOperationException("Not implemented: bulkDeleteDocumentsCallable()");
165+
}
166+
153167
public OperationCallable<CreateDatabaseRequest, Database, CreateDatabaseMetadata>
154168
createDatabaseOperationCallable() {
155169
throw new UnsupportedOperationException("Not implemented: createDatabaseOperationCallable()");

‎google-cloud-firestore-admin/src/main/java/com/google/cloud/firestore/v1/stub/FirestoreAdminStubSettings.java

+79
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@
5454
import com.google.common.collect.Lists;
5555
import com.google.firestore.admin.v1.Backup;
5656
import com.google.firestore.admin.v1.BackupSchedule;
57+
import com.google.firestore.admin.v1.BulkDeleteDocumentsMetadata;
58+
import com.google.firestore.admin.v1.BulkDeleteDocumentsRequest;
59+
import com.google.firestore.admin.v1.BulkDeleteDocumentsResponse;
5760
import com.google.firestore.admin.v1.CreateBackupScheduleRequest;
5861
import com.google.firestore.admin.v1.CreateDatabaseMetadata;
5962
import com.google.firestore.admin.v1.CreateDatabaseRequest;
@@ -167,6 +170,11 @@ public class FirestoreAdminStubSettings extends StubSettings<FirestoreAdminStubS
167170
private final UnaryCallSettings<ImportDocumentsRequest, Operation> importDocumentsSettings;
168171
private final OperationCallSettings<ImportDocumentsRequest, Empty, ImportDocumentsMetadata>
169172
importDocumentsOperationSettings;
173+
private final UnaryCallSettings<BulkDeleteDocumentsRequest, Operation>
174+
bulkDeleteDocumentsSettings;
175+
private final OperationCallSettings<
176+
BulkDeleteDocumentsRequest, BulkDeleteDocumentsResponse, BulkDeleteDocumentsMetadata>
177+
bulkDeleteDocumentsOperationSettings;
170178
private final UnaryCallSettings<CreateDatabaseRequest, Operation> createDatabaseSettings;
171179
private final OperationCallSettings<CreateDatabaseRequest, Database, CreateDatabaseMetadata>
172180
createDatabaseOperationSettings;
@@ -373,6 +381,18 @@ public UnaryCallSettings<ImportDocumentsRequest, Operation> importDocumentsSetti
373381
return importDocumentsOperationSettings;
374382
}
375383

384+
/** Returns the object with the settings used for calls to bulkDeleteDocuments. */
385+
public UnaryCallSettings<BulkDeleteDocumentsRequest, Operation> bulkDeleteDocumentsSettings() {
386+
return bulkDeleteDocumentsSettings;
387+
}
388+
389+
/** Returns the object with the settings used for calls to bulkDeleteDocuments. */
390+
public OperationCallSettings<
391+
BulkDeleteDocumentsRequest, BulkDeleteDocumentsResponse, BulkDeleteDocumentsMetadata>
392+
bulkDeleteDocumentsOperationSettings() {
393+
return bulkDeleteDocumentsOperationSettings;
394+
}
395+
376396
/** Returns the object with the settings used for calls to createDatabase. */
377397
public UnaryCallSettings<CreateDatabaseRequest, Operation> createDatabaseSettings() {
378398
return createDatabaseSettings;
@@ -593,6 +613,9 @@ protected FirestoreAdminStubSettings(Builder settingsBuilder) throws IOException
593613
exportDocumentsOperationSettings = settingsBuilder.exportDocumentsOperationSettings().build();
594614
importDocumentsSettings = settingsBuilder.importDocumentsSettings().build();
595615
importDocumentsOperationSettings = settingsBuilder.importDocumentsOperationSettings().build();
616+
bulkDeleteDocumentsSettings = settingsBuilder.bulkDeleteDocumentsSettings().build();
617+
bulkDeleteDocumentsOperationSettings =
618+
settingsBuilder.bulkDeleteDocumentsOperationSettings().build();
596619
createDatabaseSettings = settingsBuilder.createDatabaseSettings().build();
597620
createDatabaseOperationSettings = settingsBuilder.createDatabaseOperationSettings().build();
598621
getDatabaseSettings = settingsBuilder.getDatabaseSettings().build();
@@ -641,6 +664,11 @@ public static class Builder extends StubSettings.Builder<FirestoreAdminStubSetti
641664
private final OperationCallSettings.Builder<
642665
ImportDocumentsRequest, Empty, ImportDocumentsMetadata>
643666
importDocumentsOperationSettings;
667+
private final UnaryCallSettings.Builder<BulkDeleteDocumentsRequest, Operation>
668+
bulkDeleteDocumentsSettings;
669+
private final OperationCallSettings.Builder<
670+
BulkDeleteDocumentsRequest, BulkDeleteDocumentsResponse, BulkDeleteDocumentsMetadata>
671+
bulkDeleteDocumentsOperationSettings;
644672
private final UnaryCallSettings.Builder<CreateDatabaseRequest, Operation>
645673
createDatabaseSettings;
646674
private final OperationCallSettings.Builder<
@@ -746,6 +774,8 @@ protected Builder(ClientContext clientContext) {
746774
exportDocumentsOperationSettings = OperationCallSettings.newBuilder();
747775
importDocumentsSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
748776
importDocumentsOperationSettings = OperationCallSettings.newBuilder();
777+
bulkDeleteDocumentsSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
778+
bulkDeleteDocumentsOperationSettings = OperationCallSettings.newBuilder();
749779
createDatabaseSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
750780
createDatabaseOperationSettings = OperationCallSettings.newBuilder();
751781
getDatabaseSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
@@ -776,6 +806,7 @@ protected Builder(ClientContext clientContext) {
776806
listFieldsSettings,
777807
exportDocumentsSettings,
778808
importDocumentsSettings,
809+
bulkDeleteDocumentsSettings,
779810
createDatabaseSettings,
780811
getDatabaseSettings,
781812
listDatabasesSettings,
@@ -809,6 +840,9 @@ protected Builder(FirestoreAdminStubSettings settings) {
809840
exportDocumentsOperationSettings = settings.exportDocumentsOperationSettings.toBuilder();
810841
importDocumentsSettings = settings.importDocumentsSettings.toBuilder();
811842
importDocumentsOperationSettings = settings.importDocumentsOperationSettings.toBuilder();
843+
bulkDeleteDocumentsSettings = settings.bulkDeleteDocumentsSettings.toBuilder();
844+
bulkDeleteDocumentsOperationSettings =
845+
settings.bulkDeleteDocumentsOperationSettings.toBuilder();
812846
createDatabaseSettings = settings.createDatabaseSettings.toBuilder();
813847
createDatabaseOperationSettings = settings.createDatabaseOperationSettings.toBuilder();
814848
getDatabaseSettings = settings.getDatabaseSettings.toBuilder();
@@ -839,6 +873,7 @@ protected Builder(FirestoreAdminStubSettings settings) {
839873
listFieldsSettings,
840874
exportDocumentsSettings,
841875
importDocumentsSettings,
876+
bulkDeleteDocumentsSettings,
842877
createDatabaseSettings,
843878
getDatabaseSettings,
844879
listDatabasesSettings,
@@ -925,6 +960,11 @@ private static Builder initDefaults(Builder builder) {
925960
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("no_retry_1_codes"))
926961
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("no_retry_1_params"));
927962

963+
builder
964+
.bulkDeleteDocumentsSettings()
965+
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("no_retry_1_codes"))
966+
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("no_retry_1_params"));
967+
928968
builder
929969
.createDatabaseSettings()
930970
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("no_retry_codes"))
@@ -1089,6 +1129,32 @@ private static Builder initDefaults(Builder builder) {
10891129
.setTotalTimeout(Duration.ofMillis(300000L))
10901130
.build()));
10911131

1132+
builder
1133+
.bulkDeleteDocumentsOperationSettings()
1134+
.setInitialCallSettings(
1135+
UnaryCallSettings
1136+
.<BulkDeleteDocumentsRequest, OperationSnapshot>newUnaryCallSettingsBuilder()
1137+
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("no_retry_1_codes"))
1138+
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("no_retry_1_params"))
1139+
.build())
1140+
.setResponseTransformer(
1141+
ProtoOperationTransformers.ResponseTransformer.create(
1142+
BulkDeleteDocumentsResponse.class))
1143+
.setMetadataTransformer(
1144+
ProtoOperationTransformers.MetadataTransformer.create(
1145+
BulkDeleteDocumentsMetadata.class))
1146+
.setPollingAlgorithm(
1147+
OperationTimedPollAlgorithm.create(
1148+
RetrySettings.newBuilder()
1149+
.setInitialRetryDelay(Duration.ofMillis(5000L))
1150+
.setRetryDelayMultiplier(1.5)
1151+
.setMaxRetryDelay(Duration.ofMillis(45000L))
1152+
.setInitialRpcTimeout(Duration.ZERO)
1153+
.setRpcTimeoutMultiplier(1.0)
1154+
.setMaxRpcTimeout(Duration.ZERO)
1155+
.setTotalTimeout(Duration.ofMillis(300000L))
1156+
.build()));
1157+
10921158
builder
10931159
.createDatabaseOperationSettings()
10941160
.setInitialCallSettings(
@@ -1276,6 +1342,19 @@ public UnaryCallSettings.Builder<ImportDocumentsRequest, Operation> importDocume
12761342
return importDocumentsOperationSettings;
12771343
}
12781344

1345+
/** Returns the builder for the settings used for calls to bulkDeleteDocuments. */
1346+
public UnaryCallSettings.Builder<BulkDeleteDocumentsRequest, Operation>
1347+
bulkDeleteDocumentsSettings() {
1348+
return bulkDeleteDocumentsSettings;
1349+
}
1350+
1351+
/** Returns the builder for the settings used for calls to bulkDeleteDocuments. */
1352+
public OperationCallSettings.Builder<
1353+
BulkDeleteDocumentsRequest, BulkDeleteDocumentsResponse, BulkDeleteDocumentsMetadata>
1354+
bulkDeleteDocumentsOperationSettings() {
1355+
return bulkDeleteDocumentsOperationSettings;
1356+
}
1357+
12791358
/** Returns the builder for the settings used for calls to createDatabase. */
12801359
public UnaryCallSettings.Builder<CreateDatabaseRequest, Operation> createDatabaseSettings() {
12811360
return createDatabaseSettings;

‎google-cloud-firestore-admin/src/main/java/com/google/cloud/firestore/v1/stub/GrpcFirestoreAdminStub.java

+50
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@
2929
import com.google.api.gax.rpc.UnaryCallable;
3030
import com.google.firestore.admin.v1.Backup;
3131
import com.google.firestore.admin.v1.BackupSchedule;
32+
import com.google.firestore.admin.v1.BulkDeleteDocumentsMetadata;
33+
import com.google.firestore.admin.v1.BulkDeleteDocumentsRequest;
34+
import com.google.firestore.admin.v1.BulkDeleteDocumentsResponse;
3235
import com.google.firestore.admin.v1.CreateBackupScheduleRequest;
3336
import com.google.firestore.admin.v1.CreateDatabaseMetadata;
3437
import com.google.firestore.admin.v1.CreateDatabaseRequest;
@@ -165,6 +168,16 @@ public class GrpcFirestoreAdminStub extends FirestoreAdminStub {
165168
.setResponseMarshaller(ProtoUtils.marshaller(Operation.getDefaultInstance()))
166169
.build();
167170

171+
private static final MethodDescriptor<BulkDeleteDocumentsRequest, Operation>
172+
bulkDeleteDocumentsMethodDescriptor =
173+
MethodDescriptor.<BulkDeleteDocumentsRequest, Operation>newBuilder()
174+
.setType(MethodDescriptor.MethodType.UNARY)
175+
.setFullMethodName("google.firestore.admin.v1.FirestoreAdmin/BulkDeleteDocuments")
176+
.setRequestMarshaller(
177+
ProtoUtils.marshaller(BulkDeleteDocumentsRequest.getDefaultInstance()))
178+
.setResponseMarshaller(ProtoUtils.marshaller(Operation.getDefaultInstance()))
179+
.build();
180+
168181
private static final MethodDescriptor<CreateDatabaseRequest, Operation>
169182
createDatabaseMethodDescriptor =
170183
MethodDescriptor.<CreateDatabaseRequest, Operation>newBuilder()
@@ -322,6 +335,10 @@ public class GrpcFirestoreAdminStub extends FirestoreAdminStub {
322335
private final UnaryCallable<ImportDocumentsRequest, Operation> importDocumentsCallable;
323336
private final OperationCallable<ImportDocumentsRequest, Empty, ImportDocumentsMetadata>
324337
importDocumentsOperationCallable;
338+
private final UnaryCallable<BulkDeleteDocumentsRequest, Operation> bulkDeleteDocumentsCallable;
339+
private final OperationCallable<
340+
BulkDeleteDocumentsRequest, BulkDeleteDocumentsResponse, BulkDeleteDocumentsMetadata>
341+
bulkDeleteDocumentsOperationCallable;
325342
private final UnaryCallable<CreateDatabaseRequest, Operation> createDatabaseCallable;
326343
private final OperationCallable<CreateDatabaseRequest, Database, CreateDatabaseMetadata>
327344
createDatabaseOperationCallable;
@@ -482,6 +499,16 @@ protected GrpcFirestoreAdminStub(
482499
return builder.build();
483500
})
484501
.build();
502+
GrpcCallSettings<BulkDeleteDocumentsRequest, Operation> bulkDeleteDocumentsTransportSettings =
503+
GrpcCallSettings.<BulkDeleteDocumentsRequest, Operation>newBuilder()
504+
.setMethodDescriptor(bulkDeleteDocumentsMethodDescriptor)
505+
.setParamsExtractor(
506+
request -> {
507+
RequestParamsBuilder builder = RequestParamsBuilder.create();
508+
builder.add("name", String.valueOf(request.getName()));
509+
return builder.build();
510+
})
511+
.build();
485512
GrpcCallSettings<CreateDatabaseRequest, Operation> createDatabaseTransportSettings =
486513
GrpcCallSettings.<CreateDatabaseRequest, Operation>newBuilder()
487514
.setMethodDescriptor(createDatabaseMethodDescriptor)
@@ -685,6 +712,17 @@ protected GrpcFirestoreAdminStub(
685712
settings.importDocumentsOperationSettings(),
686713
clientContext,
687714
operationsStub);
715+
this.bulkDeleteDocumentsCallable =
716+
callableFactory.createUnaryCallable(
717+
bulkDeleteDocumentsTransportSettings,
718+
settings.bulkDeleteDocumentsSettings(),
719+
clientContext);
720+
this.bulkDeleteDocumentsOperationCallable =
721+
callableFactory.createOperationCallable(
722+
bulkDeleteDocumentsTransportSettings,
723+
settings.bulkDeleteDocumentsOperationSettings(),
724+
clientContext,
725+
operationsStub);
688726
this.createDatabaseCallable =
689727
callableFactory.createUnaryCallable(
690728
createDatabaseTransportSettings, settings.createDatabaseSettings(), clientContext);
@@ -849,6 +887,18 @@ public UnaryCallable<ImportDocumentsRequest, Operation> importDocumentsCallable(
849887
return importDocumentsOperationCallable;
850888
}
851889

890+
@Override
891+
public UnaryCallable<BulkDeleteDocumentsRequest, Operation> bulkDeleteDocumentsCallable() {
892+
return bulkDeleteDocumentsCallable;
893+
}
894+
895+
@Override
896+
public OperationCallable<
897+
BulkDeleteDocumentsRequest, BulkDeleteDocumentsResponse, BulkDeleteDocumentsMetadata>
898+
bulkDeleteDocumentsOperationCallable() {
899+
return bulkDeleteDocumentsOperationCallable;
900+
}
901+
852902
@Override
853903
public UnaryCallable<CreateDatabaseRequest, Operation> createDatabaseCallable() {
854904
return createDatabaseCallable;

0 commit comments

Comments
 (0)