Files
google-apis-rs/google_dataplex1_cli/projects_locations-lakes-contentitems-patch/index.html
2022-03-08 15:36:16 +08:00

691 lines
27 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 Lakes Contentitems Patch - Cloud Dataplex v3.0.0+20220223</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"> Cloud Dataplex v3.0.0+20220223</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-get">Locations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-actions-list">Locations Lakes Actions List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-content-get-iam-policy">Locations Lakes Content Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-content-set-iam-policy">Locations Lakes Content Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-content-test-iam-permissions">Locations Lakes Content Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-contentitems-create">Locations Lakes Contentitems Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-contentitems-delete">Locations Lakes Contentitems Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-contentitems-get">Locations Lakes Contentitems Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-contentitems-list">Locations Lakes Contentitems List</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Locations Lakes Contentitems 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-lakes-create">Locations Lakes Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-delete">Locations Lakes Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-environments-create">Locations Lakes Environments Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-environments-delete">Locations Lakes Environments Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-environments-get">Locations Lakes Environments Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-environments-get-iam-policy">Locations Lakes Environments Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-environments-list">Locations Lakes Environments List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-environments-patch">Locations Lakes Environments Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-environments-sessions-list">Locations Lakes Environments Sessions List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-environments-set-iam-policy">Locations Lakes Environments Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-environments-test-iam-permissions">Locations Lakes Environments Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-get">Locations Lakes Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-get-iam-policy">Locations Lakes Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-list">Locations Lakes List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-patch">Locations Lakes Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-set-iam-policy">Locations Lakes Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-tasks-create">Locations Lakes Tasks Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-tasks-delete">Locations Lakes Tasks Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-tasks-get">Locations Lakes Tasks Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-tasks-get-iam-policy">Locations Lakes Tasks Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-tasks-jobs-cancel">Locations Lakes Tasks Jobs Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-tasks-jobs-get">Locations Lakes Tasks Jobs Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-tasks-jobs-list">Locations Lakes Tasks Jobs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-tasks-list">Locations Lakes Tasks List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-tasks-patch">Locations Lakes Tasks Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-tasks-set-iam-policy">Locations Lakes Tasks Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-tasks-test-iam-permissions">Locations Lakes Tasks Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-test-iam-permissions">Locations Lakes Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-actions-list">Locations Lakes Zones Actions List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-assets-actions-list">Locations Lakes Zones Assets Actions List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-assets-create">Locations Lakes Zones Assets Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-assets-delete">Locations Lakes Zones Assets Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-assets-get">Locations Lakes Zones Assets Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-assets-get-iam-policy">Locations Lakes Zones Assets Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-assets-list">Locations Lakes Zones Assets List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-assets-patch">Locations Lakes Zones Assets Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-assets-set-iam-policy">Locations Lakes Zones Assets Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-assets-test-iam-permissions">Locations Lakes Zones Assets Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-create">Locations Lakes Zones Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-delete">Locations Lakes Zones Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-entities-create">Locations Lakes Zones Entities Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-entities-delete">Locations Lakes Zones Entities Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-entities-get">Locations Lakes Zones Entities Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-entities-list">Locations Lakes Zones Entities List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-entities-partitions-create">Locations Lakes Zones Entities Partitions Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-entities-partitions-delete">Locations Lakes Zones Entities Partitions Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-entities-partitions-get">Locations Lakes Zones Entities Partitions Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-entities-partitions-list">Locations Lakes Zones Entities Partitions List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-entities-update">Locations Lakes Zones Entities Update</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-get">Locations Lakes Zones Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-get-iam-policy">Locations Lakes Zones Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-list">Locations Lakes Zones List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-patch">Locations Lakes Zones Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-set-iam-policy">Locations Lakes Zones Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-lakes-zones-test-iam-permissions">Locations Lakes Zones Test Iam Permissions</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>
</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 Lakes Contentitems Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/dataplex1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Update a content. Only supports full resource update.</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>dataplex1 --scope &lt;scope&gt; projects locations-lakes-contentitems-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 relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}</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>GoogleCloudDataplexV1Content:
create-time: string
data-text: string
description: string
labels: { string: string }
name: string
notebook:
kernel-type: string
path: string
sql-script:
engine: string
uid: 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=lorem</code><ul>
<li>Output only. Content creation time.</li>
</ul>
</li>
<li><code>data-text=gubergren</code><ul>
<li>Required. Content data in string format.</li>
</ul>
</li>
<li><code>description=eos</code><ul>
<li>Optional. Description of the content.</li>
</ul>
</li>
<li><code>labels=key=dolor</code><ul>
<li>Optional. User defined labels for the content.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>name=ea</code><ul>
<li>Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id}</li>
</ul>
</li>
<li>
<p><code>notebook kernel-type=ipsum</code></p>
<ul>
<li>Required. Kernel Type of the notebook.</li>
</ul>
</li>
<li>
<p><code>.. path=invidunt</code></p>
<ul>
<li>Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes.</li>
</ul>
</li>
<li>
<p><code>sql-script engine=amet</code></p>
<ul>
<li>Required. Query Engine to be used for the Sql Query.</li>
</ul>
</li>
<li>
<p><code>.. uid=duo</code></p>
<ul>
<li>Output only. System generated globally unique ID for the content. This ID will be different if the content is deleted and re-created with the same name.</li>
</ul>
</li>
<li><code>update-time=ipsum</code><ul>
<li>Output only. The time when the content was last updated.</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 update-mask=string</strong></p>
<ul>
<li>Required. Mask of fields to update.</li>
</ul>
</li>
<li>
<p><strong>-p validate-only=boolean</strong></p>
<ul>
<li>Optional. Only validate the request, but do not perform mutations. 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-lakes-create" class="btn btn-neutral float-right" title="Locations Lakes Create"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_locations-lakes-contentitems-list" class="btn btn-neutral" title="Locations Lakes Contentitems 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-lakes-contentitems-list" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_locations-lakes-create" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>