Skip to content

Commit d14d7a1

Browse files
yoshi-automationyoshi-automation
committed
chore: enable gapicv2 for firestore/v1 API
Note that this contains breaking Java changes: com.google.cloud.firestore.v1.FirestoreClient: Method 'public void deleteDocument(com.google.firestore.v1.AnyPathName)' has been removed Committer: @miraleung PiperOrigin-RevId: 305561906 Source-Author: Google APIs <noreply@google.com> Source-Date: Wed Apr 8 15:01:42 2020 -0700 Source-Repo: googleapis/googleapis Source-Sha: d741cd976975c745d0199987aff0e908b8352992 Source-Link: googleapis/googleapis@d741cd9
1 parent 44ccfbd commit d14d7a1

File tree

4 files changed

+111
-180
lines changed

4 files changed

+111
-180
lines changed

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

Lines changed: 53 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@
3030
import com.google.cloud.firestore.v1.stub.FirestoreStub;
3131
import com.google.cloud.firestore.v1.stub.FirestoreStubSettings;
3232
import com.google.common.util.concurrent.MoreExecutors;
33-
import com.google.firestore.v1.AnyPathName;
3433
import com.google.firestore.v1.BatchGetDocumentsRequest;
3534
import com.google.firestore.v1.BatchGetDocumentsResponse;
3635
import com.google.firestore.v1.BeginTransactionRequest;
@@ -194,9 +193,9 @@ public FirestoreStub getStub() {
194193
*
195194
* <pre><code>
196195
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
197-
* AnyPathName name = AnyPathName.of("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]");
196+
* String name = "";
198197
* GetDocumentRequest request = GetDocumentRequest.newBuilder()
199-
* .setName(name.toString())
198+
* .setName(name)
200199
* .build();
201200
* Document response = firestoreClient.getDocument(request);
202201
* }
@@ -217,9 +216,9 @@ public final Document getDocument(GetDocumentRequest request) {
217216
*
218217
* <pre><code>
219218
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
220-
* AnyPathName name = AnyPathName.of("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]");
219+
* String name = "";
221220
* GetDocumentRequest request = GetDocumentRequest.newBuilder()
222-
* .setName(name.toString())
221+
* .setName(name)
223222
* .build();
224223
* ApiFuture&lt;Document&gt; future = firestoreClient.getDocumentCallable().futureCall(request);
225224
* // Do something
@@ -239,10 +238,10 @@ public final UnaryCallable<GetDocumentRequest, Document> getDocumentCallable() {
239238
*
240239
* <pre><code>
241240
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
242-
* String formattedParent = AnyPathName.format("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]");
241+
* String parent = "";
243242
* String collectionId = "";
244243
* ListDocumentsRequest request = ListDocumentsRequest.newBuilder()
245-
* .setParent(formattedParent)
244+
* .setParent(parent)
246245
* .setCollectionId(collectionId)
247246
* .build();
248247
* for (Document element : firestoreClient.listDocuments(request).iterateAll()) {
@@ -266,10 +265,10 @@ public final ListDocumentsPagedResponse listDocuments(ListDocumentsRequest reque
266265
*
267266
* <pre><code>
268267
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
269-
* String formattedParent = AnyPathName.format("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]");
268+
* String parent = "";
270269
* String collectionId = "";
271270
* ListDocumentsRequest request = ListDocumentsRequest.newBuilder()
272-
* .setParent(formattedParent)
271+
* .setParent(parent)
273272
* .setCollectionId(collectionId)
274273
* .build();
275274
* ApiFuture&lt;ListDocumentsPagedResponse&gt; future = firestoreClient.listDocumentsPagedCallable().futureCall(request);
@@ -293,10 +292,10 @@ public final ListDocumentsPagedResponse listDocuments(ListDocumentsRequest reque
293292
*
294293
* <pre><code>
295294
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
296-
* String formattedParent = AnyPathName.format("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]");
295+
* String parent = "";
297296
* String collectionId = "";
298297
* ListDocumentsRequest request = ListDocumentsRequest.newBuilder()
299-
* .setParent(formattedParent)
298+
* .setParent(parent)
300299
* .setCollectionId(collectionId)
301300
* .build();
302301
* while (true) {
@@ -326,14 +325,12 @@ public final UnaryCallable<ListDocumentsRequest, ListDocumentsResponse> listDocu
326325
*
327326
* <pre><code>
328327
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
329-
* String formattedParent = AnyPathName.format("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]");
328+
* String parent = "";
330329
* String collectionId = "";
331-
* String documentId = "";
332330
* Document document = Document.newBuilder().build();
333331
* CreateDocumentRequest request = CreateDocumentRequest.newBuilder()
334-
* .setParent(formattedParent)
332+
* .setParent(parent)
335333
* .setCollectionId(collectionId)
336-
* .setDocumentId(documentId)
337334
* .setDocument(document)
338335
* .build();
339336
* Document response = firestoreClient.createDocument(request);
@@ -355,14 +352,12 @@ public final Document createDocument(CreateDocumentRequest request) {
355352
*
356353
* <pre><code>
357354
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
358-
* String formattedParent = AnyPathName.format("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]");
355+
* String parent = "";
359356
* String collectionId = "";
360-
* String documentId = "";
361357
* Document document = Document.newBuilder().build();
362358
* CreateDocumentRequest request = CreateDocumentRequest.newBuilder()
363-
* .setParent(formattedParent)
359+
* .setParent(parent)
364360
* .setCollectionId(collectionId)
365-
* .setDocumentId(documentId)
366361
* .setDocument(document)
367362
* .build();
368363
* ApiFuture&lt;Document&gt; future = firestoreClient.createDocumentCallable().futureCall(request);
@@ -413,10 +408,8 @@ public final Document updateDocument(Document document, DocumentMask updateMask)
413408
* <pre><code>
414409
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
415410
* Document document = Document.newBuilder().build();
416-
* DocumentMask updateMask = DocumentMask.newBuilder().build();
417411
* UpdateDocumentRequest request = UpdateDocumentRequest.newBuilder()
418412
* .setDocument(document)
419-
* .setUpdateMask(updateMask)
420413
* .build();
421414
* Document response = firestoreClient.updateDocument(request);
422415
* }
@@ -438,10 +431,8 @@ public final Document updateDocument(UpdateDocumentRequest request) {
438431
* <pre><code>
439432
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
440433
* Document document = Document.newBuilder().build();
441-
* DocumentMask updateMask = DocumentMask.newBuilder().build();
442434
* UpdateDocumentRequest request = UpdateDocumentRequest.newBuilder()
443435
* .setDocument(document)
444-
* .setUpdateMask(updateMask)
445436
* .build();
446437
* ApiFuture&lt;Document&gt; future = firestoreClient.updateDocumentCallable().futureCall(request);
447438
* // Do something
@@ -461,7 +452,7 @@ public final UnaryCallable<UpdateDocumentRequest, Document> updateDocumentCallab
461452
*
462453
* <pre><code>
463454
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
464-
* AnyPathName name = AnyPathName.of("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]");
455+
* String name = "";
465456
* firestoreClient.deleteDocument(name);
466457
* }
467458
* </code></pre>
@@ -470,29 +461,6 @@ public final UnaryCallable<UpdateDocumentRequest, Document> updateDocumentCallab
470461
* `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
471462
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
472463
*/
473-
public final void deleteDocument(AnyPathName name) {
474-
DeleteDocumentRequest request =
475-
DeleteDocumentRequest.newBuilder().setName(name == null ? null : name.toString()).build();
476-
deleteDocument(request);
477-
}
478-
479-
// AUTO-GENERATED DOCUMENTATION AND METHOD
480-
/**
481-
* Deletes a document.
482-
*
483-
* <p>Sample code:
484-
*
485-
* <pre><code>
486-
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
487-
* AnyPathName name = AnyPathName.of("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]");
488-
* firestoreClient.deleteDocument(name.toString());
489-
* }
490-
* </code></pre>
491-
*
492-
* @param name Required. The resource name of the Document to delete. In the format:
493-
* `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
494-
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
495-
*/
496464
public final void deleteDocument(String name) {
497465
DeleteDocumentRequest request = DeleteDocumentRequest.newBuilder().setName(name).build();
498466
deleteDocument(request);
@@ -506,9 +474,9 @@ public final void deleteDocument(String name) {
506474
*
507475
* <pre><code>
508476
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
509-
* AnyPathName name = AnyPathName.of("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]");
477+
* String name = "";
510478
* DeleteDocumentRequest request = DeleteDocumentRequest.newBuilder()
511-
* .setName(name.toString())
479+
* .setName(name)
512480
* .build();
513481
* firestoreClient.deleteDocument(request);
514482
* }
@@ -529,9 +497,9 @@ public final void deleteDocument(DeleteDocumentRequest request) {
529497
*
530498
* <pre><code>
531499
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
532-
* AnyPathName name = AnyPathName.of("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]");
500+
* String name = "";
533501
* DeleteDocumentRequest request = DeleteDocumentRequest.newBuilder()
534-
* .setName(name.toString())
502+
* .setName(name)
535503
* .build();
536504
* ApiFuture&lt;Void&gt; future = firestoreClient.deleteDocumentCallable().futureCall(request);
537505
* // Do something
@@ -554,11 +522,9 @@ public final UnaryCallable<DeleteDocumentRequest, Empty> deleteDocumentCallable(
554522
*
555523
* <pre><code>
556524
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
557-
* String formattedDatabase = DatabaseRootName.format("[PROJECT]", "[DATABASE]");
558-
* List&lt;String&gt; documents = new ArrayList&lt;&gt;();
525+
* String database = "";
559526
* BatchGetDocumentsRequest request = BatchGetDocumentsRequest.newBuilder()
560-
* .setDatabase(formattedDatabase)
561-
* .addAllDocuments(documents)
527+
* .setDatabase(database)
562528
* .build();
563529
*
564530
* ServerStream&lt;BatchGetDocumentsResponse&gt; stream = firestoreClient.batchGetDocumentsCallable().call(request);
@@ -581,8 +547,8 @@ public final UnaryCallable<DeleteDocumentRequest, Empty> deleteDocumentCallable(
581547
*
582548
* <pre><code>
583549
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
584-
* String formattedDatabase = DatabaseRootName.format("[PROJECT]", "[DATABASE]");
585-
* BeginTransactionResponse response = firestoreClient.beginTransaction(formattedDatabase);
550+
* String database = "";
551+
* BeginTransactionResponse response = firestoreClient.beginTransaction(database);
586552
* }
587553
* </code></pre>
588554
*
@@ -604,9 +570,9 @@ public final BeginTransactionResponse beginTransaction(String database) {
604570
*
605571
* <pre><code>
606572
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
607-
* String formattedDatabase = DatabaseRootName.format("[PROJECT]", "[DATABASE]");
573+
* String database = "";
608574
* BeginTransactionRequest request = BeginTransactionRequest.newBuilder()
609-
* .setDatabase(formattedDatabase)
575+
* .setDatabase(database)
610576
* .build();
611577
* BeginTransactionResponse response = firestoreClient.beginTransaction(request);
612578
* }
@@ -627,9 +593,9 @@ public final BeginTransactionResponse beginTransaction(BeginTransactionRequest r
627593
*
628594
* <pre><code>
629595
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
630-
* String formattedDatabase = DatabaseRootName.format("[PROJECT]", "[DATABASE]");
596+
* String database = "";
631597
* BeginTransactionRequest request = BeginTransactionRequest.newBuilder()
632-
* .setDatabase(formattedDatabase)
598+
* .setDatabase(database)
633599
* .build();
634600
* ApiFuture&lt;BeginTransactionResponse&gt; future = firestoreClient.beginTransactionCallable().futureCall(request);
635601
* // Do something
@@ -650,9 +616,9 @@ public final BeginTransactionResponse beginTransaction(BeginTransactionRequest r
650616
*
651617
* <pre><code>
652618
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
653-
* String formattedDatabase = DatabaseRootName.format("[PROJECT]", "[DATABASE]");
619+
* String database = "";
654620
* List&lt;Write&gt; writes = new ArrayList&lt;&gt;();
655-
* CommitResponse response = firestoreClient.commit(formattedDatabase, writes);
621+
* CommitResponse response = firestoreClient.commit(database, writes);
656622
* }
657623
* </code></pre>
658624
*
@@ -676,11 +642,9 @@ public final CommitResponse commit(String database, List<Write> writes) {
676642
*
677643
* <pre><code>
678644
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
679-
* String formattedDatabase = DatabaseRootName.format("[PROJECT]", "[DATABASE]");
680-
* List&lt;Write&gt; writes = new ArrayList&lt;&gt;();
645+
* String database = "";
681646
* CommitRequest request = CommitRequest.newBuilder()
682-
* .setDatabase(formattedDatabase)
683-
* .addAllWrites(writes)
647+
* .setDatabase(database)
684648
* .build();
685649
* CommitResponse response = firestoreClient.commit(request);
686650
* }
@@ -701,11 +665,9 @@ public final CommitResponse commit(CommitRequest request) {
701665
*
702666
* <pre><code>
703667
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
704-
* String formattedDatabase = DatabaseRootName.format("[PROJECT]", "[DATABASE]");
705-
* List&lt;Write&gt; writes = new ArrayList&lt;&gt;();
668+
* String database = "";
706669
* CommitRequest request = CommitRequest.newBuilder()
707-
* .setDatabase(formattedDatabase)
708-
* .addAllWrites(writes)
670+
* .setDatabase(database)
709671
* .build();
710672
* ApiFuture&lt;CommitResponse&gt; future = firestoreClient.commitCallable().futureCall(request);
711673
* // Do something
@@ -725,9 +687,9 @@ public final UnaryCallable<CommitRequest, CommitResponse> commitCallable() {
725687
*
726688
* <pre><code>
727689
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
728-
* String formattedDatabase = DatabaseRootName.format("[PROJECT]", "[DATABASE]");
690+
* String database = "";
729691
* ByteString transaction = ByteString.copyFromUtf8("");
730-
* firestoreClient.rollback(formattedDatabase, transaction);
692+
* firestoreClient.rollback(database, transaction);
731693
* }
732694
* </code></pre>
733695
*
@@ -750,10 +712,10 @@ public final void rollback(String database, ByteString transaction) {
750712
*
751713
* <pre><code>
752714
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
753-
* String formattedDatabase = DatabaseRootName.format("[PROJECT]", "[DATABASE]");
715+
* String database = "";
754716
* ByteString transaction = ByteString.copyFromUtf8("");
755717
* RollbackRequest request = RollbackRequest.newBuilder()
756-
* .setDatabase(formattedDatabase)
718+
* .setDatabase(database)
757719
* .setTransaction(transaction)
758720
* .build();
759721
* firestoreClient.rollback(request);
@@ -775,10 +737,10 @@ public final void rollback(RollbackRequest request) {
775737
*
776738
* <pre><code>
777739
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
778-
* String formattedDatabase = DatabaseRootName.format("[PROJECT]", "[DATABASE]");
740+
* String database = "";
779741
* ByteString transaction = ByteString.copyFromUtf8("");
780742
* RollbackRequest request = RollbackRequest.newBuilder()
781-
* .setDatabase(formattedDatabase)
743+
* .setDatabase(database)
782744
* .setTransaction(transaction)
783745
* .build();
784746
* ApiFuture&lt;Void&gt; future = firestoreClient.rollbackCallable().futureCall(request);
@@ -799,9 +761,9 @@ public final UnaryCallable<RollbackRequest, Empty> rollbackCallable() {
799761
*
800762
* <pre><code>
801763
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
802-
* String formattedParent = AnyPathName.format("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]");
764+
* String parent = "";
803765
* RunQueryRequest request = RunQueryRequest.newBuilder()
804-
* .setParent(formattedParent)
766+
* .setParent(parent)
805767
* .build();
806768
*
807769
* ServerStream&lt;RunQueryResponse&gt; stream = firestoreClient.runQueryCallable().call(request);
@@ -826,9 +788,9 @@ public final ServerStreamingCallable<RunQueryRequest, RunQueryResponse> runQuery
826788
* BidiStream&lt;WriteRequest, WriteResponse&gt; bidiStream =
827789
* firestoreClient.writeCallable().call();
828790
*
829-
* String formattedDatabase = DatabaseRootName.format("[PROJECT]", "[DATABASE]");
791+
* String database = "";
830792
* WriteRequest request = WriteRequest.newBuilder()
831-
* .setDatabase(formattedDatabase)
793+
* .setDatabase(database)
832794
* .build();
833795
* bidiStream.send(request);
834796
* for (WriteResponse response : bidiStream) {
@@ -852,9 +814,9 @@ public final BidiStreamingCallable<WriteRequest, WriteResponse> writeCallable()
852814
* BidiStream&lt;ListenRequest, ListenResponse&gt; bidiStream =
853815
* firestoreClient.listenCallable().call();
854816
*
855-
* String formattedDatabase = DatabaseRootName.format("[PROJECT]", "[DATABASE]");
817+
* String database = "";
856818
* ListenRequest request = ListenRequest.newBuilder()
857-
* .setDatabase(formattedDatabase)
819+
* .setDatabase(database)
858820
* .build();
859821
* bidiStream.send(request);
860822
* for (ListenResponse response : bidiStream) {
@@ -875,8 +837,8 @@ public final BidiStreamingCallable<ListenRequest, ListenResponse> listenCallable
875837
*
876838
* <pre><code>
877839
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
878-
* String formattedParent = AnyPathName.format("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]");
879-
* for (String element : firestoreClient.listCollectionIds(formattedParent).iterateAll()) {
840+
* String parent = "";
841+
* for (String element : firestoreClient.listCollectionIds(parent).iterateAll()) {
880842
* // doThingsWith(element);
881843
* }
882844
* }
@@ -901,9 +863,9 @@ public final ListCollectionIdsPagedResponse listCollectionIds(String parent) {
901863
*
902864
* <pre><code>
903865
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
904-
* String formattedParent = AnyPathName.format("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]");
866+
* String parent = "";
905867
* ListCollectionIdsRequest request = ListCollectionIdsRequest.newBuilder()
906-
* .setParent(formattedParent)
868+
* .setParent(parent)
907869
* .build();
908870
* for (String element : firestoreClient.listCollectionIds(request).iterateAll()) {
909871
* // doThingsWith(element);
@@ -926,9 +888,9 @@ public final ListCollectionIdsPagedResponse listCollectionIds(ListCollectionIdsR
926888
*
927889
* <pre><code>
928890
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
929-
* String formattedParent = AnyPathName.format("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]");
891+
* String parent = "";
930892
* ListCollectionIdsRequest request = ListCollectionIdsRequest.newBuilder()
931-
* .setParent(formattedParent)
893+
* .setParent(parent)
932894
* .build();
933895
* ApiFuture&lt;ListCollectionIdsPagedResponse&gt; future = firestoreClient.listCollectionIdsPagedCallable().futureCall(request);
934896
* // Do something
@@ -951,9 +913,9 @@ public final ListCollectionIdsPagedResponse listCollectionIds(ListCollectionIdsR
951913
*
952914
* <pre><code>
953915
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
954-
* String formattedParent = AnyPathName.format("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]");
916+
* String parent = "";
955917
* ListCollectionIdsRequest request = ListCollectionIdsRequest.newBuilder()
956-
* .setParent(formattedParent)
918+
* .setParent(parent)
957919
* .build();
958920
* while (true) {
959921
* ListCollectionIdsResponse response = firestoreClient.listCollectionIdsCallable().call(request);

0 commit comments

Comments
 (0)