Files
google-apis-rs/google_drive3_cli/revisions_update/index.html
2022-03-08 15:36:16 +08:00

630 lines
20 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>Update - drive v3.0.0+20220225</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"> drive v3.0.0+20220225</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>About</span>
<li class="toctree-l1 ">
<a class="" href="../about_get">Get</a>
</li>
<span>Changes</span>
<li class="toctree-l1 ">
<a class="" href="../changes_get-start-page-token">Get Start Page Token</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../changes_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../changes_watch">Watch</a>
</li>
<span>Channels</span>
<li class="toctree-l1 ">
<a class="" href="../channels_stop">Stop</a>
</li>
<span>Comments</span>
<li class="toctree-l1 ">
<a class="" href="../comments_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../comments_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../comments_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../comments_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../comments_update">Update</a>
</li>
<span>Drives</span>
<li class="toctree-l1 ">
<a class="" href="../drives_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../drives_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../drives_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../drives_hide">Hide</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../drives_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../drives_unhide">Unhide</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../drives_update">Update</a>
</li>
<span>Files</span>
<li class="toctree-l1 ">
<a class="" href="../files_copy">Copy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_empty-trash">Empty Trash</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_export">Export</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_generate-ids">Generate Ids</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_update">Update</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../files_watch">Watch</a>
</li>
<span>Permissions</span>
<li class="toctree-l1 ">
<a class="" href="../permissions_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../permissions_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../permissions_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../permissions_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../permissions_update">Update</a>
</li>
<span>Replies</span>
<li class="toctree-l1 ">
<a class="" href="../replies_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../replies_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../replies_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../replies_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../replies_update">Update</a>
</li>
<span>Revisions</span>
<li class="toctree-l1 ">
<a class="" href="../revisions_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../revisions_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../revisions_list">List</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Update</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-arguments">Required Scalar Arguments</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-general-properties">Optional General Properties</a></li>
</ul>
</li>
<span>Teamdrives</span>
<li class="toctree-l1 ">
<a class="" href="../teamdrives_create">Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../teamdrives_delete">Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../teamdrives_get">Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../teamdrives_list">List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../teamdrives_update">Update</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>Update</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/drive3-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Updates a revision with patch semantics.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
<ul>
<li><em>https://www.googleapis.com/auth/drive</em></li>
<li><em>https://www.googleapis.com/auth/drive.appdata</em></li>
<li><em>https://www.googleapis.com/auth/drive.file</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/drive</em>.
You can set the scope for this method like this: <code>drive3 --scope &lt;scope&gt; revisions update ...</code></p>
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
<ul>
<li><strong>&lt;file-id&gt;</strong> <em>(string)</em><ul>
<li>The ID of the file.</li>
</ul>
</li>
<li><strong>&lt;revision-id&gt;</strong> <em>(string)</em><ul>
<li>The ID of the revision.</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>Revision:
export-links: { string: string }
id: string
keep-forever: boolean
kind: string
last-modifying-user:
display-name: string
email-address: string
kind: string
me: boolean
permission-id: string
photo-link: string
md5-checksum: string
mime-type: string
modified-time: string
original-filename: string
publish-auto: boolean
published: boolean
published-link: string
published-outside-domain: boolean
size: 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 . export-links=key=erat</code><ul>
<li>Links for exporting Docs Editors files to specific formats.</li>
<li>the value will be associated with the given <code>key</code></li>
</ul>
</li>
<li><code>id=nonumy</code><ul>
<li>The ID of the revision.</li>
</ul>
</li>
<li><code>keep-forever=true</code><ul>
<li>Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file.
This field is only applicable to files with binary content in Drive.</li>
</ul>
</li>
<li><code>kind=lorem</code><ul>
<li>Identifies what kind of resource this is. Value: the fixed string &#34;drive#revision&#34;.</li>
</ul>
</li>
<li><code>last-modifying-user display-name=aliquyam</code><ul>
<li>A plain text displayable name for this user.</li>
</ul>
</li>
<li><code>email-address=diam</code><ul>
<li>The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester.</li>
</ul>
</li>
<li><code>kind=vero</code><ul>
<li>Identifies what kind of resource this is. Value: the fixed string &#34;drive#user&#34;.</li>
</ul>
</li>
<li><code>me=true</code><ul>
<li>Whether this user is the requesting user.</li>
</ul>
</li>
<li><code>permission-id=consetetur</code><ul>
<li>The user&#39;s ID as visible in Permission resources.</li>
</ul>
</li>
<li>
<p><code>photo-link=amet</code></p>
<ul>
<li>A link to the user&#39;s profile photo, if available.</li>
</ul>
</li>
<li>
<p><code>.. md5-checksum=magna</code></p>
<ul>
<li>The MD5 checksum of the revision&#39;s content. This is only applicable to files with binary content in Drive.</li>
</ul>
</li>
<li><code>mime-type=sanctus</code><ul>
<li>The MIME type of the revision.</li>
</ul>
</li>
<li><code>modified-time=clita</code><ul>
<li>The last time the revision was modified (RFC 3339 date-time).</li>
</ul>
</li>
<li><code>original-filename=invidunt</code><ul>
<li>The original filename used to create this revision. This is only applicable to files with binary content in Drive.</li>
</ul>
</li>
<li><code>publish-auto=true</code><ul>
<li>Whether subsequent revisions will be automatically republished. This is only applicable to Docs Editors files.</li>
</ul>
</li>
<li><code>published=true</code><ul>
<li>Whether this revision is published. This is only applicable to Docs Editors files.</li>
</ul>
</li>
<li><code>published-link=invidunt</code><ul>
<li>A link to the published revision. This is only populated for Google Sites files.</li>
</ul>
</li>
<li><code>published-outside-domain=false</code><ul>
<li>Whether this revision is published outside the domain. This is only applicable to Docs Editors files.</li>
</ul>
</li>
<li><code>size=et</code><ul>
<li>The size of the revision&#39;s content in bytes. This is only applicable to files with binary content in Drive.</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-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 alt=string</strong></p>
<ul>
<li>Data format for the response.</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>An opaque string that represents a user for quota purposes. Must not exceed 40 characters.</li>
</ul>
</li>
<li>
<p><strong>-p user-ip=string</strong></p>
<ul>
<li>Deprecated. Please use quotaUser instead.</li>
</ul>
</li>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../teamdrives_create" class="btn btn-neutral float-right" title="Create"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../revisions_list" class="btn btn-neutral" title="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="../revisions_list" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../teamdrives_create" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>