mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 20:30:52 +01:00
556 lines
28 KiB
HTML
556 lines
28 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-datamigration1-cli/projects_locations-migration-jobs-patch/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Locations Migration Jobs Patch - Database Migration Service 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 Migration Jobs Patch";
|
|
var mkdocs_page_input_path = "projects_locations-migration-jobs-patch.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-datamigration1-cli/projects_locations-migration-jobs-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"> Database Migration Service 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-connection-profiles-create/">Locations Connection Profiles Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connection-profiles-delete/">Locations Connection Profiles Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connection-profiles-get/">Locations Connection Profiles Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connection-profiles-get-iam-policy/">Locations Connection Profiles Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connection-profiles-list/">Locations Connection Profiles List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connection-profiles-patch/">Locations Connection Profiles Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connection-profiles-set-iam-policy/">Locations Connection Profiles Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-connection-profiles-test-iam-permissions/">Locations Connection Profiles Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-apply/">Locations Conversion Workspaces Apply</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-commit/">Locations Conversion Workspaces Commit</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-convert/">Locations Conversion Workspaces Convert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-create/">Locations Conversion Workspaces Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-delete/">Locations Conversion Workspaces Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-describe-conversion-workspace-revisions/">Locations Conversion Workspaces Describe Conversion Workspace Revisions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-describe-database-entities/">Locations Conversion Workspaces Describe Database Entities</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-get/">Locations Conversion Workspaces Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-get-iam-policy/">Locations Conversion Workspaces Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-list/">Locations Conversion Workspaces List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-mapping-rules-create/">Locations Conversion Workspaces Mapping Rules Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-mapping-rules-delete/">Locations Conversion Workspaces Mapping Rules Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-mapping-rules-get/">Locations Conversion Workspaces Mapping Rules Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-mapping-rules-import/">Locations Conversion Workspaces Mapping Rules Import</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-mapping-rules-list/">Locations Conversion Workspaces Mapping Rules List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-patch/">Locations Conversion Workspaces Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-rollback/">Locations Conversion Workspaces Rollback</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-search-background-jobs/">Locations Conversion Workspaces Search Background Jobs</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-seed/">Locations Conversion Workspaces Seed</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-set-iam-policy/">Locations Conversion Workspaces Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-conversion-workspaces-test-iam-permissions/">Locations Conversion Workspaces Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-fetch-static-ips/">Locations Fetch Static Ips</a>
|
|
</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-list/">Locations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-migration-jobs-create/">Locations Migration Jobs Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-migration-jobs-delete/">Locations Migration Jobs Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-migration-jobs-demote-destination/">Locations Migration Jobs Demote Destination</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-migration-jobs-generate-ssh-script/">Locations Migration Jobs Generate Ssh Script</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-migration-jobs-generate-tcp-proxy-script/">Locations Migration Jobs Generate Tcp Proxy Script</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-migration-jobs-get/">Locations Migration Jobs Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-migration-jobs-get-iam-policy/">Locations Migration Jobs Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-migration-jobs-list/">Locations Migration Jobs List</a>
|
|
</li>
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Locations Migration Jobs Patch</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-migration-jobs-promote/">Locations Migration Jobs Promote</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-migration-jobs-restart/">Locations Migration Jobs Restart</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-migration-jobs-resume/">Locations Migration Jobs Resume</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-migration-jobs-set-iam-policy/">Locations Migration Jobs Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-migration-jobs-start/">Locations Migration Jobs Start</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-migration-jobs-stop/">Locations Migration Jobs Stop</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-migration-jobs-test-iam-permissions/">Locations Migration Jobs Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-migration-jobs-verify/">Locations Migration Jobs Verify</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-private-connections-create/">Locations Private Connections Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-private-connections-delete/">Locations Private Connections Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-private-connections-get/">Locations Private Connections Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-private-connections-get-iam-policy/">Locations Private Connections Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-private-connections-list/">Locations Private Connections List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-private-connections-set-iam-policy/">Locations Private Connections Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-private-connections-test-iam-permissions/">Locations Private Connections Test Iam Permissions</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="..">Database Migration Service 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> »</li>
|
|
<li>Projects »</li>
|
|
<li>Locations Migration Jobs Patch</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/datamigration1-cli/edit/master/docs/projects_locations-migration-jobs-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 migration job.</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-migration-jobs-patch ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><name></strong> <em>(string)</em><ul>
|
|
<li>The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.</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>MigrationJob:
|
|
cmek-key-name: string
|
|
conversion-workspace:
|
|
commit-id: string
|
|
name: string
|
|
create-time: string
|
|
destination: string
|
|
destination-database:
|
|
engine: string
|
|
provider: string
|
|
display-name: string
|
|
dump-path: string
|
|
duration: string
|
|
end-time: string
|
|
error:
|
|
code: integer
|
|
message: string
|
|
filter: string
|
|
labels: { string: string }
|
|
name: string
|
|
performance-config:
|
|
dump-parallel-level: string
|
|
phase: string
|
|
reverse-ssh-connectivity:
|
|
vm: string
|
|
vm-ip: string
|
|
vm-port: integer
|
|
vpc: string
|
|
source: string
|
|
source-database:
|
|
engine: string
|
|
provider: string
|
|
state: string
|
|
type: string
|
|
update-time: string
|
|
vpc-peering-connectivity:
|
|
vpc: 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 . cmek-key-name=lorem</code><ul>
|
|
<li>The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>conversion-workspace commit-id=sit</code><ul>
|
|
<li>The commit ID of the conversion workspace.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>name=kasd</code></p>
|
|
<ul>
|
|
<li>The resource name (URI) of the conversion workspace.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. create-time=tempor</code></p>
|
|
<ul>
|
|
<li>Output only. The timestamp when the migration job 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>destination=dolor</code><ul>
|
|
<li>Required. The resource name (URI) of the destination connection profile.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>destination-database engine=amet</code><ul>
|
|
<li>The database engine.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>provider=sit</code></p>
|
|
<ul>
|
|
<li>The database provider.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. display-name=rebum.</code></p>
|
|
<ul>
|
|
<li>The migration job display name.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>dump-path=sea</code><ul>
|
|
<li>The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>duration=ipsum</code><ul>
|
|
<li>Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>end-time=ipsum</code><ul>
|
|
<li>Output only. If the migration job is completed, the time when it was completed.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>error code=77</code><ul>
|
|
<li>The status code, which should be an enum value of google.rpc.Code.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>message=elitr</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>.. filter=eirmod</code></p>
|
|
<ul>
|
|
<li>This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>labels=key=dolor</code><ul>
|
|
<li>The resource labels for migration job 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>name=sadipscing</code><ul>
|
|
<li>The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>performance-config dump-parallel-level=dolor</code></p>
|
|
<ul>
|
|
<li>Initial dump parallelism level.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. phase=dolor</code></p>
|
|
<ul>
|
|
<li>Output only. The current migration job phase.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>reverse-ssh-connectivity vm=consetetur</code><ul>
|
|
<li>The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>vm-ip=et</code><ul>
|
|
<li>Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>vm-port=53</code><ul>
|
|
<li>Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>vpc=lorem</code></p>
|
|
<ul>
|
|
<li>The name of the VPC to peer with the Cloud SQL private network.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. source=nonumy</code></p>
|
|
<ul>
|
|
<li>Required. The resource name (URI) of the source connection profile.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>source-database engine=diam</code><ul>
|
|
<li>The database engine.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>provider=ipsum</code></p>
|
|
<ul>
|
|
<li>The database provider.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. state=invidunt</code></p>
|
|
<ul>
|
|
<li>The current migration job state.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>type=stet</code><ul>
|
|
<li>Required. The migration job type.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>update-time=voluptua.</code><ul>
|
|
<li>Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>vpc-peering-connectivity vpc=at</code><ul>
|
|
<li>The name of the VPC network to peer with the Cloud SQL private network.</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 is 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 by the update in the conversion workspace 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-migration-jobs-list/" class="btn btn-neutral float-left" title="Locations Migration Jobs List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_locations-migration-jobs-promote/" class="btn btn-neutral float-right" title="Locations Migration Jobs Promote">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 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/datamigration1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_locations-migration-jobs-list/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_locations-migration-jobs-promote/" style="color: #fcfcfc">Next »</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>
|