OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-25 12:44:07 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a20241b2412723b0062d1c19a8ec792837b145a4
google-apis-rs/google_baremetalsolution2_cli/projects_locations-networks-patch/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

500 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Locations Networks Patch - baremetalsolution v3.0.0+20220209</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
<style>
body {font-size: 90%;}
pre, code {font-size: 100%;}
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
</style>
</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-nav-search">
<a href=".." class="icon icon-home"> baremetalsolution v3.0.0+20220209</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-get">Locations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-instances-get">Locations Instances Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-instances-list">Locations Instances List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-instances-patch">Locations Instances Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-instances-reset">Locations Instances Reset</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-instances-start">Locations Instances Start</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-list">Locations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-networks-get">Locations Networks Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-networks-list">Locations Networks List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-networks-list-network-usage">Locations Networks List Network Usage</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Locations Networks Patch</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
<li class="toctree-l2"><a href="#optional-method-properties">Optional Method Properties</a></li>
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
</ul>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-nfs-shares-get">Locations Nfs Shares Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-nfs-shares-list">Locations Nfs Shares List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-nfs-shares-patch">Locations Nfs Shares Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-provisioning-configs-submit">Locations Provisioning Configs Submit</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-provisioning-quotas-list">Locations Provisioning Quotas List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-snapshot-schedule-policies-create">Locations Snapshot Schedule Policies Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-snapshot-schedule-policies-delete">Locations Snapshot Schedule Policies Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-snapshot-schedule-policies-get">Locations Snapshot Schedule Policies Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-snapshot-schedule-policies-list">Locations Snapshot Schedule Policies List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-snapshot-schedule-policies-patch">Locations Snapshot Schedule Policies Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-volumes-get">Locations Volumes Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-volumes-list">Locations Volumes List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-volumes-luns-get">Locations Volumes Luns Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-volumes-luns-list">Locations Volumes Luns List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-volumes-patch">Locations Volumes Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-volumes-snapshots-create">Locations Volumes Snapshots Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-volumes-snapshots-delete">Locations Volumes Snapshots Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-volumes-snapshots-get">Locations Volumes Snapshots Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-volumes-snapshots-list">Locations Volumes Snapshots List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-volumes-snapshots-restore-volume-snapshot">Locations Volumes Snapshots Restore Volume Snapshot</a>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
<a href=".."></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="..">Docs</a> &raquo;</li>
<li>Locations Networks Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/baremetalsolution2-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Update details of a single network.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-platform</em> scope to make a valid call.</p>
<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>baremetalsolution2 --scope &lt;scope&gt; projects locations-networks-patch ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>Output only. The resource name of this <code>Network</code>. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: <code>projects/{project}/locations/{location}/networks/{network}</code></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>Network:
cidr: string
id: string
ip-address: string
labels: { string: string }
mac-address: [string]
name: string
services-cidr: string
state: string
type: string
vlan-id: string
vrf:
name: string
qos-policy:
bandwidth-gbps: number
state: 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 . cidr=gubergren</code><ul>
<li>The cidr of the Network.</li>
</ul>
</li>
<li><code>id=lorem</code><ul>
<li>An identifier for the <code>Network</code>, generated by the backend.</li>
</ul>
</li>
<li><code>ip-address=gubergren</code><ul>
<li>IP address configured.</li>
</ul>
</li>
<li><code>labels=key=eos</code><ul>
<li>Labels as key value pairs.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>mac-address=dolor</code><ul>
<li>List of physical interfaces.</li>
<li>Each invocation of this argument appends the given value to the array.</li>
</ul>
</li>
<li><code>name=ea</code><ul>
<li>Output only. The resource name of this <code>Network</code>. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: <code>projects/{project}/locations/{location}/networks/{network}</code></li>
</ul>
</li>
<li><code>services-cidr=ipsum</code><ul>
<li>IP range for reserved for services (e.g. NFS).</li>
</ul>
</li>
<li><code>state=invidunt</code><ul>
<li>The Network state.</li>
</ul>
</li>
<li><code>type=amet</code><ul>
<li>The type of this network.</li>
</ul>
</li>
<li><code>vlan-id=duo</code><ul>
<li>The vlan id of the Network.</li>
</ul>
</li>
<li><code>vrf name=ipsum</code><ul>
<li>The name of the VRF.</li>
</ul>
</li>
<li>
<p><code>qos-policy bandwidth-gbps=0.9001265173058445</code></p>
<ul>
<li>The bandwidth permitted by the QOS policy, in gbps.</li>
</ul>
</li>
<li>
<p><code>.. state=ut</code></p>
<ul>
<li>The possible state of VRF.</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>The list of fields to update. The only currently supported fields are: <code>labels</code></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_locations-nfs-shares-get" class="btn btn-neutral float-right" title="Locations Nfs Shares Get"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_locations-networks-list-network-usage" class="btn btn-neutral" title="Locations Networks List Network Usage"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/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" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span><a href="../projects_locations-networks-list-network-usage" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_locations-nfs-shares-get" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink