mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
508 lines
32 KiB
HTML
508 lines
32 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_beta3-cli/projects_locations-queues-create/" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>Locations Queues Create - 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 Create";
|
|
var mkdocs_page_input_path = "projects_locations-queues-create.md";
|
|
var mkdocs_page_url = "/google-apis-rs/google-cloudtasks2_beta3-cli/projects_locations-queues-create/";
|
|
</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">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 current"><a class="reference internal current" href="./">Locations Queues Create</a>
|
|
<ul class="current">
|
|
</ul>
|
|
</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-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>
|
|
</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 Create</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudtasks2_beta3-cli/edit/master/docs/projects_locations-queues-create.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>Creates a queue. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine <code>queue.yaml</code> or <code>queue.xml</code> file to manage your queues. Read <a href="https://cloud.google.com/tasks/docs/queue-yaml">Overview of Queue Management and queue.yaml</a> before using this method.</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-beta3 --scope <scope> projects locations-queues-create ...</code></p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><parent></strong> <em>(string)</em><ul>
|
|
<li>Required. The location name in which the queue will be created. For example: <code>projects/PROJECT_ID/locations/LOCATION_ID</code> The list of allowed locations can be obtained by calling Cloud Tasks' implementation of ListLocations.</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>Queue:
|
|
app-engine-http-queue:
|
|
app-engine-routing-override:
|
|
host: string
|
|
instance: string
|
|
service: string
|
|
version: string
|
|
http-target:
|
|
http-method: string
|
|
oauth-token:
|
|
scope: string
|
|
service-account-email: string
|
|
oidc-token:
|
|
audience: string
|
|
service-account-email: string
|
|
uri-override:
|
|
host: string
|
|
path-override:
|
|
path: string
|
|
port: string
|
|
query-override:
|
|
query-params: string
|
|
scheme: string
|
|
uri-override-enforce-mode: string
|
|
name: string
|
|
purge-time: string
|
|
rate-limits:
|
|
max-burst-size: integer
|
|
max-concurrent-dispatches: integer
|
|
max-dispatches-per-second: number
|
|
retry-config:
|
|
max-attempts: integer
|
|
max-backoff: string
|
|
max-doublings: integer
|
|
max-retry-duration: string
|
|
min-backoff: string
|
|
stackdriver-logging-config:
|
|
sampling-ratio: number
|
|
state: string
|
|
stats:
|
|
concurrent-dispatches-count: int64
|
|
effective-execution-rate: number
|
|
executed-last-minute-count: int64
|
|
oldest-estimated-arrival-time: string
|
|
tasks-count: int64
|
|
task-ttl: string
|
|
tombstone-ttl: string
|
|
type: 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 .app-engine-http-queue.app-engine-routing-override host=et</code><ul>
|
|
<li>Output only. The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see <a href="https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed">How Requests are Routed</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>instance=magna</code><ul>
|
|
<li>App instance. By default, the task is sent to an instance which is available when the task is attempted. Requests can only be sent to a specific instance if <a href="https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes">manual scaling is used in App Engine Standard</a>. App Engine Flex does not support instances. For more information, see <a href="https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed">App Engine Standard request routing</a> and <a href="https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed">App Engine Flex request routing</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>service=no</code><ul>
|
|
<li>App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>version=ipsum</code></p>
|
|
<ul>
|
|
<li>App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>...http-target http-method=voluptua.</code></p>
|
|
<ul>
|
|
<li>The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>oauth-token scope=at</code><ul>
|
|
<li>OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>service-account-email=sanctus</code></p>
|
|
<ul>
|
|
<li><a href="https://cloud.google.com/iam/docs/service-accounts">Service account email</a> to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..oidc-token audience=sed</code></p>
|
|
<ul>
|
|
<li>Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>service-account-email=amet.</code></p>
|
|
<ul>
|
|
<li><a href="https://cloud.google.com/iam/docs/service-accounts">Service account email</a> to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..uri-override host=takimata</code></p>
|
|
<ul>
|
|
<li>Host override. When specified, replaces the host part of the task URL. For example, if the task URL is "https://www.google.com," and host value is set to "example.net", the overridden URI will be changed to "https://example.net." Host value cannot be an empty string (INVALID_ARGUMENT).</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>path-override path=amet.</code></p>
|
|
<ul>
|
|
<li>The URI path (e.g., /users/1234). Default is an empty string.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. port=duo</code></p>
|
|
<ul>
|
|
<li>Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>query-override query-params=ipsum</code></p>
|
|
<ul>
|
|
<li>The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. scheme=gubergren</code></p>
|
|
<ul>
|
|
<li>Scheme override. When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS).</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>uri-override-enforce-mode=lorem</code></p>
|
|
<ul>
|
|
<li>URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>... name=gubergren</code></p>
|
|
<ul>
|
|
<li>Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: <code>projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID</code> * <code>PROJECT_ID</code> can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see <a href="https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects">Identifying projects</a> * <code>LOCATION_ID</code> is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * <code>QUEUE_ID</code> can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>purge-time=eos</code><ul>
|
|
<li>Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the <a href="https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue">App Engine Task Queue SDK, or the Cloud Console</a>. Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>rate-limits max-burst-size=97</code><ul>
|
|
<li>The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time. The <a href="https://wikipedia.org/wiki/Token_Bucket">token bucket</a> algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum specified by <code>max_burst_size</code>. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket will be continuously refilled with new tokens based on max_dispatches_per_second. The default value of <code>max_burst_size</code> is picked by Cloud Tasks based on the value of max_dispatches_per_second. The maximum value of <code>max_burst_size</code> is 500. For App Engine queues that were created or updated using <code>queue.yaml/xml</code>, <code>max_burst_size</code> is equal to <a href="https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size">bucket_size</a>. If UpdateQueue is called on a queue without explicitly setting a value for <code>max_burst_size</code>, <code>max_burst_size</code> value will get updated if UpdateQueue is updating max_dispatches_per_second. </li>
|
|
</ul>
|
|
</li>
|
|
<li><code>max-concurrent-dispatches=84</code><ul>
|
|
<li>The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same meaning as <a href="https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests">max_concurrent_requests in queue.yaml/xml</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>max-dispatches-per-second=0.8638300740145545</code></p>
|
|
<ul>
|
|
<li>The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * For App Engine queues, the maximum allowed value is 500. This field has the same meaning as <a href="https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate">rate in queue.yaml/xml</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..retry-config max-attempts=46</code></p>
|
|
<ul>
|
|
<li>Number of attempts per task. Cloud Tasks will attempt the task <code>max_attempts</code> times (that is, if the first attempt fails, then there will be <code>max_attempts - 1</code> retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as <a href="https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters">task_retry_limit in queue.yaml/xml</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>max-backoff=invidunt</code><ul>
|
|
<li>A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by <code>s</code> (for "seconds"). For more information on the format, see the documentation for <a href="https://protobuf.dev/reference/protobuf/google.protobuf/#duration">Duration</a>. <code>max_backoff</code> will be truncated to the nearest second. This field has the same meaning as <a href="https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters">max_backoff_seconds in queue.yaml/xml</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>max-doublings=54</code><ul>
|
|
<li>The time between retries will double <code>max_doublings</code> times. A task's retry interval starts at min_backoff, then doubles <code>max_doublings</code> times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and <code>max_doublings</code> is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as <a href="https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters">max_doublings in queue.yaml/xml</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>max-retry-duration=duo</code><ul>
|
|
<li>If positive, <code>max_retry_duration</code> specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once <code>max_retry_duration</code> time has passed <em>and</em> the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by <code>s</code> (for "seconds"). For the maximum possible value or the format, see the documentation for <a href="https://protobuf.dev/reference/protobuf/google.protobuf/#duration">Duration</a>. <code>max_retry_duration</code> will be truncated to the nearest second. This field has the same meaning as <a href="https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters">task_age_limit in queue.yaml/xml</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>min-backoff=ipsum</code></p>
|
|
<ul>
|
|
<li>A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified when the queue is created, Cloud Tasks will pick the default. The value must be given as a string that indicates the length of time (in seconds) followed by <code>s</code> (for "seconds"). For more information on the format, see the documentation for <a href="https://protobuf.dev/reference/protobuf/google.protobuf/#duration">Duration</a>. <code>min_backoff</code> will be truncated to the nearest second. This field has the same meaning as <a href="https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters">min_backoff_seconds in queue.yaml/xml</a>.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..stackdriver-logging-config sampling-ratio=0.9001265173058445</code></p>
|
|
<ul>
|
|
<li>Specifies the fraction of operations to write to <a href="https://cloud.google.com/logging/docs/">Stackdriver Logging</a>. This field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the default and means that no operations are logged.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. state=ut</code></p>
|
|
<ul>
|
|
<li>Output only. The state of the queue. <code>state</code> can only be changed by called PauseQueue, ResumeQueue, or uploading <a href="https://cloud.google.com/appengine/docs/python/config/queueref">queue.yaml/xml</a>. UpdateQueue cannot be used to change <code>state</code>.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>stats concurrent-dispatches-count=-12</code><ul>
|
|
<li>Output only. The number of requests that the queue has dispatched but has not received a reply for yet.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>effective-execution-rate=0.6681221451468909</code><ul>
|
|
<li>Output only. The current maximum number of tasks per second executed by the queue. The maximum value of this variable is controlled by the RateLimits of the Queue. However, this value could be less to avoid overloading the endpoints tasks in the queue are targeting.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>executed-last-minute-count=-50</code><ul>
|
|
<li>Output only. The number of tasks that the queue has dispatched and received a reply for during the last minute. This variable counts both successful and non-successful executions.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>oldest-estimated-arrival-time=ipsum</code><ul>
|
|
<li>Output only. An estimation of the nearest time in the future where a task in the queue is scheduled to be executed.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>tasks-count=-7</code></p>
|
|
<ul>
|
|
<li>Output only. An estimation of the number of tasks in the queue, that is, the tasks in the queue that haven't been executed, the tasks in the queue which the queue has dispatched but has not yet received a reply for, and the failed tasks that the queue is retrying.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. task-ttl=gubergren</code></p>
|
|
<ul>
|
|
<li>The maximum amount of time that a task will be retained in this queue. After a task has lived for <code>task_ttl</code>, the task will be deleted regardless of whether it was dispatched or not. The minimum value is 10 days. The maximum value is 10 years. The value must be given as a string that indicates the length of time (in seconds) followed by <code>s</code> (for "seconds"). For more information on the format, see the documentation for <a href="https://protobuf.dev/reference/protobuf/google.protobuf/#duration">Duration</a>. Queues created by Cloud Tasks have a default <code>task_ttl</code> of 31 days. . Queues created by queue.yaml/xml have a fixed <code>task_ttl</code> of the maximum duration, because there is a <a href="https://cloud.google.com/appengine/quotas#Task_Queue">storage quota</a> for these queues.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>tombstone-ttl=ea</code><ul>
|
|
<li>The task tombstone time to live (TTL). After a task is deleted or executed, the task's tombstone is retained for the length of time specified by <code>tombstone_ttl</code>. The tombstone is used by task de-duplication; another task with the same name can't be created until the tombstone has expired. For more information about task de-duplication, see the documentation for CreateTaskRequest. The minimum value is 1 hour. The maximum value is 9 days. The value must be given as a string that indicates the length of time (in seconds) followed by <code>s</code> (for "seconds"). For more information on the format, see the documentation for <a href="https://protobuf.dev/reference/protobuf/google.protobuf/#duration">Duration</a>. Queues created by Cloud Tasks have a default <code>tombstone_ttl</code> of 1 hour.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>type=dolor</code><ul>
|
|
<li>Immutable. The type of a queue (push or pull). <code>Queue.type</code> is an immutable property of the queue that is set at the queue creation time. When left unspecified, the default value of <code>PUSH</code> is selected.</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-list/" class="btn btn-neutral float-left" title="Locations List"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../projects_locations-queues-delete/" class="btn btn-neutral float-right" title="Locations Queues Delete">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_beta3-cli" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
|
|
</span>
|
|
|
|
|
|
<span><a href="../projects_locations-list/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../projects_locations-queues-delete/" 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>
|