cloudtasks

package
v0.0.0-...-3abc09e Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 23, 2024 License: Apache-2.0 Imports: 2 Imported by: 22

Documentation

Overview

Package cloudtasks aliases all exported identifiers in package "cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb".

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb. Please read https://github.com/googleapis/google-cloud-go/blob/main/migration.md for more details.

Index

Constants

View Source 
const (
	HttpMethod_DELETE                  = src.HttpMethod_DELETE
	HttpMethod_GET                     = src.HttpMethod_GET
	HttpMethod_HEAD                    = src.HttpMethod_HEAD
	HttpMethod_HTTP_METHOD_UNSPECIFIED = src.HttpMethod_HTTP_METHOD_UNSPECIFIED
	HttpMethod_POST                    = src.HttpMethod_POST
	HttpMethod_PUT                     = src.HttpMethod_PUT
	Queue_DISABLED                     = src.Queue_DISABLED
	Queue_PAUSED                       = src.Queue_PAUSED
	Queue_RUNNING                      = src.Queue_RUNNING
	Queue_STATE_UNSPECIFIED            = src.Queue_STATE_UNSPECIFIED
	Task_BASIC                         = src.Task_BASIC
	Task_FULL                          = src.Task_FULL
	Task_VIEW_UNSPECIFIED              = src.Task_VIEW_UNSPECIFIED
)

Deprecated: Please use consts in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

Variables

View Source 
var (
	File_google_cloud_tasks_v2beta2_cloudtasks_proto = src.File_google_cloud_tasks_v2beta2_cloudtasks_proto
	File_google_cloud_tasks_v2beta2_queue_proto      = src.File_google_cloud_tasks_v2beta2_queue_proto
	File_google_cloud_tasks_v2beta2_target_proto     = src.File_google_cloud_tasks_v2beta2_target_proto
	File_google_cloud_tasks_v2beta2_task_proto       = src.File_google_cloud_tasks_v2beta2_task_proto
	HttpMethod_name                                  = src.HttpMethod_name
	HttpMethod_value                                 = src.HttpMethod_value
	Queue_State_name                                 = src.Queue_State_name
	Queue_State_value                                = src.Queue_State_value
	Task_View_name                                   = src.Task_View_name
	Task_View_value                                  = src.Task_View_value
)

Deprecated: Please use vars in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

Functions

func RegisterCloudTasksServer deprecated 

func RegisterCloudTasksServer(s *grpc.Server, srv CloudTasksServer)

Deprecated: Please use funcs in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

Types

type AcknowledgeTaskRequest deprecated 

type AcknowledgeTaskRequest = src.AcknowledgeTaskRequest

Request message for acknowledging a task using [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type AppEngineHttpRequest deprecated 

type AppEngineHttpRequest = src.AppEngineHttpRequest

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][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] set. Using AppEngineHttpRequest[google.cloud.tasks.v2beta2.AppEngineHttpRequest] requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). 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[google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.AppEngineHttpTarget.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][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing]. The `url` that the task will be sent to is: - `url =` [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] `+` [relative_url][google.cloud.tasks.v2beta2.AppEngineHttpRequest.relative_url] Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) 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 [`200` - `299`]. 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][Task.dispatch_deadline]. Failed tasks will be retried according to the [retry configuration][google.cloud.tasks.v2beta2.Queue.retry_config]. `503` (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 `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue.

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type AppEngineHttpTarget deprecated 

type AppEngineHttpTarget = src.AppEngineHttpTarget

App Engine HTTP target. The task will be delivered to the App Engine application hostname specified by its AppEngineHttpTarget[google.cloud.tasks.v2beta2.AppEngineHttpTarget] and AppEngineHttpRequest[google.cloud.tasks.v2beta2.AppEngineHttpRequest]. The documentation for AppEngineHttpRequest[google.cloud.tasks.v2beta2.AppEngineHttpRequest] explains how the task's host URL is constructed. Using AppEngineHttpTarget[google.cloud.tasks.v2beta2.AppEngineHttpTarget] requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform`

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type AppEngineRouting deprecated 

type AppEngineRouting = src.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](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type AttemptStatus deprecated 

type AttemptStatus = src.AttemptStatus

The status of a task attempt.

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type CancelLeaseRequest deprecated 

type CancelLeaseRequest = src.CancelLeaseRequest

Request message for canceling a lease using [CancelLease][google.cloud.tasks.v2beta2.CloudTasks.CancelLease].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type CloudTasksClient deprecated 

type CloudTasksClient = src.CloudTasksClient

CloudTasksClient is the client API for CloudTasks service. For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

func NewCloudTasksClient deprecated 

func NewCloudTasksClient(cc grpc.ClientConnInterface) CloudTasksClient

Deprecated: Please use funcs in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type CloudTasksServer deprecated 

type CloudTasksServer = src.CloudTasksServer

CloudTasksServer is the server API for CloudTasks service.

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type CreateQueueRequest deprecated 

type CreateQueueRequest = src.CreateQueueRequest

Request message for [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type CreateTaskRequest deprecated 

type CreateTaskRequest = src.CreateTaskRequest

Request message for [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type DeleteQueueRequest deprecated 

type DeleteQueueRequest = src.DeleteQueueRequest

Request message for [DeleteQueue][google.cloud.tasks.v2beta2.CloudTasks.DeleteQueue].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type DeleteTaskRequest deprecated 

type DeleteTaskRequest = src.DeleteTaskRequest

Request message for deleting a task using [DeleteTask][google.cloud.tasks.v2beta2.CloudTasks.DeleteTask].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type GetQueueRequest deprecated 

type GetQueueRequest = src.GetQueueRequest

Request message for [GetQueue][google.cloud.tasks.v2beta2.CloudTasks.GetQueue].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type GetTaskRequest deprecated 

type GetTaskRequest = src.GetTaskRequest

Request message for getting a task using [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type HttpMethod deprecated 

type HttpMethod = src.HttpMethod

The HTTP method used to execute the task.

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type LeaseTasksRequest deprecated 

type LeaseTasksRequest = src.LeaseTasksRequest

Request message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type LeaseTasksResponse deprecated 

type LeaseTasksResponse = src.LeaseTasksResponse

Response message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type ListQueuesRequest deprecated 

type ListQueuesRequest = src.ListQueuesRequest

Request message for [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type ListQueuesResponse deprecated 

type ListQueuesResponse = src.ListQueuesResponse

Response message for [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type ListTasksRequest deprecated 

type ListTasksRequest = src.ListTasksRequest

Request message for listing tasks using [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type ListTasksResponse deprecated 

type ListTasksResponse = src.ListTasksResponse

Response message for listing tasks using [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type PauseQueueRequest deprecated 

type PauseQueueRequest = src.PauseQueueRequest

Request message for [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type PullMessage deprecated 

type PullMessage = src.PullMessage

The pull message contains data that can be used by the caller of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task. This proto can only be used for tasks in a queue which has [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] set.

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type PullTarget deprecated 

type PullTarget = src.PullTarget

Pull target.

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type PurgeQueueRequest deprecated 

type PurgeQueueRequest = src.PurgeQueueRequest

Request message for [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type Queue deprecated 

type Queue = src.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, target types, and others.

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type QueueStats deprecated 

type QueueStats = src.QueueStats

Statistics for a queue.

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type Queue_AppEngineHttpTarget 

type Queue_AppEngineHttpTarget = src.Queue_AppEngineHttpTarget

type Queue_PullTarget 

type Queue_PullTarget = src.Queue_PullTarget

type Queue_State deprecated 

type Queue_State = src.Queue_State

State of the queue.

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type RateLimits deprecated 

type RateLimits = src.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][google.cloud.tasks.v2beta2.CloudTasks.RunTask], will run a task even if the queue has reached its RateLimits[google.cloud.tasks.v2beta2.RateLimits].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type RenewLeaseRequest deprecated 

type RenewLeaseRequest = src.RenewLeaseRequest

Request message for renewing a lease using [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type ResumeQueueRequest deprecated 

type ResumeQueueRequest = src.ResumeQueueRequest

Request message for [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type RetryConfig deprecated 

type RetryConfig = src.RetryConfig

Retry config. These settings determine how a failed task attempt is retried.

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type RetryConfig_MaxAttempts 

type RetryConfig_MaxAttempts = src.RetryConfig_MaxAttempts

type RetryConfig_UnlimitedAttempts 

type RetryConfig_UnlimitedAttempts = src.RetryConfig_UnlimitedAttempts

type RunTaskRequest deprecated 

type RunTaskRequest = src.RunTaskRequest

Request message for forcing a task to run now using [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type Task deprecated 

type Task = src.Task

A unit of scheduled work.

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type TaskStatus deprecated 

type TaskStatus = src.TaskStatus

Status of the task.

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type Task_AppEngineHttpRequest 

type Task_AppEngineHttpRequest = src.Task_AppEngineHttpRequest

type Task_PullMessage 

type Task_PullMessage = src.Task_PullMessage

type Task_View deprecated 

type Task_View = src.Task_View

The view specifies a subset of Task[google.cloud.tasks.v2beta2.Task] data. When a task is returned in a response, 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.

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type UnimplementedCloudTasksServer deprecated 

type UnimplementedCloudTasksServer = src.UnimplementedCloudTasksServer

UnimplementedCloudTasksServer can be embedded to have forward compatible implementations.

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

type UpdateQueueRequest deprecated 

type UpdateQueueRequest = src.UpdateQueueRequest

Request message for [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue].

Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.