Files
google-apis-rs/google_securitycenter1_cli/projects_big-query-exports-patch/index.html
2022-03-08 15:36:16 +08:00

749 lines
30 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>Big Query Exports Patch - Security Command Center 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"> Security Command Center 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>Folders</span>
<li class="toctree-l1 ">
<a class="" href="../folders_assets-group">Assets Group</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_assets-list">Assets List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_assets-update-security-marks">Assets Update Security Marks</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_big-query-exports-create">Big Query Exports Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_big-query-exports-delete">Big Query Exports Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_big-query-exports-get">Big Query Exports Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_big-query-exports-list">Big Query Exports List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_big-query-exports-patch">Big Query Exports Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_findings-bulk-mute">Findings Bulk Mute</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_mute-configs-create">Mute Configs Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_mute-configs-delete">Mute Configs Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_mute-configs-get">Mute Configs Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_mute-configs-list">Mute Configs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_mute-configs-patch">Mute Configs Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_sources-findings-external-systems-patch">Sources Findings External Systems Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_sources-findings-group">Sources Findings Group</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_sources-findings-list">Sources Findings List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_sources-findings-patch">Sources Findings Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_sources-findings-set-mute">Sources Findings Set Mute</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_sources-findings-set-state">Sources Findings Set State</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_sources-findings-update-security-marks">Sources Findings Update Security Marks</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../folders_sources-list">Sources List</a>
</li>
<span>Organizations</span>
<li class="toctree-l1 ">
<a class="" href="../organizations_assets-group">Assets Group</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_assets-list">Assets List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_assets-run-discovery">Assets Run Discovery</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_assets-update-security-marks">Assets Update Security Marks</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_big-query-exports-create">Big Query Exports Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_big-query-exports-delete">Big Query Exports Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_big-query-exports-get">Big Query Exports Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_big-query-exports-list">Big Query Exports List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_big-query-exports-patch">Big Query Exports Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_findings-bulk-mute">Findings Bulk Mute</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_get-organization-settings">Get Organization Settings</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_mute-configs-create">Mute Configs Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_mute-configs-delete">Mute Configs Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_mute-configs-get">Mute Configs Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_mute-configs-list">Mute Configs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_mute-configs-patch">Mute Configs Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_notification-configs-create">Notification Configs Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_notification-configs-delete">Notification Configs Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_notification-configs-get">Notification Configs Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_notification-configs-list">Notification Configs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_notification-configs-patch">Notification Configs Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_operations-cancel">Operations Cancel</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_operations-delete">Operations Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_operations-get">Operations Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_operations-list">Operations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_sources-create">Sources Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_sources-findings-create">Sources Findings Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_sources-findings-external-systems-patch">Sources Findings External Systems Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_sources-findings-group">Sources Findings Group</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_sources-findings-list">Sources Findings List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_sources-findings-patch">Sources Findings Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_sources-findings-set-mute">Sources Findings Set Mute</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_sources-findings-set-state">Sources Findings Set State</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_sources-findings-update-security-marks">Sources Findings Update Security Marks</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_sources-get">Sources Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_sources-get-iam-policy">Sources Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_sources-list">Sources List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_sources-patch">Sources Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_sources-set-iam-policy">Sources Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_sources-test-iam-permissions">Sources Test Iam Permissions</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../organizations_update-organization-settings">Update Organization Settings</a>
</li>
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_assets-group">Assets Group</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_assets-list">Assets List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_assets-update-security-marks">Assets Update Security Marks</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_big-query-exports-create">Big Query Exports Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_big-query-exports-delete">Big Query Exports Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_big-query-exports-get">Big Query Exports Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_big-query-exports-list">Big Query Exports List</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Big Query Exports 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_findings-bulk-mute">Findings Bulk Mute</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_mute-configs-create">Mute Configs Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_mute-configs-delete">Mute Configs Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_mute-configs-get">Mute Configs Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_mute-configs-list">Mute Configs List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_mute-configs-patch">Mute Configs Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_sources-findings-external-systems-patch">Sources Findings External Systems Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_sources-findings-group">Sources Findings Group</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_sources-findings-list">Sources Findings List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_sources-findings-patch">Sources Findings Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_sources-findings-set-mute">Sources Findings Set Mute</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_sources-findings-set-state">Sources Findings Set State</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_sources-findings-update-security-marks">Sources Findings Update Security Marks</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_sources-list">Sources 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>Big Query Exports Patch</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/securitycenter1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Updates a BigQuery export.</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>securitycenter1 --scope &lt;scope&gt; projects big-query-exports-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 relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: &#34;organizations/{organization_id}/bigQueryExports/{export_id}&#34; Example format: &#34;folders/{folder_id}/bigQueryExports/{export_id}&#34; Example format: &#34;projects/{project_id}/bigQueryExports/{export_id}&#34; This field is provided in responses, and is ignored when provided in create requests.</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>GoogleCloudSecuritycenterV1BigQueryExport:
create-time: string
dataset: string
description: string
filter: string
most-recent-editor: string
name: string
principal: 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=amet</code><ul>
<li>Output only. The time at which the big query export was created. This field is set by the server and will be ignored if provided on export on creation.</li>
</ul>
</li>
<li><code>dataset=lorem</code><ul>
<li>The dataset to write findings&#39; updates to. Its format is &#34;projects/[project_id]/datasets/[bigquery_dataset_id]&#34;. BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).</li>
</ul>
</li>
<li><code>description=justo</code><ul>
<li>The description of the export (max of 1024 characters).</li>
</ul>
</li>
<li><code>filter=invidunt</code><ul>
<li>Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators <code>AND</code> and <code>OR</code>. Parentheses are supported, and <code>OR</code> has higher precedence than <code>AND</code>. Restrictions have the form <code></code> and may have a <code>-</code> character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * <code>=</code> for all value types. * <code>&amp;gt;</code>, <code>&amp;lt;</code>, <code>&amp;gt;=</code>, <code>&amp;lt;=</code> for integer values. * <code>:</code>, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals <code>true</code> and <code>false</code> without quotes. Please see the proto documentation in the finding (https://source.corp.google.com/piper///depot/google3/google/cloud/securitycenter/v1/finding.proto) and in the ListFindingsRequest for valid filter syntax. (https://source.corp.google.com/piper///depot/google3/google/cloud/securitycenter/v1/securitycenter_service.proto).</li>
</ul>
</li>
<li><code>most-recent-editor=sed</code><ul>
<li>Output only. Email address of the user who last edited the big query export. This field is set by the server and will be ignored if provided on export creation or update.</li>
</ul>
</li>
<li><code>name=nonumy</code><ul>
<li>The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: &#34;organizations/{organization_id}/bigQueryExports/{export_id}&#34; Example format: &#34;folders/{folder_id}/bigQueryExports/{export_id}&#34; Example format: &#34;projects/{project_id}/bigQueryExports/{export_id}&#34; This field is provided in responses, and is ignored when provided in create requests.</li>
</ul>
</li>
<li><code>principal=sea</code><ul>
<li>Output only. The service account that needs permission to create table, upload data to the big query dataset.</li>
</ul>
</li>
<li><code>update-time=ipsum</code><ul>
<li>Output only. The most recent time at which the big export was updated. This field is set by the server and will be ignored if provided on export creation or update.</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>The list of fields to be updated. If empty all mutable fields will be updated.</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_findings-bulk-mute" class="btn btn-neutral float-right" title="Findings Bulk Mute"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_big-query-exports-list" class="btn btn-neutral" title="Big Query Exports 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_big-query-exports-list" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_findings-bulk-mute" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>