@google-cloud/firestore-api 0.1.0 → 0.4.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.
Files changed (25) hide show
  1. package/build/protos/protos.d.ts +1620 -7935
  2. package/build/protos/protos.js +1 -1
  3. package/build/protos/protos.json +1 -1
  4. package/build/src/index.d.ts +7 -6
  5. package/build/src/index.js +5 -5
  6. package/build/src/index.js.map +1 -1
  7. package/build/src/v1/gapic_metadata.json +72 -248
  8. package/build/src/v1/index.js +2 -2
  9. package/build/src/v1/index.js.map +1 -1
  10. package/package.json +43 -8
  11. package/build/protos/google/firestore/v1beta1/common.proto +0 -82
  12. package/build/protos/google/firestore/v1beta1/document.proto +0 -149
  13. package/build/protos/google/firestore/v1beta1/firestore.proto +0 -900
  14. package/build/protos/google/firestore/v1beta1/query.proto +0 -300
  15. package/build/protos/google/firestore/v1beta1/undeliverable_first_gen_event.proto +0 -75
  16. package/build/protos/google/firestore/v1beta1/write.proto +0 -258
  17. package/build/src/v1beta1/firestore_client.d.ts +0 -930
  18. package/build/src/v1beta1/firestore_client.js +0 -1310
  19. package/build/src/v1beta1/firestore_client.js.map +0 -1
  20. package/build/src/v1beta1/firestore_client_config.json +0 -99
  21. package/build/src/v1beta1/firestore_proto_list.json +0 -8
  22. package/build/src/v1beta1/gapic_metadata.json +0 -165
  23. package/build/src/v1beta1/index.d.ts +0 -1
  24. package/build/src/v1beta1/index.js +0 -23
  25. package/build/src/v1beta1/index.js.map +0 -1
package/build/src/index.d.ts CHANGED
@@ -1,12 +1,13 @@
1
1
  import * as v1 from './v1';
2
- import * as v1beta1 from './v1beta1';
3
- declare const FirestoreClient: typeof v1beta1.FirestoreClient;
4
- type FirestoreClient = v1beta1.FirestoreClient;
5
- export { v1, v1beta1, FirestoreClient };
2
+ declare const FirestoreAdminClient: typeof v1.FirestoreAdminClient;
3
+ type FirestoreAdminClient = v1.FirestoreAdminClient;
4
+ declare const FirestoreClient: typeof v1.FirestoreClient;
5
+ type FirestoreClient = v1.FirestoreClient;
6
+ export { v1, FirestoreAdminClient, FirestoreClient };
6
7
  declare const _default: {
7
8
  v1: typeof v1;
8
- v1beta1: typeof v1beta1;
9
- FirestoreClient: typeof v1beta1.FirestoreClient;
9
+ FirestoreAdminClient: typeof v1.FirestoreAdminClient;
10
+ FirestoreClient: typeof v1.FirestoreClient;
10
11
  };
11
12
  export default _default;
12
13
  import * as protos from '../protos/protos';
package/build/src/index.js CHANGED
@@ -17,14 +17,14 @@
17
17
  // ** https://github.com/googleapis/synthtool **
18
18
  // ** All changes to this file may be overwritten. **
19
19
  Object.defineProperty(exports, "__esModule", { value: true });
20
- exports.protos = exports.FirestoreClient = exports.v1beta1 = exports.v1 = void 0;
20
+ exports.protos = exports.FirestoreClient = exports.FirestoreAdminClient = exports.v1 = void 0;
21
21
  const v1 = require("./v1");
22
22
  exports.v1 = v1;
23
- const v1beta1 = require("./v1beta1");
24
- exports.v1beta1 = v1beta1;
25
- const FirestoreClient = v1beta1.FirestoreClient;
23
+ const FirestoreAdminClient = v1.FirestoreAdminClient;
24
+ exports.FirestoreAdminClient = FirestoreAdminClient;
25
+ const FirestoreClient = v1.FirestoreClient;
26
26
  exports.FirestoreClient = FirestoreClient;
27
- exports.default = { v1, v1beta1, FirestoreClient };
27
+ exports.default = { v1, FirestoreAdminClient, FirestoreClient };
28
28
  const protos = require("../protos/protos");
29
29
  exports.protos = protos;
30
30
  //# sourceMappingURL=index.js.map
package/build/src/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,2DAA2D;AAC3D,gDAAgD;AAChD,qDAAqD;;;AAErD,2BAA2B;AAKnB,gBAAE;AAJV,qCAAqC;AAIzB,0BAAO;AAFnB,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;AAE3B,0CAAe;AACpC,kBAAe,EAAC,EAAE,EAAE,OAAO,EAAE,eAAe,EAAC,CAAC;AAC9C,2CAA2C;AACnC,wBAAM"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,2DAA2D;AAC3D,gDAAgD;AAChD,qDAAqD;;;AAErD,2BAA2B;AAOnB,gBAAE;AALV,MAAM,oBAAoB,GAAG,EAAE,CAAC,oBAAoB,CAAC;AAKzC,oDAAoB;AAHhC,MAAM,eAAe,GAAG,EAAE,CAAC,eAAe,CAAC;AAGT,0CAAe;AACjD,kBAAe,EAAC,EAAE,EAAE,oBAAoB,EAAE,eAAe,EAAC,CAAC;AAC3D,2CAA2C;AACnC,wBAAM"}
package/build/src/v1/gapic_metadata.json CHANGED
@@ -2,345 +2,169 @@
2
2
  "schema": "1.0",
3
3
  "comment": "This file maps proto services/RPCs to the corresponding library clients/methods",
4
4
  "language": "typescript",
5
- "protoPackage": "google.firestore.admin.v1",
5
+ "protoPackage": "google.firestore.v1",
6
6
  "libraryPackage": "@google-cloud/firestore-api",
7
7
  "services": {
8
- "FirestoreAdmin": {
8
+ "Firestore": {
9
9
  "clients": {
10
10
  "grpc": {
11
- "libraryClient": "FirestoreAdminClient",
11
+ "libraryClient": "FirestoreClient",
12
12
  "rpcs": {
13
- "GetIndex": {
13
+ "GetDocument": {
14
14
  "methods": [
15
- "getIndex"
15
+ "getDocument"
16
16
  ]
17
17
  },
18
- "DeleteIndex": {
18
+ "UpdateDocument": {
19
19
  "methods": [
20
- "deleteIndex"
20
+ "updateDocument"
21
21
  ]
22
22
  },
23
- "GetField": {
23
+ "DeleteDocument": {
24
24
  "methods": [
25
- "getField"
25
+ "deleteDocument"
26
26
  ]
27
27
  },
28
- "GetDatabase": {
28
+ "BeginTransaction": {
29
29
  "methods": [
30
- "getDatabase"
30
+ "beginTransaction"
31
31
  ]
32
32
  },
33
- "ListDatabases": {
33
+ "Commit": {
34
34
  "methods": [
35
- "listDatabases"
35
+ "commit"
36
36
  ]
37
37
  },
38
- "CreateUserCreds": {
38
+ "Rollback": {
39
39
  "methods": [
40
- "createUserCreds"
40
+ "rollback"
41
41
  ]
42
42
  },
43
- "GetUserCreds": {
43
+ "BatchWrite": {
44
44
  "methods": [
45
- "getUserCreds"
45
+ "batchWrite"
46
46
  ]
47
47
  },
48
- "ListUserCreds": {
48
+ "CreateDocument": {
49
49
  "methods": [
50
- "listUserCreds"
50
+ "createDocument"
51
51
  ]
52
52
  },
53
- "EnableUserCreds": {
53
+ "BatchGetDocuments": {
54
54
  "methods": [
55
- "enableUserCreds"
55
+ "batchGetDocuments"
56
56
  ]
57
57
  },
58
- "DisableUserCreds": {
58
+ "RunQuery": {
59
59
  "methods": [
60
- "disableUserCreds"
60
+ "runQuery"
61
61
  ]
62
62
  },
63
- "ResetUserPassword": {
63
+ "ExecutePipeline": {
64
64
  "methods": [
65
- "resetUserPassword"
65
+ "executePipeline"
66
66
  ]
67
67
  },
68
- "DeleteUserCreds": {
68
+ "RunAggregationQuery": {
69
69
  "methods": [
70
- "deleteUserCreds"
70
+ "runAggregationQuery"
71
71
  ]
72
72
  },
73
- "GetBackup": {
73
+ "Write": {
74
74
  "methods": [
75
- "getBackup"
75
+ "write"
76
76
  ]
77
77
  },
78
- "ListBackups": {
78
+ "Listen": {
79
79
  "methods": [
80
- "listBackups"
80
+ "listen"
81
81
  ]
82
82
  },
83
- "DeleteBackup": {
83
+ "ListDocuments": {
84
84
  "methods": [
85
- "deleteBackup"
85
+ "listDocuments",
86
+ "listDocumentsStream",
87
+ "listDocumentsAsync"
86
88
  ]
87
89
  },
88
- "CreateBackupSchedule": {
90
+ "PartitionQuery": {
89
91
  "methods": [
90
- "createBackupSchedule"
92
+ "partitionQuery",
93
+ "partitionQueryStream",
94
+ "partitionQueryAsync"
91
95
  ]
92
96
  },
93
- "GetBackupSchedule": {
97
+ "ListCollectionIds": {
94
98
  "methods": [
95
- "getBackupSchedule"
96
- ]
97
- },
98
- "ListBackupSchedules": {
99
- "methods": [
100
- "listBackupSchedules"
101
- ]
102
- },
103
- "UpdateBackupSchedule": {
104
- "methods": [
105
- "updateBackupSchedule"
106
- ]
107
- },
108
- "DeleteBackupSchedule": {
109
- "methods": [
110
- "deleteBackupSchedule"
111
- ]
112
- },
113
- "CreateIndex": {
114
- "methods": [
115
- "createIndex"
116
- ]
117
- },
118
- "UpdateField": {
119
- "methods": [
120
- "updateField"
121
- ]
122
- },
123
- "ExportDocuments": {
124
- "methods": [
125
- "exportDocuments"
126
- ]
127
- },
128
- "ImportDocuments": {
129
- "methods": [
130
- "importDocuments"
131
- ]
132
- },
133
- "BulkDeleteDocuments": {
134
- "methods": [
135
- "bulkDeleteDocuments"
136
- ]
137
- },
138
- "CreateDatabase": {
139
- "methods": [
140
- "createDatabase"
141
- ]
142
- },
143
- "UpdateDatabase": {
144
- "methods": [
145
- "updateDatabase"
146
- ]
147
- },
148
- "DeleteDatabase": {
149
- "methods": [
150
- "deleteDatabase"
151
- ]
152
- },
153
- "RestoreDatabase": {
154
- "methods": [
155
- "restoreDatabase"
156
- ]
157
- },
158
- "CloneDatabase": {
159
- "methods": [
160
- "cloneDatabase"
161
- ]
162
- },
163
- "ListIndexes": {
164
- "methods": [
165
- "listIndexes",
166
- "listIndexesStream",
167
- "listIndexesAsync"
168
- ]
169
- },
170
- "ListFields": {
171
- "methods": [
172
- "listFields",
173
- "listFieldsStream",
174
- "listFieldsAsync"
99
+ "listCollectionIds",
100
+ "listCollectionIdsStream",
101
+ "listCollectionIdsAsync"
175
102
  ]
176
103
  }
177
104
  }
178
105
  },
179
106
  "grpc-fallback": {
180
- "libraryClient": "FirestoreAdminClient",
107
+ "libraryClient": "FirestoreClient",
181
108
  "rpcs": {
182
- "GetIndex": {
183
- "methods": [
184
- "getIndex"
185
- ]
186
- },
187
- "DeleteIndex": {
188
- "methods": [
189
- "deleteIndex"
190
- ]
191
- },
192
- "GetField": {
193
- "methods": [
194
- "getField"
195
- ]
196
- },
197
- "GetDatabase": {
198
- "methods": [
199
- "getDatabase"
200
- ]
201
- },
202
- "ListDatabases": {
203
- "methods": [
204
- "listDatabases"
205
- ]
206
- },
207
- "CreateUserCreds": {
208
- "methods": [
209
- "createUserCreds"
210
- ]
211
- },
212
- "GetUserCreds": {
213
- "methods": [
214
- "getUserCreds"
215
- ]
216
- },
217
- "ListUserCreds": {
218
- "methods": [
219
- "listUserCreds"
220
- ]
221
- },
222
- "EnableUserCreds": {
223
- "methods": [
224
- "enableUserCreds"
225
- ]
226
- },
227
- "DisableUserCreds": {
228
- "methods": [
229
- "disableUserCreds"
230
- ]
231
- },
232
- "ResetUserPassword": {
233
- "methods": [
234
- "resetUserPassword"
235
- ]
236
- },
237
- "DeleteUserCreds": {
238
- "methods": [
239
- "deleteUserCreds"
240
- ]
241
- },
242
- "GetBackup": {
243
- "methods": [
244
- "getBackup"
245
- ]
246
- },
247
- "ListBackups": {
248
- "methods": [
249
- "listBackups"
250
- ]
251
- },
252
- "DeleteBackup": {
253
- "methods": [
254
- "deleteBackup"
255
- ]
256
- },
257
- "CreateBackupSchedule": {
258
- "methods": [
259
- "createBackupSchedule"
260
- ]
261
- },
262
- "GetBackupSchedule": {
263
- "methods": [
264
- "getBackupSchedule"
265
- ]
266
- },
267
- "ListBackupSchedules": {
268
- "methods": [
269
- "listBackupSchedules"
270
- ]
271
- },
272
- "UpdateBackupSchedule": {
273
- "methods": [
274
- "updateBackupSchedule"
275
- ]
276
- },
277
- "DeleteBackupSchedule": {
278
- "methods": [
279
- "deleteBackupSchedule"
280
- ]
281
- },
282
- "CreateIndex": {
283
- "methods": [
284
- "createIndex"
285
- ]
286
- },
287
- "UpdateField": {
109
+ "GetDocument": {
288
110
  "methods": [
289
- "updateField"
111
+ "getDocument"
290
112
  ]
291
113
  },
292
- "ExportDocuments": {
114
+ "UpdateDocument": {
293
115
  "methods": [
294
- "exportDocuments"
116
+ "updateDocument"
295
117
  ]
296
118
  },
297
- "ImportDocuments": {
119
+ "DeleteDocument": {
298
120
  "methods": [
299
- "importDocuments"
121
+ "deleteDocument"
300
122
  ]
301
123
  },
302
- "BulkDeleteDocuments": {
124
+ "BeginTransaction": {
303
125
  "methods": [
304
- "bulkDeleteDocuments"
126
+ "beginTransaction"
305
127
  ]
306
128
  },
307
- "CreateDatabase": {
129
+ "Commit": {
308
130
  "methods": [
309
- "createDatabase"
131
+ "commit"
310
132
  ]
311
133
  },
312
- "UpdateDatabase": {
134
+ "Rollback": {
313
135
  "methods": [
314
- "updateDatabase"
136
+ "rollback"
315
137
  ]
316
138
  },
317
- "DeleteDatabase": {
139
+ "BatchWrite": {
318
140
  "methods": [
319
- "deleteDatabase"
141
+ "batchWrite"
320
142
  ]
321
143
  },
322
- "RestoreDatabase": {
144
+ "CreateDocument": {
323
145
  "methods": [
324
- "restoreDatabase"
146
+ "createDocument"
325
147
  ]
326
148
  },
327
- "CloneDatabase": {
149
+ "ListDocuments": {
328
150
  "methods": [
329
- "cloneDatabase"
151
+ "listDocuments",
152
+ "listDocumentsStream",
153
+ "listDocumentsAsync"
330
154
  ]
331
155
  },
332
- "ListIndexes": {
156
+ "PartitionQuery": {
333
157
  "methods": [
334
- "listIndexes",
335
- "listIndexesStream",
336
- "listIndexesAsync"
158
+ "partitionQuery",
159
+ "partitionQueryStream",
160
+ "partitionQueryAsync"
337
161
  ]
338
162
  },
339
- "ListFields": {
163
+ "ListCollectionIds": {
340
164
  "methods": [
341
- "listFields",
342
- "listFieldsStream",
343
- "listFieldsAsync"
165
+ "listCollectionIds",
166
+ "listCollectionIdsStream",
167
+ "listCollectionIdsAsync"
344
168
  ]
345
169
  }
346
170
  }
package/build/src/v1/index.js CHANGED
@@ -1,4 +1,6 @@
1
1
  "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.FirestoreClient = exports.FirestoreAdminClient = void 0;
2
4
  // Copyright 2026 Google LLC
3
5
  //
4
6
  // Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,8 +18,6 @@
16
18
  // ** This file is automatically generated by gapic-generator-typescript. **
17
19
  // ** https://github.com/googleapis/gapic-generator-typescript **
18
20
  // ** All changes to this file may be overwritten. **
19
- Object.defineProperty(exports, "__esModule", { value: true });
20
- exports.FirestoreClient = exports.FirestoreAdminClient = void 0;
21
21
  var firestore_admin_client_1 = require("./firestore_admin_client");
22
22
  Object.defineProperty(exports, "FirestoreAdminClient", { enumerable: true, get: function () { return firestore_admin_client_1.FirestoreAdminClient; } });
23
23
  var firestore_client_1 = require("./firestore_client");
package/build/src/v1/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v1/index.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,4EAA4E;AAC5E,iEAAiE;AACjE,qDAAqD;;;AAErD,mEAAgE;AAAvD,8HAAA,oBAAoB,OAAA;AAC7B,uDAAqD;AAA5C,mHAAA,eAAe,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v1/index.ts"],"names":[],"mappings":";;;AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,4EAA4E;AAC5E,iEAAiE;AACjE,qDAAqD;AACrD,mEAA8D;AAAtD,8HAAA,oBAAoB,OAAA;AAC5B,uDAAmD;AAA3C,mHAAA,eAAe,OAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@google-cloud/firestore-api",
3
- "version": "0.1.0",
3
+ "version": "0.4.0",
4
4
  "description": "Cloud Firestore API client for Node.js",
5
5
  "repository": {
6
6
  "type": "git",
@@ -11,6 +11,41 @@
11
11
  "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/packages/google-firestore-admin",
12
12
  "author": "Google LLC",
13
13
  "main": "build/src/index.js",
14
+ "exports": {
15
+ ".": {
16
+ "types": "./build/src/index.d.ts",
17
+ "default": "./build/src/index.js"
18
+ },
19
+ "./v1": {
20
+ "types": "./build/src/v1/index.d.ts",
21
+ "default": "./build/src/v1/index.js"
22
+ },
23
+ "./v1/firestore_client_config.json": "./build/src/v1/firestore_client_config.json",
24
+ "./client_v1": {
25
+ "types": "./build/src/v1/firestore_client.d.ts",
26
+ "default": "./build/src/v1/firestore_client.js"
27
+ },
28
+ "./admin_v1": {
29
+ "types": "./build/src/v1/firestore_admin_client.d.ts",
30
+ "default": "./build/src/v1/firestore_admin_client.js"
31
+ },
32
+ "./protos": {
33
+ "types": "./build/protos/protos.d.ts",
34
+ "default": "./build/protos/protos.js"
35
+ },
36
+ "./protos/protos.json": "./build/protos/protos.json",
37
+ "./build/protos/protos": {
38
+ "types": "./build/protos/protos.d.ts",
39
+ "default": "./build/protos/protos.js"
40
+ },
41
+ "./build/protos/protos.json": "./build/protos/protos.json",
42
+ "./build/src/v1": {
43
+ "types": "./build/src/v1/index.d.ts",
44
+ "default": "./build/src/v1/index.js"
45
+ },
46
+ "./build/src/v1/firestore_client_config.json": "./build/src/v1/firestore_client_config.json",
47
+ "./package.json": "./package.json"
48
+ },
14
49
  "files": [
15
50
  "build/src",
16
51
  "build/protos"
@@ -40,26 +75,26 @@
40
75
  "test": "c8 mocha --config ../../.mocharc.cjs build/test"
41
76
  },
42
77
  "dependencies": {
43
- "google-gax": "^5.0.0"
78
+ "google-gax": "^6.0.0",
79
+ "long": "^5.3.2"
44
80
  },
45
81
  "devDependencies": {
46
82
  "@types/mocha": "^10.0.10",
47
83
  "@types/node": "^22.18.12",
48
84
  "@types/sinon": "^20.0.0",
49
85
  "c8": "^10.1.3",
50
- "gapic-tools": "^1.0.3",
86
+ "gapic-tools": "^2.0.0",
51
87
  "gts": "^6.0.2",
52
88
  "jsdoc": "^4.0.5",
53
- "jsdoc-fresh": "^5.0.2",
54
- "jsdoc-region-tag": "^4.0.1",
55
- "long": "^5.3.2",
89
+ "jsdoc-fresh": "^6.0.0",
90
+ "jsdoc-region-tag": "^5.0.0",
56
91
  "mocha": "^11.7.4",
57
- "pack-n-play": "^4.2.1",
92
+ "pack-n-play": "^5.0.0",
58
93
  "typescript": "5.8.3",
59
94
  "sinon": "^20.0.0"
60
95
  },
61
96
  "engines": {
62
- "node": ">=18"
97
+ "node": ">=22"
63
98
  },
64
99
  "types": "build/src/index.d.ts"
65
100
  }
package/build/protos/google/firestore/v1beta1/common.proto DELETED
@@ -1,82 +0,0 @@
1
- // Copyright 2025 Google LLC
2
- //
3
- // Licensed under the Apache License, Version 2.0 (the "License");
4
- // you may not use this file except in compliance with the License.
5
- // You may obtain a copy of the License at
6
- //
7
- // http://www.apache.org/licenses/LICENSE-2.0
8
- //
9
- // Unless required by applicable law or agreed to in writing, software
10
- // distributed under the License is distributed on an "AS IS" BASIS,
11
- // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- // See the License for the specific language governing permissions and
13
- // limitations under the License.
14
-
15
- syntax = "proto3";
16
-
17
- package google.firestore.v1beta1;
18
-
19
- import "google/protobuf/timestamp.proto";
20
-
21
- option csharp_namespace = "Google.Cloud.Firestore.V1Beta1";
22
- option go_package = "cloud.google.com/go/firestore/apiv1beta1/firestorepb;firestorepb";
23
- option java_multiple_files = true;
24
- option java_outer_classname = "CommonProto";
25
- option java_package = "com.google.firestore.v1beta1";
26
- option objc_class_prefix = "GCFS";
27
- option php_namespace = "Google\\Cloud\\Firestore\\V1beta1";
28
- option ruby_package = "Google::Cloud::Firestore::V1beta1";
29
-
30
- // A set of field paths on a document.
31
- // Used to restrict a get or update operation on a document to a subset of its
32
- // fields.
33
- // This is different from standard field masks, as this is always scoped to a
34
- // [Document][google.firestore.v1beta1.Document], and takes in account the dynamic nature of [Value][google.firestore.v1beta1.Value].
35
- message DocumentMask {
36
- // The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field
37
- // path syntax reference.
38
- repeated string field_paths = 1;
39
- }
40
-
41
- // A precondition on a document, used for conditional operations.
42
- message Precondition {
43
- // The type of precondition.
44
- oneof condition_type {
45
- // When set to `true`, the target document must exist.
46
- // When set to `false`, the target document must not exist.
47
- bool exists = 1;
48
-
49
- // When set, the target document must exist and have been last updated at
50
- // that time.
51
- google.protobuf.Timestamp update_time = 2;
52
- }
53
- }
54
-
55
- // Options for creating a new transaction.
56
- message TransactionOptions {
57
- // Options for a transaction that can be used to read and write documents.
58
- message ReadWrite {
59
- // An optional transaction to retry.
60
- bytes retry_transaction = 1;
61
- }
62
-
63
- // Options for a transaction that can only be used to read documents.
64
- message ReadOnly {
65
- // The consistency mode for this transaction. If not set, defaults to strong
66
- // consistency.
67
- oneof consistency_selector {
68
- // Reads documents at the given time.
69
- // This may not be older than 60 seconds.
70
- google.protobuf.Timestamp read_time = 2;
71
- }
72
- }
73
-
74
- // The mode of the transaction.
75
- oneof mode {
76
- // The transaction can only be used for read operations.
77
- ReadOnly read_only = 2;
78
-
79
- // The transaction can be used for both read and write operations.
80
- ReadWrite read_write = 3;
81
- }
82
- }