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

594 lines
23 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 Services Patch - Dataproc Metastore v3.0.0+20220222</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"> Dataproc Metastore v3.0.0+20220222</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-list">Locations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-delete">Locations Operations Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-get">Locations Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-operations-list">Locations Operations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-backups-create">Locations Services Backups Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-backups-delete">Locations Services Backups Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-backups-get">Locations Services Backups Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-backups-get-iam-policy">Locations Services Backups Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-backups-list">Locations Services Backups List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-backups-set-iam-policy">Locations Services Backups Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-backups-test-iam-permissions">Locations Services Backups Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-create">Locations Services Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-databases-get-iam-policy">Locations Services Databases Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-databases-set-iam-policy">Locations Services Databases Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-databases-tables-get-iam-policy">Locations Services Databases Tables Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-databases-tables-set-iam-policy">Locations Services Databases Tables Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-databases-tables-test-iam-permissions">Locations Services Databases Tables Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-databases-test-iam-permissions">Locations Services Databases Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-delete">Locations Services Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-export-metadata">Locations Services Export Metadata</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-get">Locations Services Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-get-iam-policy">Locations Services Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-list">Locations Services List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-metadata-imports-create">Locations Services Metadata Imports Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-metadata-imports-get">Locations Services Metadata Imports Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-metadata-imports-list">Locations Services Metadata Imports List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-metadata-imports-patch">Locations Services Metadata Imports Patch</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Locations Services 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-services-remove-iam-policy">Locations Services Remove Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-restore">Locations Services Restore</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-set-iam-policy">Locations Services Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-services-test-iam-permissions">Locations Services 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 Services Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/metastore1_beta-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Updates the parameters of a single service.</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>metastore1-beta --scope &lt;scope&gt; projects locations-services-patch ...</code></p>
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
<ul>
<li><strong>&lt;name&gt;</strong> <em>(string)</em><ul>
<li>Immutable. The relative resource name of the metastore service, of the form:projects/{project_number}/locations/{location_id}/services/{service_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>Service:
artifact-gcs-uri: string
create-time: string
database-type: string
encryption-config:
kms-key: string
endpoint-uri: string
hive-metastore-config:
config-overrides: { string: string }
endpoint-protocol: string
kerberos-config:
keytab:
cloud-secret: string
krb5-config-gcs-uri: string
principal: string
version: string
labels: { string: string }
maintenance-window:
day-of-week: string
hour-of-day: integer
metadata-integration:
data-catalog-config:
enabled: boolean
name: string
network: string
port: integer
release-channel: string
state: string
state-message: string
tier: 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 . artifact-gcs-uri=voluptua.</code><ul>
<li>Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored.</li>
</ul>
</li>
<li><code>create-time=dolore</code><ul>
<li>Output only. The time when the metastore service was created.</li>
</ul>
</li>
<li><code>database-type=dolore</code><ul>
<li>Immutable. The database type that the Metastore service stores its data.</li>
</ul>
</li>
<li>
<p><code>encryption-config kms-key=dolore</code></p>
<ul>
<li>The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following form:projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}.</li>
</ul>
</li>
<li>
<p><code>.. endpoint-uri=voluptua.</code></p>
<ul>
<li>Output only. The URI of the endpoint used to access the metastore service.</li>
</ul>
</li>
<li><code>hive-metastore-config config-overrides=key=amet.</code><ul>
<li>A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in hive-site.xml). The mappings override system defaults (some keys cannot be overridden). These overrides are also applied to auxiliary versions and can be further customized in the auxiliary version&#39;s AuxiliaryVersionConfig.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>endpoint-protocol=ea</code><ul>
<li>The protocol to use for the metastore service endpoint. If unspecified, defaults to THRIFT.</li>
</ul>
</li>
<li>
<p><code>kerberos-config.keytab cloud-secret=sadipscing</code></p>
<ul>
<li>The relative resource name of a Secret Manager secret version, in the following form:projects/{project_number}/secrets/{secret_id}/versions/{version_id}.</li>
</ul>
</li>
<li>
<p><code>.. krb5-config-gcs-uri=lorem</code></p>
<ul>
<li>A Cloud Storage URI that specifies the path to a krb5.conf file. It is of the form gs://{bucket_name}/path/to/krb5.conf, although the file does not need to be named krb5.conf explicitly.</li>
</ul>
</li>
<li>
<p><code>principal=invidunt</code></p>
<ul>
<li>A Kerberos principal that exists in the both the keytab the KDC to authenticate as. A typical principal is of the form primary/instance@REALM, but there is no exact format.</li>
</ul>
</li>
<li>
<p><code>.. version=no</code></p>
<ul>
<li>Immutable. The Hive metastore schema version.</li>
</ul>
</li>
<li>
<p><code>.. labels=key=est</code></p>
<ul>
<li>User-defined labels for the metastore service.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>maintenance-window day-of-week=at</code><ul>
<li>The day of week, when the window starts.</li>
</ul>
</li>
<li>
<p><code>hour-of-day=58</code></p>
<ul>
<li>The hour of day (0-23) when the window starts.</li>
</ul>
</li>
<li>
<p><code>..metadata-integration.data-catalog-config enabled=false</code></p>
<ul>
<li>Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.</li>
</ul>
</li>
<li>
<p><code>... name=et</code></p>
<ul>
<li>Immutable. The relative resource name of the metastore service, of the form:projects/{project_number}/locations/{location_id}/services/{service_id}.</li>
</ul>
</li>
<li><code>network=tempor</code><ul>
<li>Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}.</li>
</ul>
</li>
<li><code>port=69</code><ul>
<li>The TCP port at which the metastore service is reached. Default: 9083.</li>
</ul>
</li>
<li><code>release-channel=ipsum</code><ul>
<li>Immutable. The release channel of the service. If unspecified, defaults to STABLE.</li>
</ul>
</li>
<li><code>state=et</code><ul>
<li>Output only. The current state of the metastore service.</li>
</ul>
</li>
<li><code>state-message=sanctus</code><ul>
<li>Output only. Additional information about the current state of the metastore service, if available.</li>
</ul>
</li>
<li><code>tier=lorem</code><ul>
<li>The tier of the service.</li>
</ul>
</li>
<li><code>uid=est</code><ul>
<li>Output only. The globally unique resource identifier of the metastore service.</li>
</ul>
</li>
<li><code>update-time=sed</code><ul>
<li>Output only. The time when the metastore service 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 request-id=string</strong></p>
<ul>
<li>Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.</li>
</ul>
</li>
<li>
<p><strong>-p update-mask=string</strong></p>
<ul>
<li>Required. A field mask used to specify the fields to be overwritten in the metastore service resource by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.</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-services-remove-iam-policy" class="btn btn-neutral float-right" title="Locations Services Remove Iam Policy"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_locations-services-metadata-imports-patch" class="btn btn-neutral" title="Locations Services Metadata Imports Patch"><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-services-metadata-imports-patch" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_locations-services-remove-iam-policy" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>