Files
google-apis-rs/google_datastore1_cli/projects_indexes-delete/index.html
2024-03-05 21:06:01 +01:00

267 lines
11 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-datastore1-cli/projects_indexes-delete/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Indexes Delete - datastore v5.0.4+20240226</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 = "Indexes Delete";
var mkdocs_page_input_path = "projects_indexes-delete.md";
var mkdocs_page_url = "/google-apis-rs/google-datastore1-cli/projects_indexes-delete/";
</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"> datastore v5.0.4+20240226
</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">Projects</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../projects_allocate-ids/">Allocate Ids</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_begin-transaction/">Begin Transaction</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_commit/">Commit</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_export/">Export</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_import/">Import</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_indexes-create/">Indexes Create</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Indexes Delete</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_indexes-get/">Indexes Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_indexes-list/">Indexes List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_lookup/">Lookup</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_operations-cancel/">Operations Cancel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_operations-delete/">Operations Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_operations-get/">Operations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_operations-list/">Operations List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_reserve-ids/">Reserve Ids</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_rollback/">Rollback</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_run-aggregation-query/">Run Aggregation Query</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_run-query/">Run Query</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="..">datastore v5.0.4+20240226</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>Projects &raquo;</li>
<li>Indexes Delete</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/datastore1-cli/edit/master/docs/projects_indexes-delete.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>Deletes an existing index. An index can only be deleted if it is in a <code>READY</code> or <code>ERROR</code> state. On successful execution of the request, the index will be in a <code>DELETING</code> state. And on completion of the returned google.longrunning.Operation, the index will be removed. During index deletion, the process could result in an error, in which case the index will move to the <code>ERROR</code> state. The process can be recovered by fixing the data that caused the error, followed by calling delete again.</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/datastore</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>datastore1 --scope &lt;scope&gt; projects indexes-delete ...</code></p>
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
<ul>
<li><strong>&lt;project-id&gt;</strong> <em>(string)</em><ul>
<li>Project ID against which to make the request.</li>
</ul>
</li>
<li><strong>&lt;index-id&gt;</strong> <em>(string)</em><ul>
<li>The resource ID of the index to delete.</li>
</ul>
</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="../projects_indexes-create/" class="btn btn-neutral float-left" title="Indexes Create"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_indexes-get/" class="btn btn-neutral float-right" title="Indexes Get">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/datastore1-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../projects_indexes-create/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_indexes-get/" 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>