-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
datastore-api.json
2291 lines (2291 loc) · 96.5 KB
/
datastore-api.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"https://www.googleapis.com/auth/datastore": {
"description": "View and manage your Google Cloud Datastore data"
}
}
}
},
"basePath": "",
"baseUrl": "https://datastore.googleapis.com/",
"batchPath": "batch",
"description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application. ",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/datastore/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "datastore:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://datastore.mtls.googleapis.com/",
"name": "datastore",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"methods": {
"allocateIds": {
"description": "Allocates IDs for the given keys, which is useful for referencing an entity before it is inserted.",
"flatPath": "v1/projects/{projectId}:allocateIds",
"httpMethod": "POST",
"id": "datastore.projects.allocateIds",
"parameterOrder": [
"projectId"
],
"parameters": {
"projectId": {
"description": "Required. The ID of the project against which to make the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}:allocateIds",
"request": {
"$ref": "AllocateIdsRequest"
},
"response": {
"$ref": "AllocateIdsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"beginTransaction": {
"description": "Begins a new transaction.",
"flatPath": "v1/projects/{projectId}:beginTransaction",
"httpMethod": "POST",
"id": "datastore.projects.beginTransaction",
"parameterOrder": [
"projectId"
],
"parameters": {
"projectId": {
"description": "Required. The ID of the project against which to make the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}:beginTransaction",
"request": {
"$ref": "BeginTransactionRequest"
},
"response": {
"$ref": "BeginTransactionResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"commit": {
"description": "Commits a transaction, optionally creating, deleting or modifying some entities.",
"flatPath": "v1/projects/{projectId}:commit",
"httpMethod": "POST",
"id": "datastore.projects.commit",
"parameterOrder": [
"projectId"
],
"parameters": {
"projectId": {
"description": "Required. The ID of the project against which to make the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}:commit",
"request": {
"$ref": "CommitRequest"
},
"response": {
"$ref": "CommitResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"export": {
"description": "Exports a copy of all or a subset of entities from Google Cloud Datastore to another storage system, such as Google Cloud Storage. Recent updates to entities may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.",
"flatPath": "v1/projects/{projectId}:export",
"httpMethod": "POST",
"id": "datastore.projects.export",
"parameterOrder": [
"projectId"
],
"parameters": {
"projectId": {
"description": "Required. Project ID against which to make the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}:export",
"request": {
"$ref": "GoogleDatastoreAdminV1ExportEntitiesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"import": {
"description": "Imports entities into Google Cloud Datastore. Existing entities with the same key are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportEntities operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Datastore.",
"flatPath": "v1/projects/{projectId}:import",
"httpMethod": "POST",
"id": "datastore.projects.import",
"parameterOrder": [
"projectId"
],
"parameters": {
"projectId": {
"description": "Required. Project ID against which to make the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}:import",
"request": {
"$ref": "GoogleDatastoreAdminV1ImportEntitiesRequest"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"lookup": {
"description": "Looks up entities by key.",
"flatPath": "v1/projects/{projectId}:lookup",
"httpMethod": "POST",
"id": "datastore.projects.lookup",
"parameterOrder": [
"projectId"
],
"parameters": {
"projectId": {
"description": "Required. The ID of the project against which to make the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}:lookup",
"request": {
"$ref": "LookupRequest"
},
"response": {
"$ref": "LookupResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"reserveIds": {
"description": "Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore.",
"flatPath": "v1/projects/{projectId}:reserveIds",
"httpMethod": "POST",
"id": "datastore.projects.reserveIds",
"parameterOrder": [
"projectId"
],
"parameters": {
"projectId": {
"description": "Required. The ID of the project against which to make the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}:reserveIds",
"request": {
"$ref": "ReserveIdsRequest"
},
"response": {
"$ref": "ReserveIdsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"rollback": {
"description": "Rolls back a transaction.",
"flatPath": "v1/projects/{projectId}:rollback",
"httpMethod": "POST",
"id": "datastore.projects.rollback",
"parameterOrder": [
"projectId"
],
"parameters": {
"projectId": {
"description": "Required. The ID of the project against which to make the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}:rollback",
"request": {
"$ref": "RollbackRequest"
},
"response": {
"$ref": "RollbackResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"runQuery": {
"description": "Queries for entities.",
"flatPath": "v1/projects/{projectId}:runQuery",
"httpMethod": "POST",
"id": "datastore.projects.runQuery",
"parameterOrder": [
"projectId"
],
"parameters": {
"projectId": {
"description": "Required. The ID of the project against which to make the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}:runQuery",
"request": {
"$ref": "RunQueryRequest"
},
"response": {
"$ref": "RunQueryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
}
},
"resources": {
"indexes": {
"methods": {
"create": {
"description": "Creates the specified index. A newly created index's initial state is `CREATING`. On completion of the returned google.longrunning.Operation, the state will be `READY`. If the index already exists, the call will return an `ALREADY_EXISTS` status. During index creation, the process could result in an error, in which case the index will move to the `ERROR` state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create. Indexes with a single property cannot be created.",
"flatPath": "v1/projects/{projectId}/indexes",
"httpMethod": "POST",
"id": "datastore.projects.indexes.create",
"parameterOrder": [
"projectId"
],
"parameters": {
"projectId": {
"description": "Project ID against which to make the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}/indexes",
"request": {
"$ref": "GoogleDatastoreAdminV1Index"
},
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"delete": {
"description": "Deletes an existing index. An index can only be deleted if it is in a `READY` or `ERROR` state. On successful execution of the request, the index will be in a `DELETING` state. And on completion of the returned google.longrunning.Operation, the index will be removed. During index deletion, the process could result in an error, in which case the index will move to the `ERROR` state. The process can be recovered by fixing the data that caused the error, followed by calling delete again.",
"flatPath": "v1/projects/{projectId}/indexes/{indexId}",
"httpMethod": "DELETE",
"id": "datastore.projects.indexes.delete",
"parameterOrder": [
"projectId",
"indexId"
],
"parameters": {
"indexId": {
"description": "The resource ID of the index to delete.",
"location": "path",
"required": true,
"type": "string"
},
"projectId": {
"description": "Project ID against which to make the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}/indexes/{indexId}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"get": {
"description": "Gets an index.",
"flatPath": "v1/projects/{projectId}/indexes/{indexId}",
"httpMethod": "GET",
"id": "datastore.projects.indexes.get",
"parameterOrder": [
"projectId",
"indexId"
],
"parameters": {
"indexId": {
"description": "The resource ID of the index to get.",
"location": "path",
"required": true,
"type": "string"
},
"projectId": {
"description": "Project ID against which to make the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}/indexes/{indexId}",
"response": {
"$ref": "GoogleDatastoreAdminV1Index"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"list": {
"description": "Lists the indexes that match the specified filters. Datastore uses an eventually consistent query to fetch the list of indexes and may occasionally return stale results.",
"flatPath": "v1/projects/{projectId}/indexes",
"httpMethod": "GET",
"id": "datastore.projects.indexes.list",
"parameterOrder": [
"projectId"
],
"parameters": {
"filter": {
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The maximum number of items to return. If zero, then all results will be returned.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The next_page_token value returned from a previous List request, if any.",
"location": "query",
"type": "string"
},
"projectId": {
"description": "Project ID against which to make the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}/indexes",
"response": {
"$ref": "GoogleDatastoreAdminV1ListIndexesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
}
}
},
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "datastore.projects.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"delete": {
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
"flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "datastore.projects.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "datastore.projects.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "GoogleLongrunningOperation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"flatPath": "v1/projects/{projectsId}/operations",
"httpMethod": "GET",
"id": "datastore.projects.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}/operations",
"response": {
"$ref": "GoogleLongrunningListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/datastore"
]
}
}
}
}
}
},
"revision": "20220730",
"rootUrl": "https://datastore.googleapis.com/",
"schemas": {
"AllocateIdsRequest": {
"description": "The request for Datastore.AllocateIds.",
"id": "AllocateIdsRequest",
"properties": {
"databaseId": {
"description": "The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.",
"type": "string"
},
"keys": {
"description": "Required. A list of keys with incomplete key paths for which to allocate IDs. No key may be reserved/read-only.",
"items": {
"$ref": "Key"
},
"type": "array"
}
},
"type": "object"
},
"AllocateIdsResponse": {
"description": "The response for Datastore.AllocateIds.",
"id": "AllocateIdsResponse",
"properties": {
"keys": {
"description": "The keys specified in the request (in the same order), each with its key path completed with a newly allocated ID.",
"items": {
"$ref": "Key"
},
"type": "array"
}
},
"type": "object"
},
"ArrayValue": {
"description": "An array value.",
"id": "ArrayValue",
"properties": {
"values": {
"description": "Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.",
"items": {
"$ref": "Value"
},
"type": "array"
}
},
"type": "object"
},
"BeginTransactionRequest": {
"description": "The request for Datastore.BeginTransaction.",
"id": "BeginTransactionRequest",
"properties": {
"databaseId": {
"description": "The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.",
"type": "string"
},
"transactionOptions": {
"$ref": "TransactionOptions",
"description": "Options for a new transaction."
}
},
"type": "object"
},
"BeginTransactionResponse": {
"description": "The response for Datastore.BeginTransaction.",
"id": "BeginTransactionResponse",
"properties": {
"transaction": {
"description": "The transaction identifier (always present).",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"CommitRequest": {
"description": "The request for Datastore.Commit.",
"id": "CommitRequest",
"properties": {
"databaseId": {
"description": "The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.",
"type": "string"
},
"mode": {
"description": "The type of commit to perform. Defaults to `TRANSACTIONAL`.",
"enum": [
"MODE_UNSPECIFIED",
"TRANSACTIONAL",
"NON_TRANSACTIONAL"
],
"enumDescriptions": [
"Unspecified. This value must not be used.",
"Transactional: The mutations are either all applied, or none are applied. Learn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).",
"Non-transactional: The mutations may not apply as all or none."
],
"type": "string"
},
"mutations": {
"description": "The mutations to perform. When mode is `TRANSACTIONAL`, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single `Commit` request: - `insert` followed by `insert` - `update` followed by `insert` - `upsert` followed by `insert` - `delete` followed by `update` When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single entity.",
"items": {
"$ref": "Mutation"
},
"type": "array"
},
"transaction": {
"description": "The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"CommitResponse": {
"description": "The response for Datastore.Commit.",
"id": "CommitResponse",
"properties": {
"commitTime": {
"description": "The transaction commit timestamp. Not set for non-transactional commits.",
"format": "google-datetime",
"type": "string"
},
"indexUpdates": {
"description": "The number of index entries updated during the commit, or zero if none were updated.",
"format": "int32",
"type": "integer"
},
"mutationResults": {
"description": "The result of performing the mutations. The i-th mutation result corresponds to the i-th mutation in the request.",
"items": {
"$ref": "MutationResult"
},
"type": "array"
}
},
"type": "object"
},
"CompositeFilter": {
"description": "A filter that merges multiple other filters using the given operator.",
"id": "CompositeFilter",
"properties": {
"filters": {
"description": "The list of filters to combine. Requires: * At least one filter is present.",
"items": {
"$ref": "Filter"
},
"type": "array"
},
"op": {
"description": "The operator for combining multiple filters.",
"enum": [
"OPERATOR_UNSPECIFIED",
"AND"
],
"enumDescriptions": [
"Unspecified. This value must not be used.",
"The results are required to satisfy each of the combined filters."
],
"type": "string"
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
"id": "Empty",
"properties": {},
"type": "object"
},
"Entity": {
"description": "A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message.",
"id": "Entity",
"properties": {
"key": {
"$ref": "Key",
"description": "The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key."
},
"properties": {
"additionalProperties": {
"$ref": "Value"
},
"description": "The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `\"\"`.",
"type": "object"
}
},
"type": "object"
},
"EntityResult": {
"description": "The result of fetching an entity from Datastore.",
"id": "EntityResult",
"properties": {
"cursor": {
"description": "A cursor that points to the position after the result entity. Set only when the `EntityResult` is part of a `QueryResultBatch` message.",
"format": "byte",
"type": "string"
},
"entity": {
"$ref": "Entity",
"description": "The resulting entity."
},
"updateTime": {
"description": "The time at which the entity was last changed. This field is set for `FULL` entity results. If this entity is missing, this field will not be set.",
"format": "google-datetime",
"type": "string"
},
"version": {
"description": "The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"Filter": {
"description": "A holder for any type of filter.",
"id": "Filter",
"properties": {
"compositeFilter": {
"$ref": "CompositeFilter",
"description": "A composite filter."
},
"propertyFilter": {
"$ref": "PropertyFilter",
"description": "A filter on a property."
}
},
"type": "object"
},
"GoogleDatastoreAdminV1CommonMetadata": {
"description": "Metadata common to all Datastore Admin operations.",
"id": "GoogleDatastoreAdminV1CommonMetadata",
"properties": {
"endTime": {
"description": "The time the operation ended, either successfully or otherwise.",
"format": "google-datetime",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "The client-assigned labels which were provided when the operation was created. May also include additional labels.",
"type": "object"
},
"operationType": {
"description": "The type of the operation. Can be used as a filter in ListOperationsRequest.",
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
"EXPORT_ENTITIES",
"IMPORT_ENTITIES",
"CREATE_INDEX",
"DELETE_INDEX"
],
"enumDescriptions": [
"Unspecified.",
"ExportEntities.",
"ImportEntities.",
"CreateIndex.",
"DeleteIndex."
],
"type": "string"
},
"startTime": {
"description": "The time that work began on the operation.",
"format": "google-datetime",
"type": "string"
},
"state": {
"description": "The current state of the Operation.",
"enum": [
"STATE_UNSPECIFIED",
"INITIALIZING",
"PROCESSING",
"CANCELLING",
"FINALIZING",
"SUCCESSFUL",
"FAILED",
"CANCELLED"
],
"enumDescriptions": [
"Unspecified.",
"Request is being prepared for processing.",
"Request is actively being processed.",
"Request is in the process of being cancelled after user called google.longrunning.Operations.CancelOperation on the operation.",
"Request has been processed and is in its finalization stage.",
"Request has completed successfully.",
"Request has finished being processed, but encountered an error.",
"Request has finished being cancelled after user called google.longrunning.Operations.CancelOperation."
],
"type": "string"
}
},
"type": "object"
},
"GoogleDatastoreAdminV1DatastoreFirestoreMigrationMetadata": {
"description": "Metadata for Datastore to Firestore migration operations. The DatastoreFirestoreMigration operation is not started by the end-user via an explicit \"creation\" method. This is an intentional deviation from the LRO design pattern. This singleton resource can be accessed at: \"projects/{project_id}/operations/datastore-firestore-migration\"",
"id": "GoogleDatastoreAdminV1DatastoreFirestoreMigrationMetadata",
"properties": {
"migrationState": {
"description": "The current state of migration from Cloud Datastore to Cloud Firestore in Datastore mode.",
"enum": [
"MIGRATION_STATE_UNSPECIFIED",
"RUNNING",
"PAUSED",
"COMPLETE"
],
"enumDescriptions": [
"Unspecified.",
"The migration is running.",
"The migration is paused.",
"The migration is complete."
],
"type": "string"
},
"migrationStep": {
"description": "The current step of migration from Cloud Datastore to Cloud Firestore in Datastore mode.",
"enum": [
"MIGRATION_STEP_UNSPECIFIED",
"PREPARE",
"START",
"APPLY_WRITES_SYNCHRONOUSLY",
"COPY_AND_VERIFY",
"REDIRECT_EVENTUALLY_CONSISTENT_READS",
"REDIRECT_STRONGLY_CONSISTENT_READS",
"REDIRECT_WRITES"
],
"enumDescriptions": [
"Unspecified.",
"Pre-migration: the database is prepared for migration.",
"Start of migration.",
"Writes are applied synchronously to at least one replica.",
"Data is copied to Cloud Firestore and then verified to match the data in Cloud Datastore.",
"Eventually-consistent reads are redirected to Cloud Firestore.",
"Strongly-consistent reads are redirected to Cloud Firestore.",
"Writes are redirected to Cloud Firestore."
],
"type": "string"
}
},
"type": "object"
},
"GoogleDatastoreAdminV1EntityFilter": {
"description": "Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz']",
"id": "GoogleDatastoreAdminV1EntityFilter",
"properties": {
"kinds": {
"description": "If empty, then this represents all kinds.",
"items": {
"type": "string"
},
"type": "array"
},
"namespaceIds": {
"description": "An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleDatastoreAdminV1ExportEntitiesMetadata": {
"description": "Metadata for ExportEntities operations.",
"id": "GoogleDatastoreAdminV1ExportEntitiesMetadata",
"properties": {
"common": {
"$ref": "GoogleDatastoreAdminV1CommonMetadata",
"description": "Metadata common to all Datastore Admin operations."
},
"entityFilter": {
"$ref": "GoogleDatastoreAdminV1EntityFilter",