Files
google-apis-rs/google_cloudbuild1_cli/projects_locations-worker-pools-patch/index.html
2022-03-08 15:36:16 +08:00

655 lines
25 KiB
HTML

<!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 Worker Pools Patch - Cloud Build v3.0.0+20220218</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"> Cloud Build v3.0.0+20220218</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Locations</span>
<li class="toctree-l1 ">
<a class="" href="../locations_regional-webhook">Regional Webhook</a>
</li>
<span>Methods</span>
<li class="toctree-l1 ">
<a class="" href="../methods_webhook">Webhook</a>
</li>
<span>Operations</span>
<li class="toctree-l1 ">
<a class="" href="../operations_cancel">Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../operations_get">Get</a>
</li>
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_builds-approve">Builds Approve</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_builds-cancel">Builds Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_builds-create">Builds Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_builds-get">Builds Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_builds-list">Builds List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_builds-retry">Builds Retry</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_github-enterprise-configs-create">Github Enterprise Configs Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_github-enterprise-configs-delete">Github Enterprise Configs Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_github-enterprise-configs-get">Github Enterprise Configs Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_github-enterprise-configs-list">Github Enterprise Configs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_github-enterprise-configs-patch">Github Enterprise Configs Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-bitbucket-server-configs-add-bitbucket-server-connected-repository">Locations Bitbucket Server Configs Add Bitbucket Server Connected Repository</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-bitbucket-server-configs-connected-repositories-batch-create">Locations Bitbucket Server Configs Connected Repositories Batch Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-bitbucket-server-configs-create">Locations Bitbucket Server Configs Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-bitbucket-server-configs-delete">Locations Bitbucket Server Configs Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-bitbucket-server-configs-get">Locations Bitbucket Server Configs Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-bitbucket-server-configs-list">Locations Bitbucket Server Configs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-bitbucket-server-configs-patch">Locations Bitbucket Server Configs Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-bitbucket-server-configs-remove-bitbucket-server-connected-repository">Locations Bitbucket Server Configs Remove Bitbucket Server Connected Repository</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-bitbucket-server-configs-repos-list">Locations Bitbucket Server Configs Repos List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-builds-approve">Locations Builds Approve</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-builds-cancel">Locations Builds Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-builds-create">Locations Builds Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-builds-get">Locations Builds Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-builds-list">Locations Builds List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-builds-retry">Locations Builds Retry</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-github-enterprise-configs-create">Locations Github Enterprise Configs Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-github-enterprise-configs-delete">Locations Github Enterprise Configs Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-github-enterprise-configs-get">Locations Github Enterprise Configs Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-github-enterprise-configs-list">Locations Github Enterprise Configs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-github-enterprise-configs-patch">Locations Github Enterprise Configs Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-cancel">Locations Operations Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-get">Locations Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-triggers-create">Locations Triggers Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-triggers-delete">Locations Triggers Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-triggers-get">Locations Triggers Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-triggers-list">Locations Triggers List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-triggers-patch">Locations Triggers Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-triggers-run">Locations Triggers Run</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-triggers-webhook">Locations Triggers Webhook</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-worker-pools-create">Locations Worker Pools Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-worker-pools-delete">Locations Worker Pools Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-worker-pools-get">Locations Worker Pools Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-worker-pools-list">Locations Worker Pools List</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Locations Worker Pools 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_triggers-create">Triggers Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_triggers-delete">Triggers Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_triggers-get">Triggers Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_triggers-list">Triggers List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_triggers-patch">Triggers Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_triggers-run">Triggers Run</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_triggers-webhook">Triggers Webhook</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 Worker Pools Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudbuild1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Updates a <code>WorkerPool</code>.</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>cloudbuild1 --scope &lt;scope&gt; projects locations-worker-pools-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 the <code>WorkerPool</code>, with format <code>projects/{project}/locations/{location}/workerPools/{worker_pool}</code>. The value of <code>{worker_pool}</code> is provided by <code>worker_pool_id</code> in <code>CreateWorkerPool</code> request and the value of <code>{location}</code> is determined by the endpoint accessed.</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>WorkerPool:
annotations: { string: string }
create-time: string
delete-time: string
display-name: string
etag: string
name: string
private-pool-v1-config:
network-config:
egress-option: string
peered-network: string
worker-config:
disk-size-gb: string
machine-type: string
state: string
uid: string
update-time: 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 . annotations=key=dolor</code><ul>
<li>User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>create-time=amet.</code><ul>
<li>Output only. Time at which the request to create the <code>WorkerPool</code> was received.</li>
</ul>
</li>
<li><code>delete-time=kasd</code><ul>
<li>Output only. Time at which the request to delete the <code>WorkerPool</code> was received.</li>
</ul>
</li>
<li><code>display-name=eirmod</code><ul>
<li>A user-specified, human-readable name for the <code>WorkerPool</code>. If provided, this value must be 1-63 characters.</li>
</ul>
</li>
<li><code>etag=amet.</code><ul>
<li>Output only. Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding.</li>
</ul>
</li>
<li><code>name=takimata</code><ul>
<li>Output only. The resource name of the <code>WorkerPool</code>, with format <code>projects/{project}/locations/{location}/workerPools/{worker_pool}</code>. The value of <code>{worker_pool}</code> is provided by <code>worker_pool_id</code> in <code>CreateWorkerPool</code> request and the value of <code>{location}</code> is determined by the endpoint accessed.</li>
</ul>
</li>
<li><code>private-pool-v1-config.network-config egress-option=amet.</code><ul>
<li>Option to configure network egress for the workers.</li>
</ul>
</li>
<li>
<p><code>peered-network=et</code></p>
<ul>
<li>Required. Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to <code>WorkerPool.project_id</code> on the service producer network. Must be in the format <code>projects/{project}/global/networks/{network}</code>, where <code>{project}</code> is a project number, such as <code>12345</code>, and <code>{network}</code> is the name of a VPC network in the project. See <a href="https://cloud.google.com/build/docs/private-pools/set-up-private-pool-environment">Understanding network configuration options</a></li>
</ul>
</li>
<li>
<p><code>..worker-config disk-size-gb=labore</code></p>
<ul>
<li>Size of the disk attached to the worker, in GB. See <a href="https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema">Worker pool config file</a>. Specify a value of up to 1000. If <code>0</code> is specified, Cloud Build will use a standard disk size.</li>
</ul>
</li>
<li>
<p><code>machine-type=sed</code></p>
<ul>
<li>Machine type of a worker, such as <code>e2-medium</code>. See <a href="https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema">Worker pool config file</a>. If left blank, Cloud Build will use a sensible default.</li>
</ul>
</li>
<li>
<p><code>... state=sit</code></p>
<ul>
<li>Output only. <code>WorkerPool</code> state.</li>
</ul>
</li>
<li><code>uid=sit</code><ul>
<li>Output only. A unique identifier for the <code>WorkerPool</code>.</li>
</ul>
</li>
<li><code>update-time=invidunt</code><ul>
<li>Output only. Time at which the request to update the <code>WorkerPool</code> was received.</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 update-mask=string</strong></p>
<ul>
<li>A mask specifying which fields in <code>worker_pool</code> to update.</li>
</ul>
</li>
<li>
<p><strong>-p validate-only=boolean</strong></p>
<ul>
<li>If set, validate the request and preview the response, but do not actually post it.</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_triggers-create" class="btn btn-neutral float-right" title="Triggers Create"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_locations-worker-pools-list" class="btn btn-neutral" title="Locations Worker Pools List"><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-worker-pools-list" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_triggers-create" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>