Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4d1153db18a3edf86c5bb83149b4f1c0ba95f810 / . / docs / dyn / firestore_v1beta1.projects.databases.html
blob: 8ef7b517e453b8f9956598de5e3ab602e4cbf203 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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_v1beta1.html">Cloud Firestore API</a> . <a href="firestore_v1beta1.projects.html">projects</a> . <a href="firestore_v1beta1.projects.databases.html">databases</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="firestore_v1beta1.projects.databases.documents.html">documents()</a></code>
79</p>
80<p class="firstline">Returns the documents Resource.</p>
81
82<p class="toc_element">
83 <code><a href="firestore_v1beta1.projects.databases.indexes.html">indexes()</a></code>
84</p>
85<p class="firstline">Returns the indexes Resource.</p>
86
87<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <code><a href="#close">close()</a></code></p>
89<p class="firstline">Close httplib2 connections.</p>
90<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]91 <code><a href="#exportDocuments">exportDocuments(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]92<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.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]93<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]94 <code><a href="#importDocuments">importDocuments(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]95<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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]96<h3>Method Details</h3>
97<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]98 <code class="details" id="close">close()</code>
99 <pre>Close httplib2 connections.</pre>
100</div>
101
102<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]103 <code class="details" id="exportDocuments">exportDocuments(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]104 <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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105
106Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]107 name: string, Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]108 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109 The object takes the form of:
110
111{ # The request for FirestoreAdmin.ExportDocuments.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]112 &quot;collectionIds&quot;: [ # Which collection ids to export. Unspecified means all collections.
113 &quot;A String&quot;,
114 ],
115 &quot;outputUriPrefix&quot;: &quot;A String&quot;, # 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.
116}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]117
118 x__xgafv: string, V1 error format.
119 Allowed values
120 1 - v1 error format
121 2 - v2 error format
122
123Returns:
124 An object of the form:
125
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]126 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]127 &quot;done&quot;: 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.
128 &quot;error&quot;: { # 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.
129 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
130 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
131 {
132 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
133 },
134 ],
135 &quot;message&quot;: &quot;A String&quot;, # 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.
136 },
137 &quot;metadata&quot;: { # 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.
138 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
139 },
140 &quot;name&quot;: &quot;A String&quot;, # 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}`.
141 &quot;response&quot;: { # 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`.
142 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
143 },
144}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]145</div>
146
147<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]148 <code class="details" id="importDocuments">importDocuments(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]149 <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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150
151Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]152 name: string, Database to import into. Should be of the form: `projects/{project_id}/databases/{database_id}`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]153 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]154 The object takes the form of:
155
156{ # The request for FirestoreAdmin.ImportDocuments.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]157 &quot;collectionIds&quot;: [ # Which collection ids to import. Unspecified means all collections included in the import.
158 &quot;A String&quot;,
159 ],
160 &quot;inputUriPrefix&quot;: &quot;A String&quot;, # 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.v1beta1.ExportDocumentsResponse.output_uri_prefix.
161}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162
163 x__xgafv: string, V1 error format.
164 Allowed values
165 1 - v1 error format
166 2 - v2 error format
167
168Returns:
169 An object of the form:
170
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]171 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]172 &quot;done&quot;: 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.
173 &quot;error&quot;: { # 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.
174 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
175 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
176 {
177 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
178 },
179 ],
180 &quot;message&quot;: &quot;A String&quot;, # 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.
181 },
182 &quot;metadata&quot;: { # 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.
183 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
184 },
185 &quot;name&quot;: &quot;A String&quot;, # 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}`.
186 &quot;response&quot;: { # 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`.
187 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
188 },
189}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]190</div>
191
192</body></html>