Files
google-apis-rs/google_drive3_cli/revisions_update/index.html
2024-03-05 21:06:01 +01:00

481 lines
20 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><link rel="canonical" href="http://byron.github.io/google-apis-rs/google-drive3-cli/revisions_update/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Update - drive v5.0.4+20240227</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "Update";
var mkdocs_page_input_path = "revisions_update.md";
var mkdocs_page_url = "/google-apis-rs/google-drive3-cli/revisions_update/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</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-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> drive v5.0.4+20240227
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">About</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../about_get/">Get</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Apps</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../apps_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../apps_list/">List</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Changes</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../changes_get-start-page-token/">Get Start Page Token</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../changes_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../changes_watch/">Watch</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Channels</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../channels_stop/">Stop</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Comments</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../comments_create/">Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../comments_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../comments_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../comments_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../comments_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Drives</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../drives_create/">Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../drives_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../drives_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../drives_hide/">Hide</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../drives_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../drives_unhide/">Unhide</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../drives_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Files</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../files_copy/">Copy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_create/">Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_empty-trash/">Empty Trash</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_export/">Export</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_generate-ids/">Generate Ids</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_list-labels/">List Labels</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_modify-labels/">Modify Labels</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_update/">Update</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../files_watch/">Watch</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Permissions</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../permissions_create/">Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../permissions_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../permissions_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../permissions_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../permissions_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Replies</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../replies_create/">Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../replies_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../replies_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../replies_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../replies_update/">Update</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Revisions</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../revisions_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../revisions_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../revisions_list/">List</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Update</a>
<ul class="current">
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Teamdrives</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../teamdrives_create/">Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../teamdrives_delete/">Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../teamdrives_get/">Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../teamdrives_list/">List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../teamdrives_update/">Update</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">drive v5.0.4+20240227</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=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Revisions &raquo;</li>
<li>Update</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/drive3-cli/edit/master/docs/revisions_update.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<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=ipsum</code><ul>
<li>Output only. 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=lorem</code><ul>
<li>Output only. 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=et</code><ul>
<li>Output only. Identifies what kind of resource this is. Value: the fixed string <code>&amp;#34;drive#revision&amp;#34;</code>.</li>
</ul>
</li>
<li><code>last-modifying-user display-name=et</code><ul>
<li>Output only. A plain text displayable name for this user.</li>
</ul>
</li>
<li><code>email-address=sadipscing</code><ul>
<li>Output only. 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>Output only. Identifies what kind of resource this is. Value: the fixed string <code>&amp;#34;drive#user&amp;#34;</code>.</li>
</ul>
</li>
<li><code>me=false</code><ul>
<li>Output only. Whether this user is the requesting user.</li>
</ul>
</li>
<li><code>permission-id=et</code><ul>
<li>Output only. The user&#39;s ID as visible in Permission resources.</li>
</ul>
</li>
<li>
<p><code>photo-link=sea</code></p>
<ul>
<li>Output only. A link to the user&#39;s profile photo, if available.</li>
</ul>
</li>
<li>
<p><code>.. md5-checksum=ut</code></p>
<ul>
<li>Output only. 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=et</code><ul>
<li>Output only. The MIME type of the revision.</li>
</ul>
</li>
<li><code>modified-time=sanctus</code><ul>
<li>The last time the revision was modified (RFC 3339 date-time).</li>
</ul>
</li>
<li><code>original-filename=magna</code><ul>
<li>Output only. 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=aliquyam</code><ul>
<li>Output only. A link to the published revision. This is only populated for Google Sites files.</li>
</ul>
</li>
<li><code>published-outside-domain=true</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=dolores</code><ul>
<li>Output only. 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 $-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="../revisions_list/" class="btn btn-neutral float-left" title="List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../teamdrives_create/" class="btn btn-neutral float-right" title="Create">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
<p>Copyright &copy; 2015-2020, `Sebastian Thiel`</p>
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/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" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/drive3-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../revisions_list/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../teamdrives_create/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>