Files
google-apis-rs/google_firebasedatabase1_beta/api/index.html
2021-04-02 00:20:57 +08:00

23 lines
9.1 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `api` mod in crate `google_firebasedatabase1_beta`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_firebasedatabase1_beta::api - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../google_firebasedatabase1_beta/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module api</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class="location"><a href="../index.html">google_firebasedatabase1_beta</a></p><div id="sidebar-vars" data-name="api" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">google_firebasedatabase1_beta</a>::<wbr><a class="mod" href="">api</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../../src/google_firebasedatabase1_beta/api.rs.html#1-2165" title="goto source code">[src]</a></span></h1><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<table><tr class="module-item"><td><a class="struct" href="struct.DatabaseInstance.html" title="google_firebasedatabase1_beta::api::DatabaseInstance struct">DatabaseInstance</a></td><td class="docblock-short"><p>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.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DisableDatabaseInstanceRequest.html" title="google_firebasedatabase1_beta::api::DisableDatabaseInstanceRequest struct">DisableDatabaseInstanceRequest</a></td><td class="docblock-short"><p>The request sent to the DisableDatabaseInstance method.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FirebaseRealtimeDatabase.html" title="google_firebasedatabase1_beta::api::FirebaseRealtimeDatabase struct">FirebaseRealtimeDatabase</a></td><td class="docblock-short"><p>Central instance to access all FirebaseRealtimeDatabase related resource activities</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListDatabaseInstancesResponse.html" title="google_firebasedatabase1_beta::api::ListDatabaseInstancesResponse struct">ListDatabaseInstancesResponse</a></td><td class="docblock-short"><p>The response from the ListDatabaseInstances method.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceCreateCall.html" title="google_firebasedatabase1_beta::api::ProjectLocationInstanceCreateCall struct">ProjectLocationInstanceCreateCall</a></td><td class="docblock-short"><p>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>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceDeleteCall.html" title="google_firebasedatabase1_beta::api::ProjectLocationInstanceDeleteCall struct">ProjectLocationInstanceDeleteCall</a></td><td class="docblock-short"><p>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>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceDisableCall.html" title="google_firebasedatabase1_beta::api::ProjectLocationInstanceDisableCall struct">ProjectLocationInstanceDisableCall</a></td><td class="docblock-short"><p>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>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceGetCall.html" title="google_firebasedatabase1_beta::api::ProjectLocationInstanceGetCall struct">ProjectLocationInstanceGetCall</a></td><td class="docblock-short"><p>Gets the DatabaseInstance identified by the specified resource name.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceListCall.html" title="google_firebasedatabase1_beta::api::ProjectLocationInstanceListCall struct">ProjectLocationInstanceListCall</a></td><td class="docblock-short"><p>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 <code>pageToken</code>. The resulting list contains instances in any STATE. The list results may be stale by a few seconds. Use GetDatabaseInstance for consistent reads.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationInstanceReenableCall.html" title="google_firebasedatabase1_beta::api::ProjectLocationInstanceReenableCall struct">ProjectLocationInstanceReenableCall</a></td><td class="docblock-short"><p>Enables a DatabaseInstance. The database must have been disabled previously using DisableDatabaseInstance. The state of a successfully reenabled DatabaseInstance is ACTIVE.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMethods.html" title="google_firebasedatabase1_beta::api::ProjectMethods struct">ProjectMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>project</em> resources.
It is not used directly, but through the <code>FirebaseRealtimeDatabase</code> hub.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ReenableDatabaseInstanceRequest.html" title="google_firebasedatabase1_beta::api::ReenableDatabaseInstanceRequest struct">ReenableDatabaseInstanceRequest</a></td><td class="docblock-short"><p>The request sent to the ReenableDatabaseInstance method.</p>
</td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
<table><tr class="module-item"><td><a class="enum" href="enum.Scope.html" title="google_firebasedatabase1_beta::api::Scope enum">Scope</a></td><td class="docblock-short"><p>Identifies the an OAuth2 authorization scope.
A scope is needed when requesting an
<a href="https://developers.google.com/youtube/v3/guides/authentication">authorization token</a>.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="google_firebasedatabase1_beta"></div>
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>