mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
586 lines
28 KiB
HTML
586 lines
28 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-channels-patch/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Sites Channels Patch - 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 Channels Patch";
|
|
var mkdocs_page_input_path = "projects_sites-channels-patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-firebasehosting1_beta1-cli/projects_sites-channels-patch/";
|
|
</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 current"><a class="reference internal current" href="./">Sites Channels Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</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"><a class="reference internal" href="../projects_sites-create/">Sites Create</a>
|
|
</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 Channels Patch</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-channels-patch.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>Updates information for the specified channel of the specified site. Implicitly creates the channel if it doesn't already exist.</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-channels-patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>The fully-qualified resource name for the channel, in the format: sites/ SITE_ID/channels/CHANNEL_ID</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>Channel:
|
|
create-time: string
|
|
expire-time: string
|
|
labels: { string: string }
|
|
name: string
|
|
release:
|
|
message: string
|
|
name: string
|
|
release-time: string
|
|
release-user:
|
|
email: string
|
|
image-url: string
|
|
type: string
|
|
version:
|
|
config:
|
|
app-association: string
|
|
clean-urls: boolean
|
|
i18n:
|
|
root: string
|
|
trailing-slash-behavior: string
|
|
create-time: string
|
|
create-user:
|
|
email: string
|
|
image-url: string
|
|
delete-time: string
|
|
delete-user:
|
|
email: string
|
|
image-url: string
|
|
file-count: int64
|
|
finalize-time: string
|
|
finalize-user:
|
|
email: string
|
|
image-url: string
|
|
labels: { string: string }
|
|
name: string
|
|
status: string
|
|
version-bytes: string
|
|
retained-release-count: integer
|
|
ttl: string
|
|
update-time: string
|
|
url: 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 . create-time=ea</code><ul>
|
|
<li>Output only. The time at which the channel was created.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>expire-time=dolor</code><ul>
|
|
<li>The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in the output whether it's set directly or via the <code>ttl</code> field.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>labels=key=lorem</code><ul>
|
|
<li>Text labels used for extra metadata and/or filtering.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=eos</code><ul>
|
|
<li>The fully-qualified resource name for the channel, in the format: sites/ SITE_ID/channels/CHANNEL_ID</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>release message=labore</code><ul>
|
|
<li>The deploy description when the release was created. The value can be up to 512 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=sed</code><ul>
|
|
<li>Output only. The unique identifier for the release, in either of the following formats: - sites/SITE_ID/releases/RELEASE_ID - sites/SITE_ID/channels/CHANNEL_ID/releases/RELEASE_ID This name is provided in the response body when you call <a href="sites.releases/create"><code>releases.create</code></a> or <a href="sites.channels.releases/create"><code>channels.releases.create</code></a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>release-time=duo</code><ul>
|
|
<li>Output only. The time at which the version is set to be public.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>release-user email=sed</code><ul>
|
|
<li>The email address of the user when the user performed the action.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>image-url=no</code></p>
|
|
<ul>
|
|
<li>A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. type=stet</code></p>
|
|
<ul>
|
|
<li>Explains the reason for the release. Specify a value for this field only when creating a <code>SITE_DISABLE</code> type release.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>version.config app-association=kasd</code><ul>
|
|
<li>How to handle well known App Association files.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>clean-urls=true</code><ul>
|
|
<li>Defines whether to drop the file extension from uploaded files.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>i18n root=et</code></p>
|
|
<ul>
|
|
<li>Required. The user-supplied path where country and language specific content will be looked for within the public directory.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. trailing-slash-behavior=et</code></p>
|
|
<ul>
|
|
<li>Defines how to handle a trailing slash in the URL path.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. create-time=vero</code></p>
|
|
<ul>
|
|
<li>Output only. The time at which the version was created.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>create-user email=erat</code><ul>
|
|
<li>The email address of the user when the user performed the action.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>image-url=sed</code></p>
|
|
<ul>
|
|
<li>A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. delete-time=duo</code></p>
|
|
<ul>
|
|
<li>Output only. The time at which the version was <code>DELETED</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>delete-user email=dolore</code><ul>
|
|
<li>The email address of the user when the user performed the action.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>image-url=et</code></p>
|
|
<ul>
|
|
<li>A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. file-count=-28</code></p>
|
|
<ul>
|
|
<li>Output only. The total number of files associated with the version. This value is calculated after a version is <code>FINALIZED</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>finalize-time=amet.</code><ul>
|
|
<li>Output only. The time at which the version was <code>FINALIZED</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>finalize-user email=consetetur</code><ul>
|
|
<li>The email address of the user when the user performed the action.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>image-url=diam</code></p>
|
|
<ul>
|
|
<li>A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. labels=key=dolor</code></p>
|
|
<ul>
|
|
<li>The labels used for extra metadata and/or filtering.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=et</code><ul>
|
|
<li>The fully-qualified resource name for the version, in the format: sites/ SITE_ID/versions/VERSION_ID This name is provided in the response body when you call <a href="sites.versions/create"><code>CreateVersion</code></a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>status=et</code><ul>
|
|
<li>The deploy status of the version. For a successful deploy, call <a href="sites.versions/create"><code>CreateVersion</code></a> to make a new version (<code>CREATED</code> status), <a href="sites.versions/populateFiles">upload all desired files</a> to the version, then <a href="sites.versions/patch">update</a> the version to the <code>FINALIZED</code> status. Note that if you leave the version in the <code>CREATED</code> state for more than 12 hours, the system will automatically mark the version as <code>ABANDONED</code>. You can also change the status of a version to <code>DELETED</code> by calling <a href="sites.versions/delete"><code>DeleteVersion</code></a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>version-bytes=sadipscing</code></p>
|
|
<ul>
|
|
<li>Output only. The total stored bytesize of the version. This value is calculated after a version is <code>FINALIZED</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... retained-release-count=86</code></p>
|
|
<ul>
|
|
<li>The number of previous releases to retain on the channel for rollback or other purposes. Must be a number between 1-100. Defaults to 10 for new channels.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>ttl=dolor</code><ul>
|
|
<li>Input only. A time-to-live for this channel. Sets <code>expire_time</code> to the provided duration past the time of the request.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>update-time=duo</code><ul>
|
|
<li>Output only. The time at which the channel was last updated.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>url=vero</code><ul>
|
|
<li>Output only. The URL at which the content of this channel's current release can be viewed. This URL is a Firebase-provided subdomain of <code>web.app</code>. The content of this channel's current release can also be viewed at the Firebase-provided subdomain of <code>firebaseapp.com</code>. If this channel is the <code>live</code> channel for the Hosting site, then the content of this channel's current release can also be viewed at any connected custom domains.</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><strong>-p update-mask=string</strong><ul>
|
|
<li>A comma-separated list of fields to be updated in this request.</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-list/" class="btn btn-neutral float-left" title="Sites Channels List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_sites-channels-releases-create/" class="btn btn-neutral float-right" title="Sites Channels Releases 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-list/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_sites-channels-releases-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>
|