mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
436 lines
22 KiB
HTML
436 lines
22 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-storage1-cli/objects_bulk-restore/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Bulk Restore - storage v5.0.4+20240229</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 = "Bulk Restore";
|
|
var mkdocs_page_input_path = "objects_bulk-restore.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-storage1-cli/objects_bulk-restore/";
|
|
</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"> storage v5.0.4+20240229
|
|
</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">Anywhere Caches</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../anywhere-caches_disable/">Disable</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../anywhere-caches_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../anywhere-caches_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../anywhere-caches_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../anywhere-caches_pause/">Pause</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../anywhere-caches_resume/">Resume</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../anywhere-caches_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Bucket Access Controls</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../bucket-access-controls_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../bucket-access-controls_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../bucket-access-controls_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../bucket-access-controls_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../bucket-access-controls_patch/">Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../bucket-access-controls_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Buckets</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../buckets_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../buckets_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../buckets_get-iam-policy/">Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../buckets_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../buckets_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../buckets_lock-retention-policy/">Lock Retention Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../buckets_operations-cancel/">Operations Cancel</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../buckets_operations-get/">Operations Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../buckets_operations-list/">Operations List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../buckets_patch/">Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../buckets_set-iam-policy/">Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../buckets_test-iam-permissions/">Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../buckets_update/">Update</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">Default Object Access Controls</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../default-object-access-controls_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../default-object-access-controls_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../default-object-access-controls_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../default-object-access-controls_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../default-object-access-controls_patch/">Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../default-object-access-controls_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Folders</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../folders_rename/">Rename</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Managed Folders</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../managed-folders_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../managed-folders_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../managed-folders_get-iam-policy/">Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../managed-folders_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../managed-folders_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../managed-folders_set-iam-policy/">Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../managed-folders_test-iam-permissions/">Test Iam Permissions</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Notifications</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../notifications_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../notifications_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../notifications_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../notifications_list/">List</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Object Access Controls</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../object-access-controls_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../object-access-controls_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../object-access-controls_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../object-access-controls_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../object-access-controls_patch/">Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../object-access-controls_update/">Update</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Objects</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="./">Bulk Restore</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../objects_compose/">Compose</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../objects_copy/">Copy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../objects_delete/">Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../objects_get/">Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../objects_get-iam-policy/">Get Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../objects_insert/">Insert</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../objects_list/">List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../objects_patch/">Patch</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../objects_restore/">Restore</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../objects_rewrite/">Rewrite</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../objects_set-iam-policy/">Set Iam Policy</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../objects_test-iam-permissions/">Test Iam Permissions</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../objects_update/">Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../objects_watch-all/">Watch All</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Projects</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_hmac-keys-create/">Hmac Keys Create</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_hmac-keys-delete/">Hmac Keys Delete</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_hmac-keys-get/">Hmac Keys Get</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_hmac-keys-list/">Hmac Keys List</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_hmac-keys-update/">Hmac Keys Update</a>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../projects_service-account-get/">Service Account Get</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="..">storage v5.0.4+20240229</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> »</li>
|
|
<li>Objects »</li>
|
|
<li>Bulk Restore</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/storage1-cli/edit/master/docs/objects_bulk-restore.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>Initiates a long-running bulk restore operation on the specified bucket.</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/cloud-platform</em></li>
|
|
<li><em>https://www.googleapis.com/auth/devstorage.full_control</em></li>
|
|
<li><em>https://www.googleapis.com/auth/devstorage.read_write</em></li>
|
|
</ul>
|
|
<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>storage1 --scope <scope> objects bulk-restore ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><bucket></strong> <em>(string)</em><ul>
|
|
<li>Name of the bucket in which the object resides.</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>BulkRestoreObjectsRequest:
|
|
allow-overwrite: boolean
|
|
copy-source-acl: boolean
|
|
match-globs: [string]
|
|
soft-deleted-after-time: string
|
|
soft-deleted-before-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 . allow-overwrite=true</code><ul>
|
|
<li>If false (default), the restore will not overwrite live objects with the same name at the destination. This means some deleted objects may be skipped. If true, live objects will be overwritten resulting in a noncurrent object (if versioning is enabled). If versioning is not enabled, overwriting the object will result in a soft-deleted object. In either case, if a noncurrent object already exists with the same name, a live version can be written without issue.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>copy-source-acl=false</code><ul>
|
|
<li>If true, copies the source object's ACL; otherwise, uses the bucket's default object ACL. The default is false.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>match-globs=lorem</code><ul>
|
|
<li>Restores only the objects matching any of the specified glob(s). If this parameter is not specified, all objects will be restored within the specified time range.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>soft-deleted-after-time=stet</code><ul>
|
|
<li>Restores only the objects that were soft-deleted after this time.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>soft-deleted-before-time=duo</code><ul>
|
|
<li>Restores only the objects that were soft-deleted before this time.</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 upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "media", "multipart", "resumable").</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="../object-access-controls_update/" class="btn btn-neutral float-left" title="Update"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../objects_compose/" class="btn btn-neutral float-right" title="Compose">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
<p>Copyright © 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/storage1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../object-access-controls_update/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../objects_compose/" style="color: #fcfcfc">Next »</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>
|