1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="firestore_v1.html">Cloud Firestore API</a> . <a href="firestore_v1.projects.html">projects</a> . <a href="firestore_v1.projects.databases.html">databases</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="firestore_v1.projects.databases.collectionGroups.html">collectionGroups()</a></code> 79</p> 80<p class="firstline">Returns the collectionGroups Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="firestore_v1.projects.databases.documents.html">documents()</a></code> 84</p> 85<p class="firstline">Returns the documents Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="firestore_v1.projects.databases.operations.html">operations()</a></code> 89</p> 90<p class="firstline">Returns the operations Resource.</p> 91 92<p class="toc_element"> 93 <code><a href="#close">close()</a></code></p> 94<p class="firstline">Close httplib2 connections.</p> 95<p class="toc_element"> 96 <code><a href="#exportDocuments">exportDocuments(name, body=None, x__xgafv=None)</a></code></p> 97<p class="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> 98<p class="toc_element"> 99 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 100<p class="firstline">Gets information about a database.</p> 101<p class="toc_element"> 102 <code><a href="#importDocuments">importDocuments(name, body=None, x__xgafv=None)</a></code></p> 103<p class="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> 104<p class="toc_element"> 105 <code><a href="#list">list(parent, x__xgafv=None)</a></code></p> 106<p class="firstline">List all the databases in the project.</p> 107<p class="toc_element"> 108 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Updates a database.</p> 110<h3>Method Details</h3> 111<div class="method"> 112 <code class="details" id="close">close()</code> 113 <pre>Close httplib2 connections.</pre> 114</div> 115 116<div class="method"> 117 <code class="details" id="exportDocuments">exportDocuments(name, body=None, x__xgafv=None)</code> 118 <pre>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 119 120Args: 121 name: string, Required. Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`. (required) 122 body: object, The request body. 123 The object takes the form of: 124 125{ # The request for FirestoreAdmin.ExportDocuments. 126 "collectionIds": [ # Which collection ids to export. Unspecified means all collections. 127 "A String", 128 ], 129 "outputUriPrefix": "A String", # The output URI. Currently only supports Google Cloud Storage URIs of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time. 130} 131 132 x__xgafv: string, V1 error format. 133 Allowed values 134 1 - v1 error format 135 2 - v2 error format 136 137Returns: 138 An object of the form: 139 140 { # This resource represents a long-running operation that is the result of a network API call. 141 "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. 142 "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. 143 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 144 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 145 { 146 "a_key": "", # Properties of the object. Contains field @type with type URL. 147 }, 148 ], 149 "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. 150 }, 151 "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. 152 "a_key": "", # Properties of the object. Contains field @type with type URL. 153 }, 154 "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}`. 155 "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`. 156 "a_key": "", # Properties of the object. Contains field @type with type URL. 157 }, 158}</pre> 159</div> 160 161<div class="method"> 162 <code class="details" id="get">get(name, x__xgafv=None)</code> 163 <pre>Gets information about a database. 164 165Args: 166 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 172Returns: 173 An object of the form: 174 175 { # A Cloud Firestore Database. Currently only one database is allowed per cloud project; this database must have a `database_id` of '(default)'. 176 "concurrencyMode": "A String", # The concurrency control mode to use for this database. 177 "earliestVersionTime": "A String", # Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with `now - version_retention_period`. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. Note that you should not need to query this field: if you know the `version_retention_period` then you can query within that time. 178 "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. 179 "locationId": "A String", # The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations. 180 "name": "A String", # The resource name of the Database. Format: `projects/{project}/databases/{database}` 181 "type": "A String", # The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. 182}</pre> 183</div> 184 185<div class="method"> 186 <code class="details" id="importDocuments">importDocuments(name, body=None, x__xgafv=None)</code> 187 <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. 188 189Args: 190 name: string, Required. Database to import into. Should be of the form: `projects/{project_id}/databases/{database_id}`. (required) 191 body: object, The request body. 192 The object takes the form of: 193 194{ # The request for FirestoreAdmin.ImportDocuments. 195 "collectionIds": [ # Which collection ids to import. Unspecified means all collections included in the import. 196 "A String", 197 ], 198 "inputUriPrefix": "A String", # Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix. 199} 200 201 x__xgafv: string, V1 error format. 202 Allowed values 203 1 - v1 error format 204 2 - v2 error format 205 206Returns: 207 An object of the form: 208 209 { # This resource represents a long-running operation that is the result of a network API call. 210 "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. 211 "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. 212 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 213 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 214 { 215 "a_key": "", # Properties of the object. Contains field @type with type URL. 216 }, 217 ], 218 "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. 219 }, 220 "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. 221 "a_key": "", # Properties of the object. Contains field @type with type URL. 222 }, 223 "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}`. 224 "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`. 225 "a_key": "", # Properties of the object. Contains field @type with type URL. 226 }, 227}</pre> 228</div> 229 230<div class="method"> 231 <code class="details" id="list">list(parent, x__xgafv=None)</code> 232 <pre>List all the databases in the project. 233 234Args: 235 parent: string, Required. A parent name of the form `projects/{project_id}` (required) 236 x__xgafv: string, V1 error format. 237 Allowed values 238 1 - v1 error format 239 2 - v2 error format 240 241Returns: 242 An object of the form: 243 244 { # The list of databases for a project. 245 "databases": [ # The databases in the project. 246 { # A Cloud Firestore Database. Currently only one database is allowed per cloud project; this database must have a `database_id` of '(default)'. 247 "concurrencyMode": "A String", # The concurrency control mode to use for this database. 248 "earliestVersionTime": "A String", # Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with `now - version_retention_period`. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. Note that you should not need to query this field: if you know the `version_retention_period` then you can query within that time. 249 "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. 250 "locationId": "A String", # The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations. 251 "name": "A String", # The resource name of the Database. Format: `projects/{project}/databases/{database}` 252 "type": "A String", # The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. 253 }, 254 ], 255}</pre> 256</div> 257 258<div class="method"> 259 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 260 <pre>Updates a database. 261 262Args: 263 name: string, The resource name of the Database. Format: `projects/{project}/databases/{database}` (required) 264 body: object, The request body. 265 The object takes the form of: 266 267{ # A Cloud Firestore Database. Currently only one database is allowed per cloud project; this database must have a `database_id` of '(default)'. 268 "concurrencyMode": "A String", # The concurrency control mode to use for this database. 269 "earliestVersionTime": "A String", # Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with `now - version_retention_period`. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. Note that you should not need to query this field: if you know the `version_retention_period` then you can query within that time. 270 "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. 271 "locationId": "A String", # The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations. 272 "name": "A String", # The resource name of the Database. Format: `projects/{project}/databases/{database}` 273 "type": "A String", # The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. 274} 275 276 updateMask: string, The list of fields to be updated. 277 x__xgafv: string, V1 error format. 278 Allowed values 279 1 - v1 error format 280 2 - v2 error format 281 282Returns: 283 An object of the form: 284 285 { # This resource represents a long-running operation that is the result of a network API call. 286 "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. 287 "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. 288 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 289 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 290 { 291 "a_key": "", # Properties of the object. Contains field @type with type URL. 292 }, 293 ], 294 "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. 295 }, 296 "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. 297 "a_key": "", # Properties of the object. Contains field @type with type URL. 298 }, 299 "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}`. 300 "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`. 301 "a_key": "", # Properties of the object. Contains field @type with type URL. 302 }, 303}</pre> 304</div> 305 306</body></html>