mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
571 lines
20 KiB
HTML
571 lines
20 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 Connections Create - Connectors v3.0.0+20220214</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"> Connectors v3.0.0+20220214</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 current">
|
|
<a class="current" href=".">Locations Connections Create</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-connections-delete">Locations Connections Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-connections-get">Locations Connections Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-connections-get-connection-schema-metadata">Locations Connections Get Connection Schema Metadata</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-connections-get-iam-policy">Locations Connections Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-connections-list">Locations Connections List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-connections-patch">Locations Connections Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-connections-runtime-action-schemas-list">Locations Connections Runtime Action Schemas List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-connections-runtime-entity-schemas-list">Locations Connections Runtime Entity Schemas List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-connections-set-iam-policy">Locations Connections Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-connections-test-iam-permissions">Locations Connections Test Iam Permissions</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-get-runtime-config">Locations Get Runtime Config</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-global-providers-connectors-get">Locations Global Providers Connectors Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-global-providers-connectors-list">Locations Global Providers Connectors List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-global-providers-connectors-versions-get">Locations Global Providers Connectors Versions Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-global-providers-connectors-versions-list">Locations Global Providers Connectors Versions List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-global-providers-get">Locations Global Providers Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-global-providers-list">Locations Global Providers List</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-providers-get-iam-policy">Locations Providers Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-providers-set-iam-policy">Locations Providers Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-providers-test-iam-permissions">Locations Providers Test Iam Permissions</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
</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> »</li>
|
|
<li>Locations Connections Create</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/connectors1-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<p>Creates a new Connection in a given project and location.</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 <scope> projects locations-connections-create ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><parent></strong> <em>(string)</em><ul>
|
|
<li>Required. Parent resource of the Connection, of the form: <code>projects/*/locations/*</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>Connection:
|
|
auth-config:
|
|
auth-type: string
|
|
oauth2-client-credentials:
|
|
client-id: string
|
|
client-secret:
|
|
secret-version: string
|
|
oauth2-jwt-bearer:
|
|
client-key:
|
|
secret-version: string
|
|
jwt-claims:
|
|
audience: string
|
|
issuer: string
|
|
subject: string
|
|
user-password:
|
|
password:
|
|
secret-version: string
|
|
username: string
|
|
connector-version: string
|
|
create-time: string
|
|
description: string
|
|
egress-backends: [string]
|
|
envoy-image-location: string
|
|
image-location: string
|
|
labels: { string: string }
|
|
lock-config:
|
|
locked: boolean
|
|
reason: string
|
|
name: string
|
|
service-account: string
|
|
service-directory: string
|
|
status:
|
|
description: string
|
|
state: string
|
|
status: string
|
|
suspended: boolean
|
|
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 .auth-config auth-type=et</code><ul>
|
|
<li>The type of authentication configured.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>oauth2-client-credentials client-id=magna</code><ul>
|
|
<li>The client identifier.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>client-secret secret-version=no</code></p>
|
|
<ul>
|
|
<li>The resource name of the secret version in the format, format as: <code>projects/*/secrets/*/versions/*</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>...oauth2-jwt-bearer.client-key secret-version=ipsum</code></p>
|
|
<ul>
|
|
<li>The resource name of the secret version in the format, format as: <code>projects/*/secrets/*/versions/*</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..jwt-claims audience=voluptua.</code></p>
|
|
<ul>
|
|
<li>Value for the "aud" claim.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>issuer=at</code><ul>
|
|
<li>Value for the "iss" claim.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>subject=sanctus</code></p>
|
|
<ul>
|
|
<li>Value for the "sub" claim.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>...user-password.password secret-version=sed</code></p>
|
|
<ul>
|
|
<li>The resource name of the secret version in the format, format as: <code>projects/*/secrets/*/versions/*</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. username=amet.</code></p>
|
|
<ul>
|
|
<li>Username.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... connector-version=takimata</code></p>
|
|
<ul>
|
|
<li>Required. Connector version on which the connection is created. The format is: projects/<em>/locations/global/providers/</em>/connectors/<em>/versions/</em></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>create-time=amet.</code><ul>
|
|
<li>Output only. Created time.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>description=duo</code><ul>
|
|
<li>Optional. Description of the resource.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>egress-backends=ipsum</code><ul>
|
|
<li>Output only. Outbound domains/hosts needs to be allowlisted.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>envoy-image-location=gubergren</code><ul>
|
|
<li>Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>image-location=lorem</code><ul>
|
|
<li>Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>labels=key=gubergren</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>lock-config locked=false</code><ul>
|
|
<li>Indicates whether or not the connection is locked.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>reason=dolor</code></p>
|
|
<ul>
|
|
<li>Describes why a connection is locked.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. name=ea</code></p>
|
|
<ul>
|
|
<li>Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>service-account=ipsum</code><ul>
|
|
<li>Optional. Service account needed for runtime plane to access GCP resources.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>service-directory=invidunt</code><ul>
|
|
<li>Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors"</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>status description=amet</code><ul>
|
|
<li>Description.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>state=duo</code><ul>
|
|
<li>State.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>status=ipsum</code></p>
|
|
<ul>
|
|
<li>Status provides detailed information for the state.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. suspended=false</code></p>
|
|
<ul>
|
|
<li>Optional. Suspended indicates if a user has suspended a connection or not.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>update-time=ut</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 connection-id=string</strong><ul>
|
|
<li>Required. Identifier to assign to the Connection. Must be unique within scope of the parent resource.</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_locations-connections-delete" class="btn btn-neutral float-right" title="Locations Connections Delete"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href=".." class="btn btn-neutral" title="Home"><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=".." style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="../projects_locations-connections-delete" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |