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="firebasedatabase_v1beta.html">Firebase Realtime Database Management API</a> . <a href="firebasedatabase_v1beta.projects.html">projects</a> . <a href="firebasedatabase_v1beta.projects.locations.html">locations</a> . <a href="firebasedatabase_v1beta.projects.locations.instances.html">instances</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81  <code><a href="#create">create(parent, body=None, databaseId=None, validateOnly=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Requests that a new DatabaseInstance be created. The state of a successfully created DatabaseInstance is ACTIVE. Only available for projects on the Blaze plan. Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Note that it might take a few minutes for billing enablement state to propagate to Firebase systems.</p>
83<p class="toc_element">
84  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Marks a DatabaseInstance to be deleted. The DatabaseInstance will be purged within 30 days. The default database cannot be deleted. IDs for deleted database instances may never be recovered or re-used. The Database may only be deleted if it is already in a DISABLED state.</p>
86<p class="toc_element">
87  <code><a href="#disable">disable(name, body=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Disables a DatabaseInstance. The database can be re-enabled later using ReenableDatabaseInstance. When a database is disabled, all reads and writes are denied, including view access in the Firebase console.</p>
89<p class="toc_element">
90  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
91<p class="firstline">Gets the DatabaseInstance identified by the specified resource name.</p>
92<p class="toc_element">
93  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Lists each DatabaseInstance associated with the specified parent project. The list items are returned in no particular order, but will be a consistent view of the database instances when additional requests are made with a `pageToken`. The resulting list contains instances in any STATE. The list results may be stale by a few seconds. Use GetDatabaseInstance for consistent reads.</p>
95<p class="toc_element">
96  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
99  <code><a href="#reenable">reenable(name, body=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Enables a DatabaseInstance. The database must have been disabled previously using DisableDatabaseInstance. The state of a successfully reenabled DatabaseInstance is ACTIVE.</p>
101<h3>Method Details</h3>
102<div class="method">
103    <code class="details" id="close">close()</code>
104  <pre>Close httplib2 connections.</pre>
105</div>
106
107<div class="method">
108    <code class="details" id="create">create(parent, body=None, databaseId=None, validateOnly=None, x__xgafv=None)</code>
109  <pre>Requests that a new DatabaseInstance be created. The state of a successfully created DatabaseInstance is ACTIVE. Only available for projects on the Blaze plan. Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Note that it might take a few minutes for billing enablement state to propagate to Firebase systems.
110
111Args:
112  parent: string, The parent project for which to create a database instance, in the form: `projects/{project-number}/locations/{location-id}`. (required)
113  body: object, The request body.
114    The object takes the form of:
115
116{ # Representation of a Realtime Database instance. Details on interacting with contents of a DatabaseInstance can be found at: https://firebase.google.com/docs/database/rest/start.
117  &quot;databaseUrl&quot;: &quot;A String&quot;, # Immutable. The globally unique hostname of the database.
118  &quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}`.
119  &quot;project&quot;: &quot;A String&quot;, # The resource name of the project this instance belongs to. For example: `projects/{project-number}`.
120  &quot;state&quot;: &quot;A String&quot;, # The database&#x27;s lifecycle state. Read-only.
121  &quot;type&quot;: &quot;A String&quot;, # The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.
122}
123
124  databaseId: string, The globally unique identifier of the database instance.
125  validateOnly: boolean, When set to true, the request will be validated but not submitted.
126  x__xgafv: string, V1 error format.
127    Allowed values
128      1 - v1 error format
129      2 - v2 error format
130
131Returns:
132  An object of the form:
133
134    { # Representation of a Realtime Database instance. Details on interacting with contents of a DatabaseInstance can be found at: https://firebase.google.com/docs/database/rest/start.
135  &quot;databaseUrl&quot;: &quot;A String&quot;, # Immutable. The globally unique hostname of the database.
136  &quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}`.
137  &quot;project&quot;: &quot;A String&quot;, # The resource name of the project this instance belongs to. For example: `projects/{project-number}`.
138  &quot;state&quot;: &quot;A String&quot;, # The database&#x27;s lifecycle state. Read-only.
139  &quot;type&quot;: &quot;A String&quot;, # The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.
140}</pre>
141</div>
142
143<div class="method">
144    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
145  <pre>Marks a DatabaseInstance to be deleted. The DatabaseInstance will be purged within 30 days. The default database cannot be deleted. IDs for deleted database instances may never be recovered or re-used. The Database may only be deleted if it is already in a DISABLED state.
146
147Args:
148  name: string, The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}` (required)
149  x__xgafv: string, V1 error format.
150    Allowed values
151      1 - v1 error format
152      2 - v2 error format
153
154Returns:
155  An object of the form:
156
157    { # Representation of a Realtime Database instance. Details on interacting with contents of a DatabaseInstance can be found at: https://firebase.google.com/docs/database/rest/start.
158  &quot;databaseUrl&quot;: &quot;A String&quot;, # Immutable. The globally unique hostname of the database.
159  &quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}`.
160  &quot;project&quot;: &quot;A String&quot;, # The resource name of the project this instance belongs to. For example: `projects/{project-number}`.
161  &quot;state&quot;: &quot;A String&quot;, # The database&#x27;s lifecycle state. Read-only.
162  &quot;type&quot;: &quot;A String&quot;, # The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.
163}</pre>
164</div>
165
166<div class="method">
167    <code class="details" id="disable">disable(name, body=None, x__xgafv=None)</code>
168  <pre>Disables a DatabaseInstance. The database can be re-enabled later using ReenableDatabaseInstance. When a database is disabled, all reads and writes are denied, including view access in the Firebase console.
169
170Args:
171  name: string, The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}` (required)
172  body: object, The request body.
173    The object takes the form of:
174
175{ # The request sent to the DisableDatabaseInstance method.
176}
177
178  x__xgafv: string, V1 error format.
179    Allowed values
180      1 - v1 error format
181      2 - v2 error format
182
183Returns:
184  An object of the form:
185
186    { # Representation of a Realtime Database instance. Details on interacting with contents of a DatabaseInstance can be found at: https://firebase.google.com/docs/database/rest/start.
187  &quot;databaseUrl&quot;: &quot;A String&quot;, # Immutable. The globally unique hostname of the database.
188  &quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}`.
189  &quot;project&quot;: &quot;A String&quot;, # The resource name of the project this instance belongs to. For example: `projects/{project-number}`.
190  &quot;state&quot;: &quot;A String&quot;, # The database&#x27;s lifecycle state. Read-only.
191  &quot;type&quot;: &quot;A String&quot;, # The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.
192}</pre>
193</div>
194
195<div class="method">
196    <code class="details" id="get">get(name, x__xgafv=None)</code>
197  <pre>Gets the DatabaseInstance identified by the specified resource name.
198
199Args:
200  name: string, The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}`. `database-id` is a globally unique identifier across all parent collections. For convenience, this method allows you to supply `-` as a wildcard character in place of specific collections under `projects` and `locations`. The resulting wildcarding form of the method is: `projects/-/locations/-/instances/{database-id}`. (required)
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    { # Representation of a Realtime Database instance. Details on interacting with contents of a DatabaseInstance can be found at: https://firebase.google.com/docs/database/rest/start.
210  &quot;databaseUrl&quot;: &quot;A String&quot;, # Immutable. The globally unique hostname of the database.
211  &quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}`.
212  &quot;project&quot;: &quot;A String&quot;, # The resource name of the project this instance belongs to. For example: `projects/{project-number}`.
213  &quot;state&quot;: &quot;A String&quot;, # The database&#x27;s lifecycle state. Read-only.
214  &quot;type&quot;: &quot;A String&quot;, # The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.
215}</pre>
216</div>
217
218<div class="method">
219    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
220  <pre>Lists each DatabaseInstance associated with the specified parent project. The list items are returned in no particular order, but will be a consistent view of the database instances when additional requests are made with a `pageToken`. The resulting list contains instances in any STATE. The list results may be stale by a few seconds. Use GetDatabaseInstance for consistent reads.
221
222Args:
223  parent: string, The parent project for which to list database instances, in the form: `projects/{project-number}/locations/{location-id}` To list across all locations, use a parent in the form: `projects/{project-number}/locations/-` (required)
224  pageSize: integer, The maximum number of database instances to return in the response. The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit.
225  pageToken: string, Token returned from a previous call to `ListDatabaseInstances` indicating where in the set of database instances to resume listing.
226  x__xgafv: string, V1 error format.
227    Allowed values
228      1 - v1 error format
229      2 - v2 error format
230
231Returns:
232  An object of the form:
233
234    { # The response from the ListDatabaseInstances method.
235  &quot;instances&quot;: [ # List of each DatabaseInstance that is in the parent Firebase project.
236    { # Representation of a Realtime Database instance. Details on interacting with contents of a DatabaseInstance can be found at: https://firebase.google.com/docs/database/rest/start.
237      &quot;databaseUrl&quot;: &quot;A String&quot;, # Immutable. The globally unique hostname of the database.
238      &quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}`.
239      &quot;project&quot;: &quot;A String&quot;, # The resource name of the project this instance belongs to. For example: `projects/{project-number}`.
240      &quot;state&quot;: &quot;A String&quot;, # The database&#x27;s lifecycle state. Read-only.
241      &quot;type&quot;: &quot;A String&quot;, # The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.
242    },
243  ],
244  &quot;nextPageToken&quot;: &quot;A String&quot;, # If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used in a subsequent call to `ListDatabaseInstances` to find the next group of database instances. Page tokens are short-lived and should not be persisted.
245}</pre>
246</div>
247
248<div class="method">
249    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
250  <pre>Retrieves the next page of results.
251
252Args:
253  previous_request: The request for the previous page. (required)
254  previous_response: The response from the request for the previous page. (required)
255
256Returns:
257  A request object that you can call &#x27;execute()&#x27; on to request the next
258  page. Returns None if there are no more items in the collection.
259    </pre>
260</div>
261
262<div class="method">
263    <code class="details" id="reenable">reenable(name, body=None, x__xgafv=None)</code>
264  <pre>Enables a DatabaseInstance. The database must have been disabled previously using DisableDatabaseInstance. The state of a successfully reenabled DatabaseInstance is ACTIVE.
265
266Args:
267  name: string, The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}` (required)
268  body: object, The request body.
269    The object takes the form of:
270
271{ # The request sent to the ReenableDatabaseInstance method.
272}
273
274  x__xgafv: string, V1 error format.
275    Allowed values
276      1 - v1 error format
277      2 - v2 error format
278
279Returns:
280  An object of the form:
281
282    { # Representation of a Realtime Database instance. Details on interacting with contents of a DatabaseInstance can be found at: https://firebase.google.com/docs/database/rest/start.
283  &quot;databaseUrl&quot;: &quot;A String&quot;, # Immutable. The globally unique hostname of the database.
284  &quot;name&quot;: &quot;A String&quot;, # The fully qualified resource name of the database instance, in the form: `projects/{project-number}/locations/{location-id}/instances/{database-id}`.
285  &quot;project&quot;: &quot;A String&quot;, # The resource name of the project this instance belongs to. For example: `projects/{project-number}`.
286  &quot;state&quot;: &quot;A String&quot;, # The database&#x27;s lifecycle state. Read-only.
287  &quot;type&quot;: &quot;A String&quot;, # The database instance type. On creation only USER_DATABASE is allowed, which is also the default when omitted.
288}</pre>
289</div>
290
291</body></html>