mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
710 lines
28 KiB
HTML
710 lines
28 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 Connection Profiles Patch - Database Migration Service v3.0.0+20220216</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"> Database Migration Service v3.0.0+20220216</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-get">Locations Connection Profiles Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-connection-profiles-get-iam-policy">Locations Connection Profiles Get Iam Policy</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-connection-profiles-set-iam-policy">Locations Connection Profiles Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-connection-profiles-test-iam-permissions">Locations Connection Profiles 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-list">Locations List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-migration-jobs-create">Locations Migration Jobs Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-migration-jobs-delete">Locations Migration Jobs Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-migration-jobs-generate-ssh-script">Locations Migration Jobs Generate Ssh Script</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-migration-jobs-get">Locations Migration Jobs Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-migration-jobs-get-iam-policy">Locations Migration Jobs Get Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-migration-jobs-list">Locations Migration Jobs List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-migration-jobs-patch">Locations Migration Jobs Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-migration-jobs-promote">Locations Migration Jobs Promote</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-migration-jobs-restart">Locations Migration Jobs Restart</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-migration-jobs-resume">Locations Migration Jobs Resume</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-migration-jobs-set-iam-policy">Locations Migration Jobs Set Iam Policy</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-migration-jobs-start">Locations Migration Jobs Start</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-migration-jobs-stop">Locations Migration Jobs Stop</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-migration-jobs-test-iam-permissions">Locations Migration Jobs Test Iam Permissions</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../projects_locations-migration-jobs-verify">Locations Migration Jobs Verify</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>
|
|
|
|
|
|
|
|
|
|
</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 Connection Profiles Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/datamigration1-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<p>Update the configuration of a single 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>datamigration1 --scope <scope> projects locations-connection-profiles-patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.</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:
|
|
cloudsql:
|
|
cloud-sql-id: string
|
|
private-ip: string
|
|
public-ip: string
|
|
settings:
|
|
activation-policy: string
|
|
auto-storage-increase: boolean
|
|
cmek-key-name: string
|
|
collation: string
|
|
data-disk-size-gb: string
|
|
data-disk-type: string
|
|
database-flags: { string: string }
|
|
database-version: string
|
|
ip-config:
|
|
enable-ipv4: boolean
|
|
private-network: string
|
|
require-ssl: boolean
|
|
root-password: string
|
|
root-password-set: boolean
|
|
source-id: string
|
|
storage-auto-resize-limit: string
|
|
tier: string
|
|
user-labels: { string: string }
|
|
zone: string
|
|
create-time: string
|
|
display-name: string
|
|
error:
|
|
code: integer
|
|
message: string
|
|
labels: { string: string }
|
|
mysql:
|
|
cloud-sql-id: string
|
|
host: string
|
|
password: string
|
|
password-set: boolean
|
|
port: integer
|
|
ssl:
|
|
ca-certificate: string
|
|
client-certificate: string
|
|
client-key: string
|
|
type: string
|
|
username: string
|
|
name: string
|
|
postgresql:
|
|
cloud-sql-id: string
|
|
host: string
|
|
password: string
|
|
password-set: boolean
|
|
port: integer
|
|
ssl:
|
|
ca-certificate: string
|
|
client-certificate: string
|
|
client-key: string
|
|
type: string
|
|
username: string
|
|
provider: string
|
|
state: 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 .cloudsql cloud-sql-id=amet.</code><ul>
|
|
<li>Output only. The Cloud SQL instance ID that this connection profile is associated with.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>private-ip=consetetur</code><ul>
|
|
<li>Output only. The Cloud SQL database instance's private IP.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>public-ip=diam</code><ul>
|
|
<li>Output only. The Cloud SQL database instance's public IP.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>settings activation-policy=dolor</code><ul>
|
|
<li>The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains so even in the absence of connection requests. <code>NEVER</code>: The instance is off; it is not activated, even if a connection request arrives.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>auto-storage-increase=false</code><ul>
|
|
<li>[default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>cmek-key-name=stet</code><ul>
|
|
<li>The KMS key name used for the csql instance.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>collation=dolor</code><ul>
|
|
<li>The Cloud SQL default instance level collation.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>data-disk-size-gb=duo</code><ul>
|
|
<li>The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>data-disk-type=vero</code><ul>
|
|
<li>The type of storage: <code>PD_SSD</code> (default) or <code>PD_HDD</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>database-flags=key=vero</code><ul>
|
|
<li>The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>database-version=invidunt</code><ul>
|
|
<li>The database engine type and version.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>ip-config enable-ipv4=true</code><ul>
|
|
<li>Whether the instance should be assigned an IPv4 address or not.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>private-network=vero</code><ul>
|
|
<li>The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, <code>projects/myProject/global/networks/default</code>. This setting can be updated, but it cannot be removed after it is set.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>require-ssl=true</code></p>
|
|
<ul>
|
|
<li>Whether SSL connections over IP should be enforced or not.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. root-password=lorem</code></p>
|
|
<ul>
|
|
<li>Input only. Initial root password.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>root-password-set=true</code><ul>
|
|
<li>Output only. Indicates If this connection profile root password is stored.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>source-id=ipsum</code><ul>
|
|
<li>The Database Migration Service source connection profile ID, in the format: <code>projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>storage-auto-resize-limit=accusam</code><ul>
|
|
<li>The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>tier=takimata</code><ul>
|
|
<li>The tier (or machine type) for this instance, for example: <code>db-n1-standard-1</code> (MySQL instances) or <code>db-custom-1-3840</code> (PostgreSQL instances). For more information, see <a href="https://cloud.google.com/sql/docs/mysql/instance-settings">Cloud SQL Instance Settings</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>user-labels=key=consetetur</code><ul>
|
|
<li>The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: <code>{ &#34;name&#34;: &#34;wrench&#34;, &#34;mass&#34;: &#34;18kg&#34;, &#34;count&#34;: &#34;3&#34; }</code>.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>zone=voluptua.</code></p>
|
|
<ul>
|
|
<li>The Google Cloud Platform zone where your Cloud SQL datdabse instance is located.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... create-time=et</code></p>
|
|
<ul>
|
|
<li>Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>display-name=erat</code><ul>
|
|
<li>The connection profile display name.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>error code=5</code><ul>
|
|
<li>The status code, which should be an enum value of google.rpc.Code.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>message=amet.</code></p>
|
|
<ul>
|
|
<li>A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. labels=key=sed</code></p>
|
|
<ul>
|
|
<li>The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: <code>{ &#34;name&#34;: &#34;wrench&#34;, &#34;mass&#34;: &#34;1.3kg&#34;, &#34;count&#34;: &#34;3&#34; }</code>.</li>
|
|
<li>the value will be associated with the given <code>key</code></li>
|
|
</ul>
|
|
</li>
|
|
<li><code>mysql cloud-sql-id=takimata</code><ul>
|
|
<li>If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>host=dolores</code><ul>
|
|
<li>Required. The IP or hostname of the source MySQL database.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>password=gubergren</code><ul>
|
|
<li>Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>password-set=false</code><ul>
|
|
<li>Output only. Indicates If this connection profile password is stored.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>port=78</code><ul>
|
|
<li>Required. The network port of the source MySQL database.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>ssl ca-certificate=voluptua.</code><ul>
|
|
<li>Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>client-certificate=dolore</code><ul>
|
|
<li>Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>client-key=dolore</code><ul>
|
|
<li>Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>type=dolore</code></p>
|
|
<ul>
|
|
<li>Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. username=voluptua.</code></p>
|
|
<ul>
|
|
<li>Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. name=amet.</code></p>
|
|
<ul>
|
|
<li>The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>postgresql cloud-sql-id=ea</code><ul>
|
|
<li>If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>host=sadipscing</code><ul>
|
|
<li>Required. The IP or hostname of the source PostgreSQL database.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>password=lorem</code><ul>
|
|
<li>Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>password-set=true</code><ul>
|
|
<li>Output only. Indicates If this connection profile password is stored.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>port=90</code><ul>
|
|
<li>Required. The network port of the source PostgreSQL database.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>ssl ca-certificate=est</code><ul>
|
|
<li>Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>client-certificate=at</code><ul>
|
|
<li>Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>client-key=sed</code><ul>
|
|
<li>Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>type=sit</code></p>
|
|
<ul>
|
|
<li>Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. username=et</code></p>
|
|
<ul>
|
|
<li>Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. provider=tempor</code></p>
|
|
<ul>
|
|
<li>The database provider.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>state=aliquyam</code><ul>
|
|
<li>The current connection profile state (e.g. DRAFT, READY, or FAILED).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>update-time=ipsum</code><ul>
|
|
<li>Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".</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 request-id=string</strong></p>
|
|
<ul>
|
|
<li>A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p update-mask=string</strong></p>
|
|
<ul>
|
|
<li>Required. Field mask is used to specify the fields to be overwritten in the connection profile resource by the update.</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-connection-profiles-set-iam-policy" class="btn btn-neutral float-right" title="Locations Connection Profiles Set Iam Policy"/>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;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="../projects_locations-connection-profiles-set-iam-policy" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |