go: cloud.google.com/go/cloudtasks/apiv2beta3 Index | Examples | Files

package cloudtasks

import "cloud.google.com/go/cloudtasks/apiv2beta3"

Package cloudtasks is an auto-generated package for the Cloud Tasks API.

NOTE: This package is in alpha. It is not stable, and is likely to change.

Manages the execution of large numbers of distributed requests.

Index

Examples

Package Files

cloud_tasks_client.go doc.go

func DefaultAuthScopes Uses

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

type CallOptions Uses

type CallOptions struct {
    ListQueues         []gax.CallOption
    GetQueue           []gax.CallOption
    CreateQueue        []gax.CallOption
    UpdateQueue        []gax.CallOption
    DeleteQueue        []gax.CallOption
    PurgeQueue         []gax.CallOption
    PauseQueue         []gax.CallOption
    ResumeQueue        []gax.CallOption
    GetIamPolicy       []gax.CallOption
    SetIamPolicy       []gax.CallOption
    TestIamPermissions []gax.CallOption
    ListTasks          []gax.CallOption
    GetTask            []gax.CallOption
    CreateTask         []gax.CallOption
    DeleteTask         []gax.CallOption
    RunTask            []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

type Client Uses

type Client struct {

    // The call options for this service.
    CallOptions *CallOptions
    // contains filtered or unexported fields
}

Client is a client for interacting with Cloud Tasks API.

Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func NewClient Uses

func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

NewClient creates a new cloud tasks client.

Cloud Tasks allows developers to manage the execution of background work in their applications.

Code:

ctx := context.Background()
c, err := cloudtasks.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use client.
_ = c

func (*Client) Close Uses

func (c *Client) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*Client) Connection Uses

func (c *Client) Connection() *grpc.ClientConn

Connection returns the client's connection to the API service.

func (*Client) CreateQueue Uses

func (c *Client) CreateQueue(ctx context.Context, req *taskspb.CreateQueueRequest, opts ...gax.CallOption) (*taskspb.Queue, error)

CreateQueue 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 queue.yaml or queue.xml file to manage your queues. Read Overview of Queue Management and queue.yaml (at https://cloud.google.com/tasks/docs/queue-yaml) before using this method.

Code:

ctx := context.Background()
c, err := cloudtasks.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &taskspb.CreateQueueRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.CreateQueue(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) CreateTask Uses

func (c *Client) CreateTask(ctx context.Context, req *taskspb.CreateTaskRequest, opts ...gax.CallOption) (*taskspb.Task, error)

CreateTask creates a task and adds it to a queue.

Tasks cannot be updated after creation; there is no UpdateTask command.

For [App Engine queues][google.cloud.tasks.v2beta3.AppEngineHttpQueue], the maximum task size is
100KB.

Code:

ctx := context.Background()
c, err := cloudtasks.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &taskspb.CreateTaskRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.CreateTask(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) DeleteQueue Uses

func (c *Client) DeleteQueue(ctx context.Context, req *taskspb.DeleteQueueRequest, opts ...gax.CallOption) error

DeleteQueue 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 queue.yaml or queue.xml file to manage your queues. Read Overview of Queue Management and queue.yaml (at https://cloud.google.com/tasks/docs/queue-yaml) before using this method.

Code:

ctx := context.Background()
c, err := cloudtasks.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &taskspb.DeleteQueueRequest{
    // TODO: Fill request struct fields.
}
err = c.DeleteQueue(ctx, req)
if err != nil {
    // TODO: Handle error.
}

func (*Client) DeleteTask Uses

func (c *Client) DeleteTask(ctx context.Context, req *taskspb.DeleteTaskRequest, opts ...gax.CallOption) error

DeleteTask 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.

Code:

ctx := context.Background()
c, err := cloudtasks.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &taskspb.DeleteTaskRequest{
    // TODO: Fill request struct fields.
}
err = c.DeleteTask(ctx, req)
if err != nil {
    // TODO: Handle error.
}

func (*Client) GetIamPolicy Uses

func (c *Client) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)

GetIamPolicy gets the access control policy for a [Queue][google.cloud.tasks.v2beta3.Queue]. Returns an empty policy if the resource exists and does not have a policy set.

Authorization requires the following Google IAM (at https://cloud.google.com/iam) permission on the specified resource parent:

cloudtasks.queues.getIamPolicy

Code:

ctx := context.Background()
c, err := cloudtasks.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &iampb.GetIamPolicyRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.GetIamPolicy(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) GetQueue Uses

func (c *Client) GetQueue(ctx context.Context, req *taskspb.GetQueueRequest, opts ...gax.CallOption) (*taskspb.Queue, error)

GetQueue gets a queue.

Code:

ctx := context.Background()
c, err := cloudtasks.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &taskspb.GetQueueRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.GetQueue(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) GetTask Uses

func (c *Client) GetTask(ctx context.Context, req *taskspb.GetTaskRequest, opts ...gax.CallOption) (*taskspb.Task, error)

GetTask gets a task.

Code:

ctx := context.Background()
c, err := cloudtasks.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &taskspb.GetTaskRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.GetTask(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) ListQueues Uses

func (c *Client) ListQueues(ctx context.Context, req *taskspb.ListQueuesRequest, opts ...gax.CallOption) *QueueIterator

ListQueues lists queues.

Queues are returned in lexicographical order.

Code:

ctx := context.Background()
c, err := cloudtasks.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &taskspb.ListQueuesRequest{
    // TODO: Fill request struct fields.
}
it := c.ListQueues(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp
}

func (*Client) ListTasks Uses

func (c *Client) ListTasks(ctx context.Context, req *taskspb.ListTasksRequest, opts ...gax.CallOption) *TaskIterator

ListTasks lists the tasks in a queue.

By default, only the [BASIC][google.cloud.tasks.v2beta3.Task.View.BASIC] view is retrieved due to performance considerations; [response_view][google.cloud.tasks.v2beta3.ListTasksRequest.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.

Code:

ctx := context.Background()
c, err := cloudtasks.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &taskspb.ListTasksRequest{
    // TODO: Fill request struct fields.
}
it := c.ListTasks(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp
}

func (*Client) PauseQueue Uses

func (c *Client) PauseQueue(ctx context.Context, req *taskspb.PauseQueueRequest, opts ...gax.CallOption) (*taskspb.Queue, error)

PauseQueue pauses the queue.

If a queue is paused then the system will stop dispatching tasks until the queue is resumed via [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue]. Tasks can still be added when the queue is paused. A queue is paused if its [state][google.cloud.tasks.v2beta3.Queue.state] is [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED].

Code:

ctx := context.Background()
c, err := cloudtasks.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &taskspb.PauseQueueRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.PauseQueue(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) PurgeQueue Uses

func (c *Client) PurgeQueue(ctx context.Context, req *taskspb.PurgeQueueRequest, opts ...gax.CallOption) (*taskspb.Queue, error)

PurgeQueue 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.

Code:

ctx := context.Background()
c, err := cloudtasks.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &taskspb.PurgeQueueRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.PurgeQueue(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) ResumeQueue Uses

func (c *Client) ResumeQueue(ctx context.Context, req *taskspb.ResumeQueueRequest, opts ...gax.CallOption) (*taskspb.Queue, error)

ResumeQueue resume a queue.

This method resumes a queue after it has been [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED] or [DISABLED][google.cloud.tasks.v2beta3.Queue.State.DISABLED]. The state of a queue is stored in the queue's [state][google.cloud.tasks.v2beta3.Queue.state]; after calling this method it will be set to [RUNNING][google.cloud.tasks.v2beta3.Queue.State.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 (at https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).

Code:

ctx := context.Background()
c, err := cloudtasks.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &taskspb.ResumeQueueRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.ResumeQueue(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) RunTask Uses

func (c *Client) RunTask(ctx context.Context, req *taskspb.RunTaskRequest, opts ...gax.CallOption) (*taskspb.Task, error)

RunTask 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][google.cloud.tasks.v2beta3.RateLimits] or is [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED].

This command is meant to be used for manual debugging. For example, [RunTask][google.cloud.tasks.v2beta3.CloudTasks.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][Task.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][google.cloud.tasks.v2beta3.Task.schedule_time] will be reset to the time that [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] was called plus the retry delay specified in the queue's [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig].

[RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] returns [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a task that has already succeeded or permanently failed.

Code:

ctx := context.Background()
c, err := cloudtasks.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &taskspb.RunTaskRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.RunTask(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) SetIamPolicy Uses

func (c *Client) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)

SetIamPolicy sets the access control policy for a [Queue][google.cloud.tasks.v2beta3.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 (at https://cloud.google.com/iam) permission on the specified resource parent:

cloudtasks.queues.setIamPolicy

Code:

ctx := context.Background()
c, err := cloudtasks.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &iampb.SetIamPolicyRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.SetIamPolicy(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) TestIamPermissions Uses

func (c *Client) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error)

TestIamPermissions returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta3.Queue]. If the resource does not exist, this will return an empty set of permissions, not a [NOT_FOUND][google.rpc.Code.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.

Code:

ctx := context.Background()
c, err := cloudtasks.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &iampb.TestIamPermissionsRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.TestIamPermissions(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*Client) UpdateQueue Uses

func (c *Client) UpdateQueue(ctx context.Context, req *taskspb.UpdateQueueRequest, opts ...gax.CallOption) (*taskspb.Queue, error)

UpdateQueue 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 queue.yaml or queue.xml file to manage your queues. Read Overview of Queue Management and queue.yaml (at https://cloud.google.com/tasks/docs/queue-yaml) before using this method.

Code:

ctx := context.Background()
c, err := cloudtasks.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &taskspb.UpdateQueueRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.UpdateQueue(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

type QueueIterator Uses

type QueueIterator struct {

    // InternalFetch is for use by the Google Cloud Libraries only.
    // It is not part of the stable interface of this package.
    //
    // InternalFetch returns results from a single call to the underlying RPC.
    // The number of results is no greater than pageSize.
    // If there are no more results, nextPageToken is empty and err is nil.
    InternalFetch func(pageSize int, pageToken string) (results []*taskspb.Queue, nextPageToken string, err error)
    // contains filtered or unexported fields
}

QueueIterator manages a stream of *taskspb.Queue.

func (*QueueIterator) Next Uses

func (it *QueueIterator) Next() (*taskspb.Queue, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*QueueIterator) PageInfo Uses

func (it *QueueIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type TaskIterator Uses

type TaskIterator struct {

    // InternalFetch is for use by the Google Cloud Libraries only.
    // It is not part of the stable interface of this package.
    //
    // InternalFetch returns results from a single call to the underlying RPC.
    // The number of results is no greater than pageSize.
    // If there are no more results, nextPageToken is empty and err is nil.
    InternalFetch func(pageSize int, pageToken string) (results []*taskspb.Task, nextPageToken string, err error)
    // contains filtered or unexported fields
}

TaskIterator manages a stream of *taskspb.Task.

func (*TaskIterator) Next Uses

func (it *TaskIterator) Next() (*taskspb.Task, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*TaskIterator) PageInfo Uses

func (it *TaskIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

Package cloudtasks imports 17 packages (graph) and is imported by 1 packages. Updated 2018-12-07. Refresh now. Tools for package owners.