Files
google-apis-rs/google_connectors1_cli/projects_locations-endpoint-attachments-patch/index.html
2024-03-05 21:06:01 +01:00

419 lines
24 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-connectors1-cli/projects_locations-endpoint-attachments-patch/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Locations Endpoint Attachments Patch - Connectors v5.0.4+20240221</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 = "Locations Endpoint Attachments Patch";
var mkdocs_page_input_path = "projects_locations-endpoint-attachments-patch.md";
var mkdocs_page_url = "/google-apis-rs/google-connectors1-cli/projects_locations-endpoint-attachments-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"> Connectors v5.0.4+20240221
</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_locations-connections-connection-schema-metadata-get-action/">Locations Connections Connection Schema Metadata Get Action</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-connection-schema-metadata-get-entity-type/">Locations Connections Connection Schema Metadata Get Entity Type</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-connection-schema-metadata-list-actions/">Locations Connections Connection Schema Metadata List Actions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-connection-schema-metadata-list-entity-types/">Locations Connections Connection Schema Metadata List Entity Types</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-connection-schema-metadata-refresh/">Locations Connections Connection Schema Metadata Refresh</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-create/">Locations Connections Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-delete/">Locations Connections Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-event-subscriptions-create/">Locations Connections Event Subscriptions Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-event-subscriptions-delete/">Locations Connections Event Subscriptions Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-event-subscriptions-get/">Locations Connections Event Subscriptions Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-event-subscriptions-list/">Locations Connections Event Subscriptions List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-event-subscriptions-patch/">Locations Connections Event Subscriptions Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-event-subscriptions-retry/">Locations Connections Event Subscriptions Retry</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-get/">Locations Connections Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-get-connection-schema-metadata/">Locations Connections Get Connection Schema Metadata</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-get-iam-policy/">Locations Connections Get Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-list/">Locations Connections List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-listen-event/">Locations Connections Listen Event</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-patch/">Locations Connections Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-repair-eventing/">Locations Connections Repair Eventing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-runtime-action-schemas-list/">Locations Connections Runtime Action Schemas List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-runtime-entity-schemas-list/">Locations Connections Runtime Entity Schemas List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-set-iam-policy/">Locations Connections Set Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connections-test-iam-permissions/">Locations Connections Test Iam Permissions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-endpoint-attachments-create/">Locations Endpoint Attachments Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-endpoint-attachments-delete/">Locations Endpoint Attachments Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-endpoint-attachments-get/">Locations Endpoint Attachments Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-endpoint-attachments-list/">Locations Endpoint Attachments List</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Locations Endpoint Attachments Patch</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-get/">Locations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-get-regional-settings/">Locations Get Regional Settings</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-get-runtime-config/">Locations Get Runtime Config</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-global-custom-connectors-create/">Locations Global Custom Connectors Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-global-custom-connectors-custom-connector-versions-create/">Locations Global Custom Connectors Custom Connector Versions Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-global-custom-connectors-custom-connector-versions-delete/">Locations Global Custom Connectors Custom Connector Versions Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-global-custom-connectors-custom-connector-versions-get/">Locations Global Custom Connectors Custom Connector Versions Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-global-custom-connectors-custom-connector-versions-list/">Locations Global Custom Connectors Custom Connector Versions List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-global-custom-connectors-custom-connector-versions-patch/">Locations Global Custom Connectors Custom Connector Versions Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-global-custom-connectors-delete/">Locations Global Custom Connectors Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-global-custom-connectors-get/">Locations Global Custom Connectors Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-global-custom-connectors-list/">Locations Global Custom Connectors List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-global-custom-connectors-patch/">Locations Global Custom Connectors Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-global-get-settings/">Locations Global Get Settings</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-global-managed-zones-create/">Locations Global Managed Zones Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-global-managed-zones-delete/">Locations Global Managed Zones Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-global-managed-zones-get/">Locations Global Managed Zones Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-global-managed-zones-list/">Locations Global Managed Zones List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-global-managed-zones-patch/">Locations Global Managed Zones Patch</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-global-update-settings/">Locations Global Update Settings</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-list/">Locations List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-cancel/">Locations Operations Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-delete/">Locations Operations Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-get/">Locations Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-operations-list/">Locations Operations List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-providers-connectors-get/">Locations Providers Connectors Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-providers-connectors-list/">Locations Providers Connectors List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-providers-connectors-versions-eventtypes-get/">Locations Providers Connectors Versions Eventtypes Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-providers-connectors-versions-eventtypes-list/">Locations Providers Connectors Versions Eventtypes List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-providers-connectors-versions-get/">Locations Providers Connectors Versions Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-providers-connectors-versions-list/">Locations Providers Connectors Versions List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-providers-get/">Locations Providers Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-providers-get-iam-policy/">Locations Providers Get Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-providers-list/">Locations Providers List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-providers-set-iam-policy/">Locations Providers Set Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-providers-test-iam-permissions/">Locations Providers Test Iam Permissions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-update-regional-settings/">Locations Update Regional Settings</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="..">Connectors v5.0.4+20240221</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>Locations Endpoint Attachments Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/connectors1-cli/edit/master/docs/projects_locations-endpoint-attachments-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 the parameters of a single EndpointAttachment.</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>connectors1 --scope &lt;scope&gt; projects locations-endpoint-attachments-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. Resource name of the Endpoint Attachment. Format: projects/{project}/locations/{location}/endpointAttachments/{endpoint_attachment}</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>EndpointAttachment:
create-time: string
description: string
endpoint-ip: string
labels: { string: string }
name: string
service-attachment: 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 . create-time=amet</code><ul>
<li>Output only. Created time.</li>
</ul>
</li>
<li><code>description=lorem</code><ul>
<li>Optional. Description of the resource.</li>
</ul>
</li>
<li><code>endpoint-ip=justo</code><ul>
<li>Output only. The Private Service Connect connection endpoint ip</li>
</ul>
</li>
<li><code>labels=key=invidunt</code><ul>
<li>Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>name=sed</code><ul>
<li>Output only. Resource name of the Endpoint Attachment. Format: projects/{project}/locations/{location}/endpointAttachments/{endpoint_attachment}</li>
</ul>
</li>
<li><code>service-attachment=nonumy</code><ul>
<li>Required. The path of the service attachment</li>
</ul>
</li>
<li><code>update-time=sea</code><ul>
<li>Output only. Updated time.</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>Required. The list of fields to update. Fields are specified relative to the endpointAttachment. A field will be overwritten if it is in the mask. You can modify only the fields listed below. To update the endpointAttachment details: * <code>description</code> * <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-endpoint-attachments-list/" class="btn btn-neutral float-left" title="Locations Endpoint Attachments List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_locations-get/" class="btn btn-neutral float-right" title="Locations Get">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/connectors1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../projects_locations-endpoint-attachments-list/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_locations-get/" 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>