Files
google-apis-rs/google_firebase1_beta1_cli/projects_available-locations-list/index.html
2024-03-05 21:06:01 +01:00

327 lines
17 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-firebase1_beta1-cli/projects_available-locations-list/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Available Locations List - Firebase Management v5.0.4+20240304</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Available Locations List";
var mkdocs_page_input_path = "projects_available-locations-list.md";
var mkdocs_page_url = "/google-apis-rs/google-firebase1_beta1-cli/projects_available-locations-list/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> Firebase Management v5.0.4+20240304
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Available Projects</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../available-projects_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Operations</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../operations_get/">Get</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Projects</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../projects_add-firebase/">Add Firebase</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_add-google-analytics/">Add Google Analytics</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-create/">Android Apps Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-get/">Android Apps Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-get-config/">Android Apps Get Config</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-list/">Android Apps List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-patch/">Android Apps Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-remove/">Android Apps Remove</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-sha-create/">Android Apps Sha Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-sha-delete/">Android Apps Sha Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-sha-list/">Android Apps Sha List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_android-apps-undelete/">Android Apps Undelete</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Available Locations List</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_default-location-finalize/">Default Location Finalize</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_get-admin-sdk-config/">Get Admin Sdk Config</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_get-analytics-details/">Get Analytics Details</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_ios-apps-create/">Ios Apps Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_ios-apps-get/">Ios Apps Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_ios-apps-get-config/">Ios Apps Get Config</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_ios-apps-list/">Ios Apps List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_ios-apps-patch/">Ios Apps Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_ios-apps-remove/">Ios Apps Remove</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_ios-apps-undelete/">Ios Apps Undelete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_patch/">Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_remove-analytics/">Remove Analytics</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_search-apps/">Search Apps</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_web-apps-create/">Web Apps Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_web-apps-get/">Web Apps Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_web-apps-get-config/">Web Apps Get Config</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_web-apps-list/">Web Apps List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_web-apps-patch/">Web Apps Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_web-apps-remove/">Web Apps Remove</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_web-apps-undelete/">Web Apps Undelete</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">Firebase Management v5.0.4+20240304</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Projects &raquo;</li>
<li>Available Locations List</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/firebase1_beta1-cli/edit/master/docs/projects_available-locations-list.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<p><strong>DEPRECATED.</strong> <em>Instead, use the applicable resource-specific REST API (or associated documentation, as needed) to determine valid locations for each resource used in your Project.</em> Lists the valid Google Cloud Platform (GCP) resource locations for the specified Project (including a FirebaseProject). One of these locations can be selected as the Project&#39;s <a href="https://firebase.google.com/docs/projects/locations"><em>default</em> GCP resource location</a>, which is the geographical location where the Project&#39;s resources, such as Cloud Firestore, will be provisioned by default. However, if the default GCP resource location has already been set for the Project, then this setting cannot be changed. This call checks for any possible <a href="https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations">location restrictions</a> for the specified Project and, thus, might return a subset of all possible GCP resource locations. To list all GCP resource locations (regardless of any restrictions), call the endpoint without specifying a unique project identifier (that is, <code>/v1beta1/{parent=projects/-}/listAvailableLocations</code>). To call <code>ListAvailableLocations</code> with a specified project, a member must be at minimum a Viewer of the Project. Calls without a specified project do not require any specific project permissions.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
<ul>
<li><em>https://www.googleapis.com/auth/cloud-platform</em></li>
<li><em>https://www.googleapis.com/auth/cloud-platform.read-only</em></li>
<li><em>https://www.googleapis.com/auth/firebase</em></li>
<li><em>https://www.googleapis.com/auth/firebase.readonly</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/firebase.readonly</em>.
You can set the scope for this method like this: <code>firebase1-beta1 --scope &lt;scope&gt; projects available-locations-list ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;parent&gt;</strong> <em>(string)</em><ul>
<li>The FirebaseProject for which to list GCP resource locations, in the format: projects/PROJECT_IDENTIFIER Refer to the <code>FirebaseProject</code> <a href="../projects#FirebaseProject.FIELDS.name"><code>name</code></a> field for details about PROJECT_IDENTIFIER values. If no unique project identifier is specified (that is, <code>projects/-</code>), the returned list does not take into account org-specific or project-specific location restrictions.</li>
</ul>
</li>
</ul>
<h1 id="optional-output-flags">Optional Output Flags</h1>
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
<ul>
<li><strong>-o out</strong><ul>
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
It will be a JSON-encoded structure.
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
If unset, it defaults to standard output.</li>
</ul>
</li>
</ul>
<h1 id="optional-method-properties">Optional Method Properties</h1>
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
<code>-p</code> for completeness.</p>
<ul>
<li>
<p><strong>-p page-size=integer</strong></p>
<ul>
<li>The maximum number of locations to return in the response. The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit. This value cannot be negative.</li>
</ul>
</li>
<li>
<p><strong>-p page-token=string</strong></p>
<ul>
<li>Token returned from a previous call to <code>ListAvailableLocations</code> indicating where in the list of locations to resume listing.</li>
</ul>
</li>
</ul>
<h1 id="optional-general-properties">Optional General Properties</h1>
<p>The following properties can configure any call, and are not specific to this method.</p>
<ul>
<li>
<p><strong>-p $-xgafv=string</strong></p>
<ul>
<li>V1 error format.</li>
</ul>
</li>
<li>
<p><strong>-p access-token=string</strong></p>
<ul>
<li>OAuth access token.</li>
</ul>
</li>
<li>
<p><strong>-p alt=string</strong></p>
<ul>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</li>
</ul>
</li>
<li>
<p><strong>-p fields=string</strong></p>
<ul>
<li>Selector specifying which fields to include in a partial response.</li>
</ul>
</li>
<li>
<p><strong>-p key=string</strong></p>
<ul>
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
</ul>
</li>
<li>
<p><strong>-p oauth-token=string</strong></p>
<ul>
<li>OAuth 2.0 token for the current user.</li>
</ul>
</li>
<li>
<p><strong>-p pretty-print=boolean</strong></p>
<ul>
<li>Returns response with indentations and line breaks.</li>
</ul>
</li>
<li>
<p><strong>-p quota-user=string</strong></p>
<ul>
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
</ul>
</li>
<li>
<p><strong>-p upload-type=string</strong></p>
<ul>
<li>Legacy upload protocol for media (e.g. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../projects_android-apps-undelete/" class="btn btn-neutral float-left" title="Android Apps Undelete"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_default-location-finalize/" class="btn btn-neutral float-right" title="Default Location Finalize">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 2015-2020, `Sebastian Thiel`</p>
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/firebase1_beta1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../projects_android-apps-undelete/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_default-location-finalize/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>