Cloud Tasks API v2 - Package cloud.google.com/go/cloudtasks/apiv2 (v1.13.7)

Note: To get more information about this package, such as access to older versions, viewthis package on pkg.go.dev.

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

Manages the execution of large numbers of distributed requests.

General documentation

For information that is relevant for all client libraries please referencehttps://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on thispage includes:

Example usage

To get started with this package, create a client.

// go get cloud.google.com/go/cloudtasks/apiv2@latestctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed.The methods of Client are safe for concurrent use by multiple goroutines.The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client, mentioned above.

req:=&cloudtaskspb.CreateQueueRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb#CreateQueueRequest.}resp,err:=c.CreateQueue(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp

Use of Context

The ctx passed to NewClient is used for authentication requests andfor creating the underlying connection, but is not used for subsequent calls.Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

Functions

func DefaultAuthScopes

funcDefaultAuthScopes()[]string

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

CallOptions

typeCallOptionsstruct{ListQueues[]gax.CallOptionGetQueue[]gax.CallOptionCreateQueue[]gax.CallOptionUpdateQueue[]gax.CallOptionDeleteQueue[]gax.CallOptionPurgeQueue[]gax.CallOptionPauseQueue[]gax.CallOptionResumeQueue[]gax.CallOptionGetIamPolicy[]gax.CallOptionSetIamPolicy[]gax.CallOptionTestIamPermissions[]gax.CallOptionListTasks[]gax.CallOptionGetTask[]gax.CallOptionCreateTask[]gax.CallOptionDeleteTask[]gax.CallOptionRunTask[]gax.CallOptionGetLocation[]gax.CallOptionListLocations[]gax.CallOption}

CallOptions contains the retry settings for each method of Client.

Client

typeClientstruct{// 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.

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

func NewClient

funcNewClient(ctxcontext.Context,opts...option.ClientOption)(*Client,error)

NewClient creates a new cloud tasks client based on gRPC.The returned client must be Closed when it is done being used to clean up its underlying connections.

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

Example

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}

func NewRESTClient

funcNewRESTClient(ctxcontext.Context,opts...option.ClientOption)(*Client,error)

NewRESTClient creates a new cloud tasks rest client.

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

Example

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}

func (*Client) Close

func(c*Client)Close()error

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

func (*Client) Connection (deprecated)

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

Connection returns a connection to the API service.

Deprecated: Connections are now pooled so this method does not alwaysreturn the same resource.

func (*Client) CreateQueue

CreateQueue creates a queue.

Queues created with this method allow tasks to live for a maximum of 31days. After a task is 31 days old, the task will be deleted regardless ofwhether it was dispatched or not.

WARNING: Using this method may have unintended side effects if you areusing an App Engine queue.yaml or queue.xml file to manage your queues.ReadOverview of Queue Management andqueue.yaml (athttps://cloud.google.com/tasks/docs/queue-yaml) before usingthis method.

Example

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"cloudtaskspb"cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&cloudtaskspb.CreateQueueRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb#CreateQueueRequest.}resp,err:=c.CreateQueue(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) CreateTask

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

Example

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"cloudtaskspb"cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&cloudtaskspb.CreateTaskRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb#CreateTaskRequest.}resp,err:=c.CreateTask(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) DeleteQueue

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 createdfor 7 days.

WARNING: Using this method may have unintended side effects if you areusing an App Engine queue.yaml or queue.xml file to manage your queues.ReadOverview of Queue Management andqueue.yaml (athttps://cloud.google.com/tasks/docs/queue-yaml) before usingthis method.

Example

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"cloudtaskspb"cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&cloudtaskspb.DeleteQueueRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb#DeleteQueueRequest.}err=c.DeleteQueue(ctx,req)iferr!=nil{// TODO: Handle error.}}

func (*Client) DeleteTask

DeleteTask deletes a task.

A task can be deleted if it is scheduled or dispatched. A taskcannot be deleted if it has executed successfully or permanentlyfailed.

Example

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"cloudtaskspb"cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&cloudtaskspb.DeleteTaskRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb#DeleteTaskRequest.}err=c.DeleteTask(ctx,req)iferr!=nil{// TODO: Handle error.}}

func (*Client) GetIamPolicy

GetIamPolicy gets the access control policy for a Queue.Returns an empty policy if the resource exists and does not have a policyset.

Authorization requires the followingGoogle IAM (athttps://cloud.google.com/iam) permission on the specifiedresource parent:

cloudtasks.queues.getIamPolicy

Example

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"iampb"cloud.google.com/go/iam/apiv1/iampb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&iampb.GetIamPolicyRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#GetIamPolicyRequest.}resp,err:=c.GetIamPolicy(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) GetLocation

GetLocation gets information about a location.

Example

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"locationpb"google.golang.org/genproto/googleapis/cloud/location")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&locationpb.GetLocationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest.}resp,err:=c.GetLocation(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) GetQueue

GetQueue gets a queue.

Example

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"cloudtaskspb"cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&cloudtaskspb.GetQueueRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb#GetQueueRequest.}resp,err:=c.GetQueue(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) GetTask

GetTask gets a task.

Example

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"cloudtaskspb"cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&cloudtaskspb.GetTaskRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb#GetTaskRequest.}resp,err:=c.GetTask(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) ListLocations

ListLocations lists information about the supported locations for this service.

Examples

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2""google.golang.org/api/iterator"locationpb"google.golang.org/genproto/googleapis/cloud/location")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&locationpb.ListLocationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.}it:=c.ListLocations(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp// If you need to access the underlying RPC response,// you can do so by casting the `Response` as below.// Otherwise, remove this line. Only populated after// first call to Next(). Not safe for concurrent access._=it.Response.(*locationpb.ListLocationsResponse)}}
all
packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"locationpb"google.golang.org/genproto/googleapis/cloud/location")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&locationpb.ListLocationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.}forresp,err:=rangec.ListLocations(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}

func (*Client) ListQueues

ListQueues lists queues.

Queues are returned in lexicographical order.

Examples

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"cloudtaskspb"cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb""google.golang.org/api/iterator")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&cloudtaskspb.ListQueuesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb#ListQueuesRequest.}it:=c.ListQueues(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp// If you need to access the underlying RPC response,// you can do so by casting the `Response` as below.// Otherwise, remove this line. Only populated after// first call to Next(). Not safe for concurrent access._=it.Response.(*cloudtaskspb.ListQueuesResponse)}}
all
packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"cloudtaskspb"cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&cloudtaskspb.ListQueuesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb#ListQueuesRequest.}forresp,err:=rangec.ListQueues(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}

func (*Client) ListTasks

ListTasks lists the tasks in a queue.

By default, only the BASIC view isretrieved due to performance considerations;response_viewcontrols the subset of information which is returned.

The tasks may be returned in any order. The ordering may change at anytime.

Examples

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"cloudtaskspb"cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb""google.golang.org/api/iterator")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&cloudtaskspb.ListTasksRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb#ListTasksRequest.}it:=c.ListTasks(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp// If you need to access the underlying RPC response,// you can do so by casting the `Response` as below.// Otherwise, remove this line. Only populated after// first call to Next(). Not safe for concurrent access._=it.Response.(*cloudtaskspb.ListTasksResponse)}}
all
packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"cloudtaskspb"cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&cloudtaskspb.ListTasksRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb#ListTasksRequest.}forresp,err:=rangec.ListTasks(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}

func (*Client) PauseQueue

PauseQueue pauses the queue.

If a queue is paused then the system will stop dispatching tasksuntil the queue is resumed viaResumeQueue. Tasks canstill be added when the queue is paused. A queue is paused if itsstate isPAUSED.

Example

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"cloudtaskspb"cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&cloudtaskspb.PauseQueueRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb#PauseQueueRequest.}resp,err:=c.PauseQueue(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) PurgeQueue

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. Tasksmight be dispatched before the purge takes effect. A purge is irreversible.

Example

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"cloudtaskspb"cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&cloudtaskspb.PurgeQueueRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb#PurgeQueueRequest.}resp,err:=c.PurgeQueue(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) ResumeQueue

ResumeQueue resume a queue.

This method resumes a queue after it has beenPAUSED orDISABLED. The state of aqueue is stored in the queue’s state;after calling this method it will be set toRUNNING.

WARNING: Resuming many high-QPS queues at the same time canlead to target overloading. If you are resuming high-QPSqueues, follow the 500/50/5 pattern described inManaging Cloud Tasks ScalingRisks (athttps://cloud.google.com/tasks/docs/manage-cloud-task-scaling).

Example

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"cloudtaskspb"cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&cloudtaskspb.ResumeQueueRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb#ResumeQueueRequest.}resp,err:=c.ResumeQueue(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) RunTask

RunTask forces a task to run now.

When this method is called, Cloud Tasks will dispatch the task, even ifthe task is already running, the queue has reached itsRateLimits or isPAUSED.

This command is meant to be used for manual debugging. Forexample, RunTask can be used toretry a failed task after a fix has been made or to manually force a taskto be dispatched now.

The dispatched task is returned. That is, the task that is returnedcontains the status after the task is dispatched butbefore the task is received by its target.

If Cloud Tasks receives a successful response from the task’starget, then the task will be deleted; otherwise the task’sschedule_time will be reset tothe time that RunTask wascalled plus the retry delay specified in the queue’sRetryConfig.

RunTask returnsNOT_FOUND when it is called on atask that has already succeeded or permanently failed.

Example

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"cloudtaskspb"cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&cloudtaskspb.RunTaskRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb#RunTaskRequest.}resp,err:=c.RunTask(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) SetIamPolicy

SetIamPolicy 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 followingGoogle IAM (athttps://cloud.google.com/iam) permission on the specifiedresource parent:

cloudtasks.queues.setIamPolicy

Example

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"iampb"cloud.google.com/go/iam/apiv1/iampb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&iampb.SetIamPolicyRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#SetIamPolicyRequest.}resp,err:=c.SetIamPolicy(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) TestIamPermissions

TestIamPermissions returns permissions that a caller has on aQueue. If the resource does not exist, thiswill return an empty set of permissions, not aNOT_FOUND error.

Note: This operation is designed to be used for building permission-awareUIs and command-line tools, not for authorization checking. This operationmay “fail open” without warning.

Example

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"iampb"cloud.google.com/go/iam/apiv1/iampb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&iampb.TestIamPermissionsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#TestIamPermissionsRequest.}resp,err:=c.TestIamPermissions(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) UpdateQueue

UpdateQueue updates a queue.

This method creates the queue if it does not exist and updatesthe queue if it does exist.

Queues created with this method allow tasks to live for a maximum of 31days. After a task is 31 days old, the task will be deleted regardless ofwhether it was dispatched or not.

WARNING: Using this method may have unintended side effects if you areusing an App Engine queue.yaml or queue.xml file to manage your queues.ReadOverview of Queue Management andqueue.yaml (athttps://cloud.google.com/tasks/docs/queue-yaml) before usingthis method.

Example

packagemainimport("context"cloudtasks"cloud.google.com/go/cloudtasks/apiv2"cloudtaskspb"cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb")funcmain(){ctx:=context.Background()// This snippet has been automatically generated and should be regarded as a code template only.// It will require modifications to work:// - It may require correct/in-range values for request initialization.// - It may require specifying regional endpoints when creating the service client as shown in://   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Optionsc,err:=cloudtasks.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&cloudtaskspb.UpdateQueueRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb#UpdateQueueRequest.}resp,err:=c.UpdateQueue(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

LocationIterator

typeLocationIteratorstruct{// Response is the raw response for the current page.// It must be cast to the RPC response type.// Calling Next() or InternalFetch() updates this value.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*locationpb.Location,nextPageTokenstring,errerror)// contains filtered or unexported fields}

LocationIterator manages a stream of *locationpb.Location.

func (*LocationIterator) All

func(it*LocationIterator)All()iter.Seq2[*locationpb.Location,error]

All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.

func (*LocationIterator) Next

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

func (*LocationIterator) PageInfo

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

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

QueueIterator

typeQueueIteratorstruct{// Response is the raw response for the current page.// It must be cast to the RPC response type.// Calling Next() or InternalFetch() updates this value.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*cloudtaskspb.Queue,nextPageTokenstring,errerror)// contains filtered or unexported fields}

QueueIterator manages a stream of *cloudtaskspb.Queue.

func (*QueueIterator) All

func(it*QueueIterator)All()iter.Seq2[*cloudtaskspb.Queue,error]

All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.

func (*QueueIterator) Next

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

func (*QueueIterator) PageInfo

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

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

TaskIterator

typeTaskIteratorstruct{// Response is the raw response for the current page.// It must be cast to the RPC response type.// Calling Next() or InternalFetch() updates this value.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*cloudtaskspb.Task,nextPageTokenstring,errerror)// contains filtered or unexported fields}

TaskIterator manages a stream of *cloudtaskspb.Task.

func (*TaskIterator) All

func(it*TaskIterator)All()iter.Seq2[*cloudtaskspb.Task,error]

All returns an iterator. If an error is returned by the iterator, theiterator will stop after that iteration.

func (*TaskIterator) Next

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

func (*TaskIterator) PageInfo

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

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

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.