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_datastream1_cli/projects_locations-connection-profiles-patch/index.html
Sebastian Thiel a20241b241 Update documentation
2022-03-08 15:36:16 +08:00

620 lines
22 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 Connection Profiles Patch - Datastream v3.0.0+20220207</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"> Datastream v3.0.0+20220207</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-connection-profiles-create">Locations Connection Profiles Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-connection-profiles-delete">Locations Connection Profiles Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-connection-profiles-discover">Locations Connection Profiles Discover</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-connection-profiles-get">Locations Connection Profiles Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-connection-profiles-list">Locations Connection Profiles List</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Locations Connection Profiles 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-fetch-static-ips">Locations Fetch Static Ips</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-get">Locations Get</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-operations-cancel">Locations Operations Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-delete">Locations Operations Delete</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-operations-list">Locations Operations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-private-connections-create">Locations Private Connections Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-private-connections-delete">Locations Private Connections Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-private-connections-get">Locations Private Connections Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-private-connections-list">Locations Private Connections List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-private-connections-routes-create">Locations Private Connections Routes Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-private-connections-routes-delete">Locations Private Connections Routes Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-private-connections-routes-get">Locations Private Connections Routes Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-private-connections-routes-list">Locations Private Connections Routes List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-streams-create">Locations Streams Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-streams-delete">Locations Streams Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-streams-get">Locations Streams Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-streams-list">Locations Streams List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-streams-objects-get">Locations Streams Objects Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-streams-objects-list">Locations Streams Objects List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-streams-objects-lookup">Locations Streams Objects Lookup</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-streams-objects-start-backfill-job">Locations Streams Objects Start Backfill Job</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-streams-objects-stop-backfill-job">Locations Streams Objects Stop Backfill Job</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-streams-patch">Locations Streams Patch</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 Connection Profiles Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/datastream1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Use this method to update the parameters of a connection profile.</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>datastream1 --scope &lt;scope&gt; projects locations-connection-profiles-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&#39;s name.</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>ConnectionProfile:
create-time: string
display-name: string
forward-ssh-connectivity:
hostname: string
password: string
port: integer
private-key: string
username: string
gcs-profile:
bucket: string
root-path: string
labels: { string: string }
mysql-profile:
hostname: string
password: string
port: integer
ssl-config:
ca-certificate: string
ca-certificate-set: boolean
client-certificate: string
client-certificate-set: boolean
client-key: string
client-key-set: boolean
username: string
name: string
oracle-profile:
connection-attributes: { string: string }
database-service: string
hostname: string
password: string
port: integer
username: string
private-connectivity:
private-connection: 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=vero</code><ul>
<li>Output only. The create time of the resource.</li>
</ul>
</li>
<li><code>display-name=vero</code><ul>
<li>Required. Display name.</li>
</ul>
</li>
<li><code>forward-ssh-connectivity hostname=invidunt</code><ul>
<li>Required. Hostname for the SSH tunnel.</li>
</ul>
</li>
<li><code>password=stet</code><ul>
<li>Input only. SSH password.</li>
</ul>
</li>
<li><code>port=25</code><ul>
<li>Port for the SSH tunnel, default value is 22.</li>
</ul>
</li>
<li><code>private-key=elitr</code><ul>
<li>Input only. SSH private key.</li>
</ul>
</li>
<li>
<p><code>username=lorem</code></p>
<ul>
<li>Required. Username for the SSH tunnel.</li>
</ul>
</li>
<li>
<p><code>..gcs-profile bucket=diam</code></p>
<ul>
<li>Required. The Cloud Storage bucket name.</li>
</ul>
</li>
<li>
<p><code>root-path=no</code></p>
<ul>
<li>The root path inside the Cloud Storage bucket.</li>
</ul>
</li>
<li>
<p><code>.. labels=key=ipsum</code></p>
<ul>
<li>Labels.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>mysql-profile hostname=accusam</code><ul>
<li>Required. Hostname for the MySQL connection.</li>
</ul>
</li>
<li><code>password=takimata</code><ul>
<li>Required. Input only. Password for the MySQL connection.</li>
</ul>
</li>
<li><code>port=55</code><ul>
<li>Port for the MySQL connection, default value is 3306.</li>
</ul>
</li>
<li><code>ssl-config ca-certificate=voluptua.</code><ul>
<li>Input only. PEM-encoded certificate of the CA that signed the source database server&#39;s certificate.</li>
</ul>
</li>
<li><code>ca-certificate-set=false</code><ul>
<li>Output only. Indicates whether the ca_certificate field is set.</li>
</ul>
</li>
<li><code>client-certificate=erat</code><ul>
<li>Input only. PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the &#39;client_key&#39; and the &#39;ca_certificate&#39; fields are mandatory.</li>
</ul>
</li>
<li><code>client-certificate-set=false</code><ul>
<li>Output only. Indicates whether the client_certificate field is set.</li>
</ul>
</li>
<li><code>client-key=amet.</code><ul>
<li>Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the &#39;client_certificate&#39; and the &#39;ca_certificate&#39; fields are mandatory.</li>
</ul>
</li>
<li>
<p><code>client-key-set=true</code></p>
<ul>
<li>Output only. Indicates whether the client_key field is set.</li>
</ul>
</li>
<li>
<p><code>.. username=et</code></p>
<ul>
<li>Required. Username for the MySQL connection.</li>
</ul>
</li>
<li>
<p><code>.. name=accusam</code></p>
<ul>
<li>Output only. The resource&#39;s name.</li>
</ul>
</li>
<li><code>oracle-profile connection-attributes=key=voluptua.</code><ul>
<li>Connection string attributes</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>database-service=dolore</code><ul>
<li>Required. Database for the Oracle connection.</li>
</ul>
</li>
<li><code>hostname=dolore</code><ul>
<li>Required. Hostname for the Oracle connection.</li>
</ul>
</li>
<li><code>password=dolore</code><ul>
<li>Required. Password for the Oracle connection.</li>
</ul>
</li>
<li><code>port=23</code><ul>
<li>Port for the Oracle connection, default value is 1521.</li>
</ul>
</li>
<li>
<p><code>username=amet.</code></p>
<ul>
<li>Required. Username for the Oracle connection.</li>
</ul>
</li>
<li>
<p><code>..private-connectivity private-connection=ea</code></p>
<ul>
<li>Required. A reference to a private connection resource. Format: <code>projects/{project}/locations/{location}/privateConnections/{name}</code></li>
</ul>
</li>
<li>
<p><code>.. update-time=sadipscing</code></p>
<ul>
<li>Output only. The update time of the resource.</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 force=boolean</strong></p>
<ul>
<li>Optional. Update the connection profile without validating it.</li>
</ul>
</li>
<li>
<p><strong>-p request-id=string</strong></p>
<ul>
<li>Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).</li>
</ul>
</li>
<li>
<p><strong>-p update-mask=string</strong></p>
<ul>
<li>Optional. Field mask is used to specify the fields to be overwritten in the ConnectionProfile resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.</li>
</ul>
</li>
<li>
<p><strong>-p validate-only=boolean</strong></p>
<ul>
<li>Optional. Only validate the connection profile, but don&#39;t update any resources. The default is false.</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-fetch-static-ips" class="btn btn-neutral float-right" title="Locations Fetch Static Ips"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_locations-connection-profiles-list" class="btn btn-neutral" title="Locations Connection Profiles 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-connection-profiles-list" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_locations-fetch-static-ips" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink