@google-cloud/firestore-api 0.2.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/protos/google/firestore/v1/common.proto +7 -0
- package/build/protos/google/firestore/v1/firestore.proto +51 -0
- package/build/protos/protos.d.ts +1819 -7935
- package/build/protos/protos.js +1 -1
- package/build/protos/protos.json +1 -1
- package/build/src/index.d.ts +7 -6
- package/build/src/index.js +5 -5
- package/build/src/index.js.map +1 -1
- package/build/src/v1/firestore_client.d.ts +42 -0
- package/build/src/v1/firestore_client.js +20 -0
- package/build/src/v1/firestore_client.js.map +1 -1
- package/build/src/v1/gapic_metadata.json +72 -248
- package/build/src/v1/index.js +2 -2
- package/build/src/v1/index.js.map +1 -1
- package/package.json +47 -8
- package/build/protos/google/firestore/v1beta1/common.proto +0 -82
- package/build/protos/google/firestore/v1beta1/document.proto +0 -149
- package/build/protos/google/firestore/v1beta1/firestore.proto +0 -900
- package/build/protos/google/firestore/v1beta1/query.proto +0 -300
- package/build/protos/google/firestore/v1beta1/undeliverable_first_gen_event.proto +0 -75
- package/build/protos/google/firestore/v1beta1/write.proto +0 -258
- package/build/src/v1beta1/firestore_client.d.ts +0 -930
- package/build/src/v1beta1/firestore_client.js +0 -1310
- package/build/src/v1beta1/firestore_client.js.map +0 -1
- package/build/src/v1beta1/firestore_client_config.json +0 -99
- package/build/src/v1beta1/firestore_proto_list.json +0 -8
- package/build/src/v1beta1/gapic_metadata.json +0 -165
- package/build/src/v1beta1/index.d.ts +0 -1
- package/build/src/v1beta1/index.js +0 -23
- package/build/src/v1beta1/index.js.map +0 -1
|
@@ -109,3 +109,10 @@ message TransactionOptions {
|
|
|
109
109
|
ReadWrite read_write = 3;
|
|
110
110
|
}
|
|
111
111
|
}
|
|
112
|
+
|
|
113
|
+
// Options for a server request.
|
|
114
|
+
message RequestOptions {
|
|
115
|
+
// The request tags for the request.
|
|
116
|
+
repeated string request_tags = 1 [(google.api.field_behavior) = OPTIONAL];
|
|
117
|
+
}
|
|
118
|
+
|
|
@@ -285,6 +285,9 @@ message GetDocumentRequest {
|
|
|
285
285
|
// minute timestamp within the past 7 days.
|
|
286
286
|
google.protobuf.Timestamp read_time = 5;
|
|
287
287
|
}
|
|
288
|
+
|
|
289
|
+
// Optional. Any additional options for the request.
|
|
290
|
+
RequestOptions request_options = 10 [(google.api.field_behavior) = OPTIONAL];
|
|
288
291
|
}
|
|
289
292
|
|
|
290
293
|
// The request for
|
|
@@ -358,6 +361,9 @@ message ListDocumentsRequest {
|
|
|
358
361
|
//
|
|
359
362
|
// Requests with `show_missing` may not specify `where` or `order_by`.
|
|
360
363
|
bool show_missing = 12;
|
|
364
|
+
|
|
365
|
+
// Optional. Any additional options for the request.
|
|
366
|
+
RequestOptions request_options = 13 [(google.api.field_behavior) = OPTIONAL];
|
|
361
367
|
}
|
|
362
368
|
|
|
363
369
|
// The response for
|
|
@@ -397,6 +403,9 @@ message CreateDocumentRequest {
|
|
|
397
403
|
// If the document has a field that is not present in this mask, that field
|
|
398
404
|
// will not be returned in the response.
|
|
399
405
|
DocumentMask mask = 5;
|
|
406
|
+
|
|
407
|
+
// Optional. Any additional options for the request.
|
|
408
|
+
RequestOptions request_options = 6 [(google.api.field_behavior) = OPTIONAL];
|
|
400
409
|
}
|
|
401
410
|
|
|
402
411
|
// The request for
|
|
@@ -424,6 +433,9 @@ message UpdateDocumentRequest {
|
|
|
424
433
|
// An optional precondition on the document.
|
|
425
434
|
// The request will fail if this is set and not met by the target document.
|
|
426
435
|
Precondition current_document = 4;
|
|
436
|
+
|
|
437
|
+
// Optional. Any additional options for the request.
|
|
438
|
+
RequestOptions request_options = 5 [(google.api.field_behavior) = OPTIONAL];
|
|
427
439
|
}
|
|
428
440
|
|
|
429
441
|
// The request for
|
|
@@ -436,6 +448,9 @@ message DeleteDocumentRequest {
|
|
|
436
448
|
// An optional precondition on the document.
|
|
437
449
|
// The request will fail if this is set and not met by the target document.
|
|
438
450
|
Precondition current_document = 2;
|
|
451
|
+
|
|
452
|
+
// Optional. Any additional options for the request.
|
|
453
|
+
RequestOptions request_options = 3 [(google.api.field_behavior) = OPTIONAL];
|
|
439
454
|
}
|
|
440
455
|
|
|
441
456
|
// The request for
|
|
@@ -476,6 +491,9 @@ message BatchGetDocumentsRequest {
|
|
|
476
491
|
// minute timestamp within the past 7 days.
|
|
477
492
|
google.protobuf.Timestamp read_time = 7;
|
|
478
493
|
}
|
|
494
|
+
|
|
495
|
+
// Optional. Any additional options for the request.
|
|
496
|
+
RequestOptions request_options = 8 [(google.api.field_behavior) = OPTIONAL];
|
|
479
497
|
}
|
|
480
498
|
|
|
481
499
|
// The streamed response for
|
|
@@ -515,6 +533,9 @@ message BeginTransactionRequest {
|
|
|
515
533
|
// The options for the transaction.
|
|
516
534
|
// Defaults to a read-write transaction.
|
|
517
535
|
TransactionOptions options = 2;
|
|
536
|
+
|
|
537
|
+
// Optional. Any additional options for the request.
|
|
538
|
+
RequestOptions request_options = 3 [(google.api.field_behavior) = OPTIONAL];
|
|
518
539
|
}
|
|
519
540
|
|
|
520
541
|
// The response for
|
|
@@ -537,6 +558,9 @@ message CommitRequest {
|
|
|
537
558
|
|
|
538
559
|
// If set, applies all writes in this transaction, and commits it.
|
|
539
560
|
bytes transaction = 3;
|
|
561
|
+
|
|
562
|
+
// Optional. Any additional options for the request.
|
|
563
|
+
RequestOptions request_options = 4 [(google.api.field_behavior) = OPTIONAL];
|
|
540
564
|
}
|
|
541
565
|
|
|
542
566
|
// The response for [Firestore.Commit][google.firestore.v1.Firestore.Commit].
|
|
@@ -560,6 +584,9 @@ message RollbackRequest {
|
|
|
560
584
|
|
|
561
585
|
// Required. The transaction to roll back.
|
|
562
586
|
bytes transaction = 2 [(google.api.field_behavior) = REQUIRED];
|
|
587
|
+
|
|
588
|
+
// Optional. Any additional options for the request.
|
|
589
|
+
RequestOptions request_options = 3 [(google.api.field_behavior) = OPTIONAL];
|
|
563
590
|
}
|
|
564
591
|
|
|
565
592
|
// The request for [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].
|
|
@@ -603,6 +630,9 @@ message RunQueryRequest {
|
|
|
603
630
|
// Optional. Explain options for the query. If set, additional query
|
|
604
631
|
// statistics will be returned. If not, only query results will be returned.
|
|
605
632
|
ExplainOptions explain_options = 10 [(google.api.field_behavior) = OPTIONAL];
|
|
633
|
+
|
|
634
|
+
// Optional. Any additional options for the request.
|
|
635
|
+
RequestOptions request_options = 11 [(google.api.field_behavior) = OPTIONAL];
|
|
606
636
|
}
|
|
607
637
|
|
|
608
638
|
// The response for
|
|
@@ -683,6 +713,9 @@ message ExecutePipelineRequest {
|
|
|
683
713
|
// executed. Only permitted in combination with `transaction` or
|
|
684
714
|
// `new_transaction`.
|
|
685
715
|
bool auto_commit_transaction = 9 [(google.api.field_behavior) = OPTIONAL];
|
|
716
|
+
|
|
717
|
+
// Optional. Any additional options for the request.
|
|
718
|
+
RequestOptions request_options = 10 [(google.api.field_behavior) = OPTIONAL];
|
|
686
719
|
}
|
|
687
720
|
|
|
688
721
|
// The response for [Firestore.Execute][].
|
|
@@ -771,6 +804,9 @@ message RunAggregationQueryRequest {
|
|
|
771
804
|
// Optional. Explain options for the query. If set, additional query
|
|
772
805
|
// statistics will be returned. If not, only query results will be returned.
|
|
773
806
|
ExplainOptions explain_options = 8 [(google.api.field_behavior) = OPTIONAL];
|
|
807
|
+
|
|
808
|
+
// Optional. Any additional options for the request.
|
|
809
|
+
RequestOptions request_options = 9 [(google.api.field_behavior) = OPTIONAL];
|
|
774
810
|
}
|
|
775
811
|
|
|
776
812
|
// The response for
|
|
@@ -865,6 +901,9 @@ message PartitionQueryRequest {
|
|
|
865
901
|
// minute timestamp within the past 7 days.
|
|
866
902
|
google.protobuf.Timestamp read_time = 6;
|
|
867
903
|
}
|
|
904
|
+
|
|
905
|
+
// Optional. Any additional options for the request.
|
|
906
|
+
RequestOptions request_options = 7 [(google.api.field_behavior) = OPTIONAL];
|
|
868
907
|
}
|
|
869
908
|
|
|
870
909
|
// The response for
|
|
@@ -942,6 +981,9 @@ message WriteRequest {
|
|
|
942
981
|
|
|
943
982
|
// Labels associated with this write request.
|
|
944
983
|
map<string, string> labels = 5;
|
|
984
|
+
|
|
985
|
+
// Optional. Any additional options for the request.
|
|
986
|
+
RequestOptions request_options = 6 [(google.api.field_behavior) = OPTIONAL];
|
|
945
987
|
}
|
|
946
988
|
|
|
947
989
|
// The response for [Firestore.Write][google.firestore.v1.Firestore.Write].
|
|
@@ -984,6 +1026,9 @@ message ListenRequest {
|
|
|
984
1026
|
|
|
985
1027
|
// Labels associated with this target change.
|
|
986
1028
|
map<string, string> labels = 4;
|
|
1029
|
+
|
|
1030
|
+
// Optional. Any additional options for the request.
|
|
1031
|
+
RequestOptions request_options = 5 [(google.api.field_behavior) = OPTIONAL];
|
|
987
1032
|
}
|
|
988
1033
|
|
|
989
1034
|
// The response for [Firestore.Listen][google.firestore.v1.Firestore.Listen].
|
|
@@ -1190,6 +1235,9 @@ message ListCollectionIdsRequest {
|
|
|
1190
1235
|
// minute timestamp within the past 7 days.
|
|
1191
1236
|
google.protobuf.Timestamp read_time = 4;
|
|
1192
1237
|
}
|
|
1238
|
+
|
|
1239
|
+
// Optional. Any additional options for the request.
|
|
1240
|
+
RequestOptions request_options = 5 [(google.api.field_behavior) = OPTIONAL];
|
|
1193
1241
|
}
|
|
1194
1242
|
|
|
1195
1243
|
// The response from
|
|
@@ -1218,6 +1266,9 @@ message BatchWriteRequest {
|
|
|
1218
1266
|
|
|
1219
1267
|
// Labels associated with this batch write.
|
|
1220
1268
|
map<string, string> labels = 3;
|
|
1269
|
+
|
|
1270
|
+
// Optional. Any additional options for the request.
|
|
1271
|
+
RequestOptions request_options = 4 [(google.api.field_behavior) = OPTIONAL];
|
|
1221
1272
|
}
|
|
1222
1273
|
|
|
1223
1274
|
// The response from
|