mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-28 04:41:02 +01:00
71 lines
34 KiB
HTML
71 lines
34 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `api` mod in crate `google_cloudtasks2_beta2`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_cloudtasks2_beta2::api - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../google_cloudtasks2_beta2/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module api</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class="location"><a href="../index.html">google_cloudtasks2_beta2</a></p><div id="sidebar-vars" data-name="api" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">google_cloudtasks2_beta2</a>::<wbr><a class="mod" href="">api</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/google_cloudtasks2_beta2/api.rs.html#1-7837" title="goto source code">[src]</a></span></h1><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||
<table><tr class="module-item"><td><a class="struct" href="struct.AcknowledgeTaskRequest.html" title="google_cloudtasks2_beta2::api::AcknowledgeTaskRequest struct">AcknowledgeTaskRequest</a></td><td class="docblock-short"><p>Request message for acknowledging a task using AcknowledgeTask.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AppEngineHttpRequest.html" title="google_cloudtasks2_beta2::api::AppEngineHttpRequest struct">AppEngineHttpRequest</a></td><td class="docblock-short"><p>App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. This proto can only be used for tasks in a queue which has app_engine_http_target set. Using AppEngineHttpRequest requires <a href="https://cloud.google.com/appengine/docs/admin-api/access-control"><code>appengine.applications.get</code></a> Google IAM permission for the project and the following scope: <code>https://www.googleapis.com/auth/cloud-platform</code> The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see <a href="https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed">How Requests are Routed</a> and how routing is affected by <a href="https://cloud.google.com/appengine/docs/python/config/dispatchref">dispatch files</a>. Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The <code>url</code> that the task will be sent to is: * <code>url =</code> host <code>+</code> relative_url Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with <a href="https://cloud.google.com/appengine/docs/standard/python/config/appref"><code>login: admin</code></a>. Because tasks are not run as any user, they cannot be dispatched to URIs restricted with <a href="https://cloud.google.com/appengine/docs/standard/python/config/appref"><code>login: required</code></a> Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [<code>200</code> - <code>299</code>]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. <code>503</code> (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a <code>429</code> (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AppEngineHttpTarget.html" title="google_cloudtasks2_beta2::api::AppEngineHttpTarget struct">AppEngineHttpTarget</a></td><td class="docblock-short"><p>App Engine HTTP target. The task will be delivered to the App Engine application hostname specified by its AppEngineHttpTarget and AppEngineHttpRequest. The documentation for AppEngineHttpRequest explains how the task's host URL is constructed. Using AppEngineHttpTarget requires <a href="https://cloud.google.com/appengine/docs/admin-api/access-control"><code>appengine.applications.get</code></a> Google IAM permission for the project and the following scope: <code>https://www.googleapis.com/auth/cloud-platform</code></p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AppEngineRouting.html" title="google_cloudtasks2_beta2::api::AppEngineRouting struct">AppEngineRouting</a></td><td class="docblock-short"><p>App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. For more information about services, versions, and instances see <a href="https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine">An Overview of App Engine</a>, <a href="https://cloud.google.com/appengine/docs/python/microservices-on-app-engine">Microservices Architecture on Google App Engine</a>, <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>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AttemptStatus.html" title="google_cloudtasks2_beta2::api::AttemptStatus struct">AttemptStatus</a></td><td class="docblock-short"><p>The status of a task attempt.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Binding.html" title="google_cloudtasks2_beta2::api::Binding struct">Binding</a></td><td class="docblock-short"><p>Associates <code>members</code> with a <code>role</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CancelLeaseRequest.html" title="google_cloudtasks2_beta2::api::CancelLeaseRequest struct">CancelLeaseRequest</a></td><td class="docblock-short"><p>Request message for canceling a lease using CancelLease.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CloudTasks.html" title="google_cloudtasks2_beta2::api::CloudTasks struct">CloudTasks</a></td><td class="docblock-short"><p>Central instance to access all CloudTasks related resource activities</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CreateTaskRequest.html" title="google_cloudtasks2_beta2::api::CreateTaskRequest struct">CreateTaskRequest</a></td><td class="docblock-short"><p>Request message for CreateTask.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Empty.html" title="google_cloudtasks2_beta2::api::Empty struct">Empty</a></td><td class="docblock-short"><p>A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for <code>Empty</code> is empty JSON object <code>{}</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Expr.html" title="google_cloudtasks2_beta2::api::Expr struct">Expr</a></td><td class="docblock-short"><p>Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GetIamPolicyRequest.html" title="google_cloudtasks2_beta2::api::GetIamPolicyRequest struct">GetIamPolicyRequest</a></td><td class="docblock-short"><p>Request message for <code>GetIamPolicy</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GetPolicyOptions.html" title="google_cloudtasks2_beta2::api::GetPolicyOptions struct">GetPolicyOptions</a></td><td class="docblock-short"><p>Encapsulates settings provided to GetIamPolicy.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.LeaseTasksRequest.html" title="google_cloudtasks2_beta2::api::LeaseTasksRequest struct">LeaseTasksRequest</a></td><td class="docblock-short"><p>Request message for leasing tasks using LeaseTasks.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.LeaseTasksResponse.html" title="google_cloudtasks2_beta2::api::LeaseTasksResponse struct">LeaseTasksResponse</a></td><td class="docblock-short"><p>Response message for leasing tasks using LeaseTasks.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListLocationsResponse.html" title="google_cloudtasks2_beta2::api::ListLocationsResponse struct">ListLocationsResponse</a></td><td class="docblock-short"><p>The response message for Locations.ListLocations.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListQueuesResponse.html" title="google_cloudtasks2_beta2::api::ListQueuesResponse struct">ListQueuesResponse</a></td><td class="docblock-short"><p>Response message for ListQueues.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListTasksResponse.html" title="google_cloudtasks2_beta2::api::ListTasksResponse struct">ListTasksResponse</a></td><td class="docblock-short"><p>Response message for listing tasks using ListTasks.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Location.html" title="google_cloudtasks2_beta2::api::Location struct">Location</a></td><td class="docblock-short"><p>A resource that represents Google Cloud Platform location.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PauseQueueRequest.html" title="google_cloudtasks2_beta2::api::PauseQueueRequest struct">PauseQueueRequest</a></td><td class="docblock-short"><p>Request message for PauseQueue.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Policy.html" title="google_cloudtasks2_beta2::api::Policy struct">Policy</a></td><td class="docblock-short"><p>An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A <code>Policy</code> is a collection of <code>bindings</code>. A <code>binding</code> binds one or more <code>members</code> to a single <code>role</code>. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A <code>role</code> is a named list of permissions; each <code>role</code> can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a <code>binding</code> can also specify a <code>condition</code>, which is a logical expression that allows access to a resource only if the expression evaluates to <code>true</code>. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the <a href="https://cloud.google.com/iam/help/conditions/resource-policies">IAM documentation</a>. <strong>JSON example:</strong> { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } <strong>YAML example:</strong> bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the <a href="https://cloud.google.com/iam/docs/">IAM documentation</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationGetCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationGetCall struct">ProjectLocationGetCall</a></td><td class="docblock-short"><p>Gets information about a location.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationListCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationListCall struct">ProjectLocationListCall</a></td><td class="docblock-short"><p>Lists information about the supported locations for this service.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueueCreateCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueueCreateCall struct">ProjectLocationQueueCreateCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueueDeleteCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueueDeleteCall struct">ProjectLocationQueueDeleteCall</a></td><td class="docblock-short"><p>Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, a queue with the same name can't be created for 7 days. 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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueueGetCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueueGetCall struct">ProjectLocationQueueGetCall</a></td><td class="docblock-short"><p>Gets a queue.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueueGetIamPolicyCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueueGetIamPolicyCall struct">ProjectLocationQueueGetIamPolicyCall</a></td><td class="docblock-short"><p>Gets the access control policy for a Queue. Returns an empty policy if the resource exists and does not have a policy set. Authorization requires the following <a href="https://cloud.google.com/iam">Google IAM</a> permission on the specified resource parent: * <code>cloudtasks.queues.getIamPolicy</code></p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueueListCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueueListCall struct">ProjectLocationQueueListCall</a></td><td class="docblock-short"><p>Lists queues. Queues are returned in lexicographical order.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueuePatchCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueuePatchCall struct">ProjectLocationQueuePatchCall</a></td><td class="docblock-short"><p>Updates a queue. This method creates the queue if it does not exist and updates the queue if it does exist. 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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueuePauseCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueuePauseCall struct">ProjectLocationQueuePauseCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueuePurgeCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueuePurgeCall struct">ProjectLocationQueuePurgeCall</a></td><td class="docblock-short"><p>Purges a queue by deleting all of its tasks. All tasks created before this method is called are permanently deleted. Purge operations can take up to one minute to take effect. Tasks might be dispatched before the purge takes effect. A purge is irreversible.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueueResumeCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueueResumeCall struct">ProjectLocationQueueResumeCall</a></td><td class="docblock-short"><p>Resume a queue. This method resumes a queue after it has been PAUSED or DISABLED. The state of a queue is stored in the queue's state; after calling this method it will be set to RUNNING. WARNING: Resuming many high-QPS queues at the same time can lead to target overloading. If you are resuming high-QPS queues, follow the 500/50/5 pattern described in <a href="https://cloud.google.com/tasks/docs/manage-cloud-task-scaling">Managing Cloud Tasks Scaling Risks</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueueSetIamPolicyCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueueSetIamPolicyCall struct">ProjectLocationQueueSetIamPolicyCall</a></td><td class="docblock-short"><p>Sets the access control policy for a Queue. Replaces any existing policy. Note: The Cloud Console does not check queue-level IAM permissions yet. Project-level permissions are required to use the Cloud Console. Authorization requires the following <a href="https://cloud.google.com/iam">Google IAM</a> permission on the specified resource parent: * <code>cloudtasks.queues.setIamPolicy</code></p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueueTaskAcknowledgeCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueueTaskAcknowledgeCall struct">ProjectLocationQueueTaskAcknowledgeCall</a></td><td class="docblock-short"><p>Acknowledges a pull task. The worker, that is, the entity that leased this task must call this method to indicate that the work associated with the task has finished. The worker must acknowledge a task within the lease_duration or the lease will expire and the task will become available to be leased again. After the task is acknowledged, it will not be returned by a later LeaseTasks, GetTask, or ListTasks.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueueTaskCancelLeaseCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueueTaskCancelLeaseCall struct">ProjectLocationQueueTaskCancelLeaseCall</a></td><td class="docblock-short"><p>Cancel a pull task's lease. The worker can use this method to cancel a task's lease by setting its schedule_time to now. This will make the task available to be leased to the next caller of LeaseTasks.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueueTaskCreateCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueueTaskCreateCall struct">ProjectLocationQueueTaskCreateCall</a></td><td class="docblock-short"><p>Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * For App Engine queues, the maximum task size is 100KB. * For pull queues, the maximum task size is 1MB.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueueTaskDeleteCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueueTaskDeleteCall struct">ProjectLocationQueueTaskDeleteCall</a></td><td class="docblock-short"><p>Deletes a task. A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has completed successfully or permanently failed.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueueTaskGetCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueueTaskGetCall struct">ProjectLocationQueueTaskGetCall</a></td><td class="docblock-short"><p>Gets a task.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueueTaskLeaseCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueueTaskLeaseCall struct">ProjectLocationQueueTaskLeaseCall</a></td><td class="docblock-short"><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>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueueTaskListCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueueTaskListCall struct">ProjectLocationQueueTaskListCall</a></td><td class="docblock-short"><p>Lists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned. The tasks may be returned in any order. The ordering may change at any time.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueueTaskRenewLeaseCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueueTaskRenewLeaseCall struct">ProjectLocationQueueTaskRenewLeaseCall</a></td><td class="docblock-short"><p>Renew the current lease of a pull task. The worker can use this method to extend the lease by a new duration, starting from now. The new task lease will be returned in the task's schedule_time.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueueTaskRunCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueueTaskRunCall struct">ProjectLocationQueueTaskRunCall</a></td><td class="docblock-short"><p>Forces a task to run now. When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED. This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now. The dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target. If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig. RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed. RunTask cannot be called on a pull task.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationQueueTestIamPermissionCall.html" title="google_cloudtasks2_beta2::api::ProjectLocationQueueTestIamPermissionCall struct">ProjectLocationQueueTestIamPermissionCall</a></td><td class="docblock-short"><p>Returns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMethods.html" title="google_cloudtasks2_beta2::api::ProjectMethods struct">ProjectMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>project</em> resources.
|
||
It is not used directly, but through the <code>CloudTasks</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PullMessage.html" title="google_cloudtasks2_beta2::api::PullMessage struct">PullMessage</a></td><td class="docblock-short"><p>The pull message contains data that can be used by the caller of LeaseTasks to process the task. This proto can only be used for tasks in a queue which has pull_target set.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PullTarget.html" title="google_cloudtasks2_beta2::api::PullTarget struct">PullTarget</a></td><td class="docblock-short"><p>Pull target.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PurgeQueueRequest.html" title="google_cloudtasks2_beta2::api::PurgeQueueRequest struct">PurgeQueueRequest</a></td><td class="docblock-short"><p>Request message for PurgeQueue.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Queue.html" title="google_cloudtasks2_beta2::api::Queue struct">Queue</a></td><td class="docblock-short"><p>A queue is a container of related tasks. Queues are configured to manage how those tasks are dispatched. Configurable properties include rate limits, retry options, target types, and others.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.QueueStats.html" title="google_cloudtasks2_beta2::api::QueueStats struct">QueueStats</a></td><td class="docblock-short"><p>Statistics for a queue.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RateLimits.html" title="google_cloudtasks2_beta2::api::RateLimits struct">RateLimits</a></td><td class="docblock-short"><p>Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RenewLeaseRequest.html" title="google_cloudtasks2_beta2::api::RenewLeaseRequest struct">RenewLeaseRequest</a></td><td class="docblock-short"><p>Request message for renewing a lease using RenewLease.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ResumeQueueRequest.html" title="google_cloudtasks2_beta2::api::ResumeQueueRequest struct">ResumeQueueRequest</a></td><td class="docblock-short"><p>Request message for ResumeQueue.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RetryConfig.html" title="google_cloudtasks2_beta2::api::RetryConfig struct">RetryConfig</a></td><td class="docblock-short"><p>Retry config. These settings determine how a failed task attempt is retried.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RunTaskRequest.html" title="google_cloudtasks2_beta2::api::RunTaskRequest struct">RunTaskRequest</a></td><td class="docblock-short"><p>Request message for forcing a task to run now using RunTask.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SetIamPolicyRequest.html" title="google_cloudtasks2_beta2::api::SetIamPolicyRequest struct">SetIamPolicyRequest</a></td><td class="docblock-short"><p>Request message for <code>SetIamPolicy</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Status.html" title="google_cloudtasks2_beta2::api::Status struct">Status</a></td><td class="docblock-short"><p>The <code>Status</code> type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by <a href="https://github.com/grpc">gRPC</a>. Each <code>Status</code> message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the <a href="https://cloud.google.com/apis/design/errors">API Design Guide</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Task.html" title="google_cloudtasks2_beta2::api::Task struct">Task</a></td><td class="docblock-short"><p>A unit of scheduled work.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TaskStatus.html" title="google_cloudtasks2_beta2::api::TaskStatus struct">TaskStatus</a></td><td class="docblock-short"><p>Status of the task.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TestIamPermissionsRequest.html" title="google_cloudtasks2_beta2::api::TestIamPermissionsRequest struct">TestIamPermissionsRequest</a></td><td class="docblock-short"><p>Request message for <code>TestIamPermissions</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TestIamPermissionsResponse.html" title="google_cloudtasks2_beta2::api::TestIamPermissionsResponse struct">TestIamPermissionsResponse</a></td><td class="docblock-short"><p>Response message for <code>TestIamPermissions</code> method.</p>
|
||
</td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
|
||
<table><tr class="module-item"><td><a class="enum" href="enum.Scope.html" title="google_cloudtasks2_beta2::api::Scope enum">Scope</a></td><td class="docblock-short"><p>Identifies the an OAuth2 authorization scope.
|
||
A scope is needed when requesting an
|
||
<a href="https://developers.google.com/youtube/v3/guides/authentication">authorization token</a>.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="google_cloudtasks2_beta2"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |