mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-29 13:22:37 +01:00
316 lines
17 KiB
HTML
316 lines
17 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-cloudtasks2_beta2-cli/projects_locations-queues-tasks-lease/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Locations Queues Tasks Lease - 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 Tasks Lease";
|
|
var mkdocs_page_input_path = "projects_locations-queues-tasks-lease.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-cloudtasks2_beta2-cli/projects_locations-queues-tasks-lease/";
|
|
</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 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="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<p class="caption"><span class="caption-text">Api</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../api_queue-update/">Queue Update</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_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"><a class="reference internal" href="../projects_locations-queues-pause/">Locations Queues Pause</a>
|
|
</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-acknowledge/">Locations Queues Tasks Acknowledge</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-cancel-lease/">Locations Queues Tasks Cancel Lease</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 current"><a class="reference internal current" href="./">Locations Queues Tasks Lease</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</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-renew-lease/">Locations Queues Tasks Renew Lease</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>
|
|
</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="..">Cloud Tasks v5.0.4+20240223</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>Projects »</li>
|
|
<li>Locations Queues Tasks Lease</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudtasks2_beta2-cli/edit/master/docs/projects_locations-queues-tasks-lease.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>Leases tasks from a pull queue for lease_duration. This method is invoked by the worker to obtain a lease. The worker must acknowledge the task via AcknowledgeTask after they have performed the work associated with the task. The payload is intended to store data that the worker needs to perform the work associated with the task. To return the payloads in the response, set response_view to FULL. A maximum of 10 qps of LeaseTasks requests are allowed per queue. RESOURCE_EXHAUSTED is returned when this limit is exceeded. RESOURCE_EXHAUSTED is also returned when max_tasks_dispatched_per_second is exceeded.</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>.
|
|
You can set the scope for this method like this: <code>cloudtasks2-beta2 --scope <scope> projects locations-queues-tasks-lease ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><parent></strong> <em>(string)</em><ul>
|
|
<li>Required. The queue name. For example: <code>projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID</code></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>LeaseTasksRequest:
|
|
filter: string
|
|
lease-duration: string
|
|
max-tasks: integer
|
|
response-view: 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 . filter=sed</code><ul>
|
|
<li><code>filter</code> can be used to specify a subset of tasks to lease. When <code>filter</code> is set to <code>tag=</code> then the response will contain only tasks whose tag is equal to <code>.</code> must be less than 500 characters. When <code>filter</code> is set to <code>tag_function=oldest_tag()</code>, only tasks which have the same tag as the task with the oldest schedule_time will be returned. Grammar Syntax: * <code>filter = &#34;tag=&#34; tag | &#34;tag_function=&#34; function</code> * <code>tag = string</code> * <code>function = &#34;oldest_tag()&#34;</code> The <code>oldest_tag()</code> function returns tasks which have the same tag as the oldest task (ordered by schedule time). SDK compatibility: Although the SDK allows tags to be either string or <a href="https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-">bytes</a>, only UTF-8 encoded tags can be used in Cloud Tasks. Tag which aren't UTF-8 encoded can't be used in the filter and the task's tag will be displayed as empty in Cloud Tasks.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>lease-duration=no</code><ul>
|
|
<li>Required. The duration of the lease. Each task returned in the response will have its schedule_time set to the current time plus the <code>lease_duration</code>. The task is leased until its schedule_time; thus, the task will not be returned to another LeaseTasks call before its schedule_time. After the worker has successfully finished the work associated with the task, the worker must call via AcknowledgeTask before the schedule_time. Otherwise the task will be returned to a later LeaseTasks call so that another worker can retry it. The maximum lease duration is 1 week. <code>lease_duration</code> will be truncated to the nearest second.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>max-tasks=16</code><ul>
|
|
<li>The maximum number of tasks to lease. The system will make a best effort to return as close to as <code>max_tasks</code> as possible. The largest that <code>max_tasks</code> can be is 1000. The maximum total size of a lease tasks response is 32 MB. If the sum of all task sizes requested reaches this limit, fewer tasks than requested are returned.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>response-view=elitr</code><ul>
|
|
<li>The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL requires <code>cloudtasks.tasks.fullView</code> <a href="https://cloud.google.com/iam/">Google IAM</a> permission on the Task resource.</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. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../projects_locations-queues-tasks-get/" class="btn btn-neutral float-left" title="Locations Queues Tasks Get"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_locations-queues-tasks-list/" class="btn btn-neutral float-right" title="Locations Queues Tasks List">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/cloudtasks2_beta2-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_locations-queues-tasks-get/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_locations-queues-tasks-list/" 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>
|