Module google_cloudtasks2::api [−][src]
Structs
AppEngineHttpRequest | App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. Using AppEngineHttpRequest requires |
AppEngineRouting | App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. For more information about services, versions, and instances see An Overview of App Engine, Microservices Architecture on Google App Engine, App Engine Standard request routing, and App Engine Flex request routing. Using AppEngineRouting requires |
Attempt | The status of a task attempt. |
Binding | Associates |
CloudTasks | Central instance to access all CloudTasks related resource activities |
CreateTaskRequest | Request message for CreateTask. |
Empty | 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 |
Expr | 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. |
GetIamPolicyRequest | Request message for |
GetPolicyOptions | Encapsulates settings provided to GetIamPolicy. |
HttpRequest | HTTP request. The task will be pushed to the worker as an HTTP request. If the worker or the redirected worker acknowledges the task by returning a successful HTTP response code ([ |
ListLocationsResponse | The response message for Locations.ListLocations. |
ListQueuesResponse | Response message for ListQueues. |
ListTasksResponse | Response message for listing tasks using ListTasks. |
Location | A resource that represents Google Cloud Platform location. |
OAuthToken | Contains information needed for generating an OAuth token. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. |
OidcToken | Contains information needed for generating an OpenID Connect token. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. |
PauseQueueRequest | Request message for PauseQueue. |
Policy | An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A |
ProjectLocationGetCall | Gets information about a location. |
ProjectLocationListCall | Lists information about the supported locations for this service. |
ProjectLocationQueueCreateCall | 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 |
ProjectLocationQueueDeleteCall | 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 |
ProjectLocationQueueGetCall | Gets a queue. |
ProjectLocationQueueGetIamPolicyCall | 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 Google IAM permission on the specified resource parent: * |
ProjectLocationQueueListCall | Lists queues. Queues are returned in lexicographical order. |
ProjectLocationQueuePatchCall | 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 |
ProjectLocationQueuePauseCall | 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. |
ProjectLocationQueuePurgeCall | 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. |
ProjectLocationQueueResumeCall | 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 Managing Cloud Tasks Scaling Risks. |
ProjectLocationQueueSetIamPolicyCall | 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 Google IAM permission on the specified resource parent: * |
ProjectLocationQueueTaskCreateCall | Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * The maximum task size is 100KB. |
ProjectLocationQueueTaskDeleteCall | Deletes a task. A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has executed successfully or permanently failed. |
ProjectLocationQueueTaskGetCall | Gets a task. |
ProjectLocationQueueTaskListCall | 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. |
ProjectLocationQueueTaskRunCall | 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. |
ProjectLocationQueueTestIamPermissionCall | 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. |
ProjectMethods | A builder providing access to all methods supported on project resources.
It is not used directly, but through the |
PurgeQueueRequest | Request message for PurgeQueue. |
Queue | 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, queue types, and others. |
RateLimits | 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. |
ResumeQueueRequest | Request message for ResumeQueue. |
RetryConfig | Retry config. These settings determine when a failed task attempt is retried. |
RunTaskRequest | Request message for forcing a task to run now using RunTask. |
SetIamPolicyRequest | Request message for |
StackdriverLoggingConfig | Configuration options for writing logs to Stackdriver Logging. |
Status | The |
Task | A unit of scheduled work. |
TestIamPermissionsRequest | Request message for |
TestIamPermissionsResponse | Response message for |
Enums
Scope | Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token. |