Update documentation

This commit is contained in:
Sebastian Thiel
2024-03-05 21:06:01 +01:00
parent a20241b241
commit f4bb79d2d6
47205 changed files with 10667990 additions and 8269099 deletions

View File

@@ -1,197 +1,123 @@
<!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]-->
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Locations Queues Pause - Cloud Tasks v3.0.0+20220212</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>
<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-cloudtasks2-cli/projects_locations-queues-pause/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>Locations Queues Pause - Cloud Tasks v5.0.4+20240223</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 = "Locations Queues Pause";
var mkdocs_page_input_path = "projects_locations-queues-pause.md";
var mkdocs_page_url = "/google-apis-rs/google-cloudtasks2-cli/projects_locations-queues-pause/";
</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"> Cloud Tasks v3.0.0+20220212</a>
<a href=".." class="icon icon-home"> Cloud Tasks v5.0.4+20240223
</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="main navigation">
<ul class="current">
<span>Projects</span>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-get">Locations Get</a>
<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>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-list">Locations List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-queues-create">Locations Queues Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-queues-delete">Locations Queues Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-queues-get">Locations Queues Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-queues-get-iam-policy">Locations Queues Get Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-queues-list">Locations Queues List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-queues-patch">Locations Queues Patch</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Locations Queues Pause</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-general-properties">Optional General Properties</a></li>
</ul>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-queues-purge">Locations Queues Purge</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-queues-resume">Locations Queues Resume</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-queues-set-iam-policy">Locations Queues Set Iam Policy</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-queues-tasks-create">Locations Queues Tasks Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-queues-tasks-delete">Locations Queues Tasks Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-queues-tasks-get">Locations Queues Tasks Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-queues-tasks-list">Locations Queues Tasks List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-queues-tasks-run">Locations Queues Tasks Run</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../projects_locations-queues-test-iam-permissions">Locations Queues Test Iam Permissions</a>
</li>
</ul>
</ul>
<p class="caption"><span class="caption-text">Projects</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-get/">Locations Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-get-cmek-config/">Locations Get Cmek Config</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-list/">Locations List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-create/">Locations Queues Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-delete/">Locations Queues Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-get/">Locations Queues Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-get-iam-policy/">Locations Queues Get Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-list/">Locations Queues List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-patch/">Locations Queues Patch</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">Locations Queues Pause</a>
<ul class="current">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-purge/">Locations Queues Purge</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-resume/">Locations Queues Resume</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-set-iam-policy/">Locations Queues Set Iam Policy</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-tasks-buffer/">Locations Queues Tasks Buffer</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-tasks-create/">Locations Queues Tasks Create</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-tasks-delete/">Locations Queues Tasks Delete</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-tasks-get/">Locations Queues Tasks Get</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-tasks-list/">Locations Queues Tasks List</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-tasks-run/">Locations Queues Tasks Run</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-queues-test-iam-permissions/">Locations Queues Test Iam Permissions</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../projects_locations-update-cmek-config/">Locations Update Cmek Config</a>
</li>
</ul>
</div>
&nbsp;
</div>
</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 class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">Cloud Tasks v5.0.4+20240223</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> &raquo;</li>
<li>Locations Queues Pause</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudtasks2-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
<li><a href=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Projects &raquo;</li>
<li>Locations Queues Pause</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudtasks2-cli/edit/master/docs/projects_locations-queues-pause.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED.</p>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<p>Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED.</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>.
@@ -210,7 +136,6 @@ In the latter case it is advised to set the field-cursor to the data-structure's
<pre><code>PauseQueueRequest:
</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>
<h3 id="about-cursors">About Cursors</h3>
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
@@ -301,32 +226,24 @@ In the latter case it is advised to set the field-cursor to the data-structure's
</ul>
</li>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../projects_locations-queues-purge" class="btn btn-neutral float-right" title="Locations Queues Purge"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../projects_locations-queues-patch" class="btn btn-neutral" title="Locations Queues Patch"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../projects_locations-queues-patch/" class="btn btn-neutral float-left" title="Locations Queues Patch"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../projects_locations-queues-purge/" class="btn btn-neutral float-right" title="Locations Queues Purge">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
<p>Copyright &copy; 2015-2020, `Sebastian Thiel`</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>.
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>
@@ -334,14 +251,30 @@ In the latter case it is advised to set the field-cursor to the data-structure's
</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_locations-queues-patch" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../projects_locations-queues-purge" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
<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/cloudtasks2-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../projects_locations-queues-patch/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../projects_locations-queues-purge/" 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>
</html>