You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pclass="firstline">Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents 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. For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import</p>
<pclass="firstline">Imports documents into Google Cloud Firestore. Existing documents with the same name 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 ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.</p>
name: string, Required. A name of the form `projects/{project_id}/databases/{database_id}` (required)
167
+
x__xgafv: string, V1 error format.
168
+
Allowed values
169
+
1 - v1 error format
170
+
2 - v2 error format
171
+
172
+
Returns:
173
+
An object of the form:
174
+
175
+
{ # A Cloud Firestore Database in Native Mode. Currently one database is allowed per cloud project. It is named '(default)'
176
+
"concurrencyMode": "A String", # The concurrency control mode to use for this database.
177
+
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
178
+
"locationId": "A String", # The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations.
179
+
"name": "A String", # The resource name of the Database. Format: `projects/{project}/databases/{database}`
180
+
"type": "A String", # The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
<pre>Imports documents into Google Cloud Firestore. Existing documents with the same name 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 ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.
parent: string, Required. A parent name of the form `projects/{project_id}` (required)
235
+
x__xgafv: string, V1 error format.
236
+
Allowed values
237
+
1 - v1 error format
238
+
2 - v2 error format
239
+
240
+
Returns:
241
+
An object of the form:
242
+
243
+
{ # The list of databases for a project.
244
+
"databases": [ # The databases in the project.
245
+
{ # A Cloud Firestore Database in Native Mode. Currently one database is allowed per cloud project. It is named '(default)'
246
+
"concurrencyMode": "A String", # The concurrency control mode to use for this database.
247
+
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
248
+
"locationId": "A String", # The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations.
249
+
"name": "A String", # The resource name of the Database. Format: `projects/{project}/databases/{database}`
250
+
"type": "A String", # The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
name: string, The resource name of the Database. Format: `projects/{project}/databases/{database}` (required)
262
+
body: object, The request body.
263
+
The object takes the form of:
264
+
265
+
{ # A Cloud Firestore Database in Native Mode. Currently one database is allowed per cloud project. It is named '(default)'
266
+
"concurrencyMode": "A String", # The concurrency control mode to use for this database.
267
+
"etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
268
+
"locationId": "A String", # The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations.
269
+
"name": "A String", # The resource name of the Database. Format: `projects/{project}/databases/{database}`
270
+
"type": "A String", # The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
271
+
}
272
+
273
+
updateMask: string, The list of fields to be updated.
274
+
x__xgafv: string, V1 error format.
275
+
Allowed values
276
+
1 - v1 error format
277
+
2 - v2 error format
278
+
279
+
Returns:
280
+
An object of the form:
281
+
282
+
{ # This resource represents a long-running operation that is the result of a network API call.
283
+
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
284
+
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
285
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
286
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
287
+
{
288
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
289
+
},
290
+
],
291
+
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
292
+
},
293
+
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
294
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
295
+
},
296
+
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
297
+
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
298
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
"description": "Required. A name of the form `projects/{project_id}/databases/{database_id}`",
155
+
"location": "path",
156
+
"pattern": "^projects/[^/]+/databases/[^/]+$",
157
+
"required": true,
158
+
"type": "string"
159
+
}
160
+
},
161
+
"path": "v1/{+name}",
162
+
"response": {
163
+
"$ref": "GoogleFirestoreAdminV1Database"
164
+
},
165
+
"scopes": [
166
+
"https://www.googleapis.com/auth/cloud-platform",
167
+
"https://www.googleapis.com/auth/datastore"
168
+
]
169
+
},
144
170
"importDocuments": {
145
171
"description": "Imports documents into Google Cloud Firestore. Existing documents with the same name 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 ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.",
"description": "The resource name of the Database. Format: `projects/{project}/databases/{database}`",
236
+
"location": "path",
237
+
"pattern": "^projects/[^/]+/databases/[^/]+$",
238
+
"required": true,
239
+
"type": "string"
240
+
},
241
+
"updateMask": {
242
+
"description": "The list of fields to be updated.",
243
+
"format": "google-fieldmask",
244
+
"location": "query",
245
+
"type": "string"
246
+
}
247
+
},
248
+
"path": "v1/{+name}",
249
+
"request": {
250
+
"$ref": "GoogleFirestoreAdminV1Database"
251
+
},
252
+
"response": {
253
+
"$ref": "GoogleLongrunningOperation"
254
+
},
255
+
"scopes": [
256
+
"https://www.googleapis.com/auth/cloud-platform",
257
+
"https://www.googleapis.com/auth/datastore"
258
+
]
172
259
}
173
260
},
174
261
"resources": {
@@ -1160,7 +1247,7 @@
1160
1247
}
1161
1248
}
1162
1249
},
1163
-
"revision": "20210901",
1250
+
"revision": "20210916",
1164
1251
"rootUrl": "https://firestore.googleapis.com/",
1165
1252
"schemas": {
1166
1253
"ArrayValue": {
@@ -1685,6 +1772,55 @@
1685
1772
},
1686
1773
"type": "object"
1687
1774
},
1775
+
"GoogleFirestoreAdminV1Database": {
1776
+
"description": "A Cloud Firestore Database in Native Mode. Currently one database is allowed per cloud project. It is named '(default)'",
1777
+
"id": "GoogleFirestoreAdminV1Database",
1778
+
"properties": {
1779
+
"concurrencyMode": {
1780
+
"description": "The concurrency control mode to use for this database.",
1781
+
"enum": [
1782
+
"CONCURRENCY_MODE_UNSPECIFIED",
1783
+
"OPTIMISTIC",
1784
+
"PESSIMISTIC",
1785
+
"OPTIMISTIC_WITH_ENTITY_GROUPS"
1786
+
],
1787
+
"enumDescriptions": [
1788
+
"Not used.",
1789
+
"Use optimistic concurrency control by default. This is the setting for Cloud Firestore customers.",
1790
+
"Use pessimistic concurrency control by default. This is the setting for Cloud Firestore customers.",
1791
+
"Use optimistic concurrency control with entity groups by default. This is the setting for Cloud Datastore customers."
1792
+
],
1793
+
"type": "string"
1794
+
},
1795
+
"etag": {
1796
+
"description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.",
1797
+
"type": "string"
1798
+
},
1799
+
"locationId": {
1800
+
"description": "The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations.",
1801
+
"type": "string"
1802
+
},
1803
+
"name": {
1804
+
"description": "The resource name of the Database. Format: `projects/{project}/databases/{database}`",
1805
+
"type": "string"
1806
+
},
1807
+
"type": {
1808
+
"description": "The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.",
1809
+
"enum": [
1810
+
"DATABASE_TYPE_UNSPECIFIED",
1811
+
"FIRESTORE_NATIVE",
1812
+
"DATASTORE_MODE"
1813
+
],
1814
+
"enumDescriptions": [
1815
+
"The default value. This value is used if the database type is omitted.",
0 commit comments