Files
google-apis-rs/google_datacatalog1_cli/projects_locations-entry-groups-patch/index.html
2022-03-08 15:36:16 +08:00

619 lines
25 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 Entry Groups Patch - Data Catalog v3.0.0+20220224</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"> Data Catalog v3.0.0+20220224</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Catalog</span>
<li class="toctree-l1 ">
<a class="" href="../catalog_search">Search</a>
</li>
<span>Entries</span>
<li class="toctree-l1 ">
<a class="" href="../entries_lookup">Lookup</a>
</li>
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-create">Locations Entry Groups Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-delete">Locations Entry Groups Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-entries-create">Locations Entry Groups Entries Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-entries-delete">Locations Entry Groups Entries Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-entries-get">Locations Entry Groups Entries Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-entries-get-iam-policy">Locations Entry Groups Entries Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-entries-list">Locations Entry Groups Entries List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-entries-modify-entry-contacts">Locations Entry Groups Entries Modify Entry Contacts</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-entries-modify-entry-overview">Locations Entry Groups Entries Modify Entry Overview</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-entries-patch">Locations Entry Groups Entries Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-entries-star">Locations Entry Groups Entries Star</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-entries-tags-create">Locations Entry Groups Entries Tags Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-entries-tags-delete">Locations Entry Groups Entries Tags Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-entries-tags-list">Locations Entry Groups Entries Tags List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-entries-tags-patch">Locations Entry Groups Entries Tags Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-entries-test-iam-permissions">Locations Entry Groups Entries Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-entries-unstar">Locations Entry Groups Entries Unstar</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-get">Locations Entry Groups Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-get-iam-policy">Locations Entry Groups Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-list">Locations Entry Groups List</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Locations Entry Groups 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-entry-groups-set-iam-policy">Locations Entry Groups Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-tags-create">Locations Entry Groups Tags Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-tags-delete">Locations Entry Groups Tags Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-tags-list">Locations Entry Groups Tags List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-tags-patch">Locations Entry Groups Tags Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-entry-groups-test-iam-permissions">Locations Entry Groups Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-tag-templates-create">Locations Tag Templates Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-tag-templates-delete">Locations Tag Templates Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-tag-templates-fields-create">Locations Tag Templates Fields Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-tag-templates-fields-delete">Locations Tag Templates Fields Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-tag-templates-fields-enum-values-rename">Locations Tag Templates Fields Enum Values Rename</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-tag-templates-fields-patch">Locations Tag Templates Fields Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-tag-templates-fields-rename">Locations Tag Templates Fields Rename</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-tag-templates-get">Locations Tag Templates Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-tag-templates-get-iam-policy">Locations Tag Templates Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-tag-templates-patch">Locations Tag Templates Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-tag-templates-set-iam-policy">Locations Tag Templates Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-tag-templates-test-iam-permissions">Locations Tag Templates Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-taxonomies-create">Locations Taxonomies Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-taxonomies-delete">Locations Taxonomies Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-taxonomies-export">Locations Taxonomies Export</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-taxonomies-get">Locations Taxonomies Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-taxonomies-get-iam-policy">Locations Taxonomies Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-taxonomies-import">Locations Taxonomies Import</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-taxonomies-list">Locations Taxonomies List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-taxonomies-patch">Locations Taxonomies Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-taxonomies-policy-tags-create">Locations Taxonomies Policy Tags Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-taxonomies-policy-tags-delete">Locations Taxonomies Policy Tags Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-taxonomies-policy-tags-get">Locations Taxonomies Policy Tags Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-taxonomies-policy-tags-get-iam-policy">Locations Taxonomies Policy Tags Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-taxonomies-policy-tags-list">Locations Taxonomies Policy Tags List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-taxonomies-policy-tags-patch">Locations Taxonomies Policy Tags Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-taxonomies-policy-tags-set-iam-policy">Locations Taxonomies Policy Tags Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-taxonomies-policy-tags-test-iam-permissions">Locations Taxonomies Policy Tags Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-taxonomies-replace">Locations Taxonomies Replace</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-taxonomies-set-iam-policy">Locations Taxonomies Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-taxonomies-test-iam-permissions">Locations Taxonomies Test Iam Permissions</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 Entry Groups Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/datacatalog1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Updates an entry group. You must enable the Data Catalog API in the project identified by the <code>entry_group.name</code> parameter. For more information, see <a href="https://cloud.google.com/data-catalog/docs/concepts/resource-project">Data Catalog resource project</a>.</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>datacatalog1 --scope &lt;scope&gt; projects locations-entry-groups-patch ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name.</li>
</ul>
</li>
</ul>
<h1 id="required-request-value">Required Request Value</h1>
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
<p>For example, a structure like this:</p>
<pre><code>GoogleCloudDatacatalogV1EntryGroup:
data-catalog-timestamps:
create-time: string
expire-time: string
update-time: string
description: string
display-name: string
name: 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 .data-catalog-timestamps create-time=est</code><ul>
<li>Creation timestamp of the resource within the given system.</li>
</ul>
</li>
<li><code>expire-time=sit</code><ul>
<li>Output only. Expiration timestamp of the resource within the given system. Currently only applicable to BigQuery resources.</li>
</ul>
</li>
<li>
<p><code>update-time=sed</code></p>
<ul>
<li>Timestamp of the last modification of the resource or its metadata within a given system. Note: Depending on the source system, not every modification updates this timestamp. For example, BigQuery timestamps every metadata modification but not data or permission changes.</li>
</ul>
</li>
<li>
<p><code>.. description=eos</code></p>
<ul>
<li>Entry group description. Can consist of several sentences or paragraphs that describe the entry group contents. Default value is an empty string.</li>
</ul>
</li>
<li><code>display-name=lorem</code><ul>
<li>A short name to identify the entry group, for example, &#34;analytics data - jan 2011&#34;. Default value is an empty string.</li>
</ul>
</li>
<li><code>name=ea</code><ul>
<li>The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name.</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 update-mask=string</strong><ul>
<li>Names of fields whose values to overwrite on an entry group. If this parameter is absent or empty, all modifiable fields are overwritten. If such fields are non-required and omitted in the request body, their values are emptied.</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-entry-groups-set-iam-policy" class="btn btn-neutral float-right" title="Locations Entry Groups Set Iam Policy"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_locations-entry-groups-list" class="btn btn-neutral" title="Locations Entry Groups 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-entry-groups-list" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_locations-entry-groups-set-iam-policy" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>