mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
424 lines
22 KiB
HTML
424 lines
22 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-firebasehosting1_beta1-cli/projects_sites-create/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Sites Create - Firebase Hosting v5.0.4+20240303</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 = "Sites Create";
|
|
var mkdocs_page_input_path = "projects_sites-create.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-firebasehosting1_beta1-cli/projects_sites-create/";
|
|
</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 Hosting v5.0.4+20240303
|
|
</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">Projects</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_operations-get/">Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-channels-create/">Sites Channels Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-channels-delete/">Sites Channels Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-channels-get/">Sites Channels Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-channels-list/">Sites Channels List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-channels-patch/">Sites Channels Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-channels-releases-create/">Sites Channels Releases Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-channels-releases-get/">Sites Channels Releases Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-channels-releases-list/">Sites Channels Releases List</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Sites Create</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-custom-domains-create/">Sites Custom Domains Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-custom-domains-delete/">Sites Custom Domains Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-custom-domains-get/">Sites Custom Domains Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-custom-domains-list/">Sites Custom Domains List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-custom-domains-operations-get/">Sites Custom Domains Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-custom-domains-operations-list/">Sites Custom Domains Operations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-custom-domains-patch/">Sites Custom Domains Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-custom-domains-undelete/">Sites Custom Domains Undelete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-delete/">Sites Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-domains-create/">Sites Domains Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-domains-delete/">Sites Domains Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-domains-get/">Sites Domains Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-domains-list/">Sites Domains List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-domains-update/">Sites Domains Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-get/">Sites Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-get-config/">Sites Get Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-list/">Sites List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-patch/">Sites Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-releases-create/">Sites Releases Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-releases-get/">Sites Releases Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-releases-list/">Sites Releases List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-update-config/">Sites Update Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-versions-clone/">Sites Versions Clone</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-versions-create/">Sites Versions Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-versions-delete/">Sites Versions Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-versions-files-list/">Sites Versions Files List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-versions-get/">Sites Versions Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-versions-list/">Sites Versions List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-versions-patch/">Sites Versions Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_sites-versions-populate-files/">Sites Versions Populate Files</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Sites</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_channels-create/">Channels Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_channels-delete/">Channels Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_channels-get/">Channels Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_channels-list/">Channels List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_channels-patch/">Channels Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_channels-releases-create/">Channels Releases Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_channels-releases-get/">Channels Releases Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_channels-releases-list/">Channels Releases List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_domains-create/">Domains Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_domains-delete/">Domains Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_domains-get/">Domains Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_domains-list/">Domains List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_domains-update/">Domains Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_get-config/">Get Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_releases-create/">Releases Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_releases-get/">Releases Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_releases-list/">Releases List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_update-config/">Update Config</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_versions-clone/">Versions Clone</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_versions-create/">Versions Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_versions-delete/">Versions Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_versions-files-list/">Versions Files List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_versions-get/">Versions Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_versions-list/">Versions List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_versions-patch/">Versions Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../sites_versions-populate-files/">Versions Populate Files</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 Hosting v5.0.4+20240303</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> »</li>
|
|
<li>Projects »</li>
|
|
<li>Sites Create</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/firebasehosting1_beta1-cli/edit/master/docs/projects_sites-create.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>Creates a new Hosting Site in the specified parent Firebase project. Note that Hosting sites can take several minutes to propagate through Firebase systems.</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/firebase</em></li>
|
|
</ul>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-platform</em>.
|
|
You can set the scope for this method like this: <code>firebasehosting1-beta1 --scope <scope> projects sites-create ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><parent></strong> <em>(string)</em><ul>
|
|
<li>Required. The Firebase project in which to create a Hosting site, in the format: projects/PROJECT_IDENTIFIER Refer to the <code>Site</code> <a href="../projects#Site.FIELDS.name"><code>name</code></a> field for details about PROJECT_IDENTIFIER values.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
|
|
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>Site:
|
|
app-id: string
|
|
default-url: string
|
|
labels: { string: string }
|
|
name: string
|
|
type: string
|
|
|
|
</code></pre>
|
|
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
|
<ul>
|
|
<li><code>-r . app-id=dolore</code><ul>
|
|
<li>Optional. The <a href="https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id">ID of a Web App</a> associated with the Hosting site.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>default-url=dolore</code><ul>
|
|
<li>Output only. The default URL for the Hosting site.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>labels=key=dolore</code><ul>
|
|
<li>Optional. User-specified labels for the Hosting site.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=voluptua.</code><ul>
|
|
<li>Output only. The fully-qualified resource name of the Hosting site, in the format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the Firebase project's <a href="https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number"><code>ProjectNumber</code></a> <strong><em>(recommended)</em></strong> or its <a href="https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id"><code>ProjectId</code></a>. Learn more about using project identifiers in Google's <a href="https://google.aip.dev/cloud/2510">AIP 2510 standard</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>type=amet.</code><ul>
|
|
<li>Output only. The type of Hosting site. Every Firebase project has a <code>DEFAULT_SITE</code>, which is created when Hosting is provisioned for the project. All additional sites are <code>USER_SITE</code>.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</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 site-id=string</strong></p>
|
|
<ul>
|
|
<li>Required. Immutable. A globally unique identifier for the Hosting site. This identifier is used to construct the Firebase-provisioned subdomains for the site, so it must also be a valid domain name label.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p validate-only=boolean</strong></p>
|
|
<ul>
|
|
<li>Optional. If set, validates that the site_id is available and that the request would succeed, returning the expected resulting site or error.</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. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../projects_sites-channels-releases-list/" class="btn btn-neutral float-left" title="Sites Channels Releases List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_sites-custom-domains-create/" class="btn btn-neutral float-right" title="Sites Custom Domains Create">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 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/firebasehosting1_beta1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_sites-channels-releases-list/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_sites-custom-domains-create/" style="color: #fcfcfc">Next »</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>
|