Package: cloud.google.com/go/cloudtasks/apiv2

package cloudtasks Import Path cloud.google.com/go/cloudtasks/apiv2 (on go.dev) Dependency Relation imports 20 packages, and imported by one package Involved Source Files cloud_tasks_client.go d➜ doc.go Package cloudtasks is an auto-generated package for the Cloud Tasks API. Manages the execution of large numbers of distributed requests. Use of Context The ctx passed to NewClient is used for authentication requests and for 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. For information about setting deadlines, reusing contexts, and more please visit pkg.go.dev/cloud.google.com/go. Package-Level Type Names (total 6, in which 4 are exported) /* sort exporteds by: alphabet | popularity */ type CallOptions (struct) CallOptions contains the retry settings for each method of Client. Fields (total 16, all are exported) CreateQueue []gax.CallOption CreateTask []gax.CallOption DeleteQueue []gax.CallOption DeleteTask []gax.CallOption GetIamPolicy []gax.CallOption GetQueue []gax.CallOption GetTask []gax.CallOption ListQueues []gax.CallOption ListTasks []gax.CallOption PauseQueue []gax.CallOption PurgeQueue []gax.CallOption ResumeQueue []gax.CallOption RunTask []gax.CallOption SetIamPolicy []gax.CallOption TestIamPermissions []gax.CallOption UpdateQueue []gax.CallOption As Outputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func defaultCallOptions() *CallOptions type Client (struct) 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. Fields (total 5, in which 1 are exported) CallOptions *CallOptions The call options for this service. /* 4 unexporteds ... *//* 4 unexporteds: */ client taskspb.CloudTasksClient The gRPC API client. connPool gtransport.ConnPool Connection pool of gRPC connections to the service. disableDeadlines bool flag to opt out of default deadlines via GOOGLE_API_GO_EXPERIMENTAL_DISABLE_DEFAULT_DEADLINE xGoogMetadata metadata.MD The x-goog-* metadata to be sent with each request. Methods (total 19, in which 18 are exported) (*T) Close() error Close closes the connection to the API service. The user should invoke this when the client is no longer required. (*T) Connection() *grpc.ClientConn Connection returns a connection to the API service. Deprecated. (*T) 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. (*T) 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. The maximum task size is 100KB. (*T) 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. (*T) 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. (*T) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error) GetIamPolicy 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 (at https://cloud.google.com/iam) permission on the specified resource parent: cloudtasks.queues.getIamPolicy (*T) GetQueue(ctx context.Context, req *taskspb.GetQueueRequest, opts ...gax.CallOption) (*taskspb.Queue, error) GetQueue gets a queue. (*T) GetTask(ctx context.Context, req *taskspb.GetTaskRequest, opts ...gax.CallOption) (*taskspb.Task, error) GetTask gets a task. (*T) ListQueues(ctx context.Context, req *taskspb.ListQueuesRequest, opts ...gax.CallOption) *QueueIterator ListQueues lists queues. Queues are returned in lexicographical order. (*T) ListTasks(ctx context.Context, req *taskspb.ListTasksRequest, opts ...gax.CallOption) *TaskIterator ListTasks 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. (*T) 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. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED. (*T) 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. (*T) 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 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 (at https://cloud.google.com/tasks/docs/manage-cloud-task-scaling). (*T) 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 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. (*T) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error) 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 following Google IAM (at https://cloud.google.com/iam) permission on the specified resource parent: cloudtasks.queues.setIamPolicy (*T) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error) TestIamPermissions 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. (*T) 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. /* one unexported ... *//* one unexported: */ (*T) setGoogleClientInfo(keyval ...string) setGoogleClientInfo sets the name and version of the application in the `x-goog-api-client` header passed on each request. Intended for use by Google-written clients. Implements (at least one exported) *T : io.Closer As Outputs Of (at least one exported) func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error) As Inputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func golang.org/x/pkgsite/internal/queue.newGCP(cfg *config.Config, client *Client, queueID string) (_ *queue.GCP, err error) type QueueIterator (struct) QueueIterator manages a stream of *taskspb.Queue. Fields (total 5, in which 2 are exported) InternalFetch func(pageSize int, pageToken string) (results []*taskspb.Queue, nextPageToken string, err error) 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. Response interface{} 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. /* 3 unexporteds ... *//* 3 unexporteds: */ items []*taskspb.Queue nextFunc func() error pageInfo *iterator.PageInfo Methods (total 4, in which 2 are exported) (*T) 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. (*T) PageInfo() *iterator.PageInfo PageInfo supports pagination. See the google.golang.org/api/iterator package for details. /* 2 unexporteds ... *//* 2 unexporteds: */ (*T) bufLen() int (*T) takeBuf() interface{} Implements (at least one exported) *T : google.golang.org/api/iterator.Pageable As Outputs Of (at least one exported) func (*Client).ListQueues(ctx context.Context, req *taskspb.ListQueuesRequest, opts ...gax.CallOption) *QueueIterator type TaskIterator (struct) TaskIterator manages a stream of *taskspb.Task. Fields (total 5, in which 2 are exported) InternalFetch func(pageSize int, pageToken string) (results []*taskspb.Task, nextPageToken string, err error) 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. Response interface{} 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. /* 3 unexporteds ... *//* 3 unexporteds: */ items []*taskspb.Task nextFunc func() error pageInfo *iterator.PageInfo Methods (total 4, in which 2 are exported) (*T) 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. (*T) PageInfo() *iterator.PageInfo PageInfo supports pagination. See the google.golang.org/api/iterator package for details. /* 2 unexporteds ... *//* 2 unexporteds: */ (*T) bufLen() int (*T) takeBuf() interface{} Implements (at least one exported) *T : google.golang.org/api/iterator.Pageable As Outputs Of (at least one exported) func (*Client).ListTasks(ctx context.Context, req *taskspb.ListTasksRequest, opts ...gax.CallOption) *TaskIterator /* 2 unexporteds ... *//* 2 unexporteds: */ type clientHook (func) As Types Of (only one, which is unexported) /* one unexported ... *//* one unexported: */ var newClientHook type clientHookParams (struct) For more information on implementing a client constructor hook, see https://github.com/googleapis/google-cloud-go/wiki/Customizing-constructors. Package-Level Functions (total 7, in which 2 are exported) func DefaultAuthScopes() []string DefaultAuthScopes reports the default set of authentication scopes to use with this package. 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. /* 5 unexporteds ... *//* 5 unexporteds: */ func checkDisableDeadlines() (bool, error) func defaultCallOptions() *CallOptions func defaultClientOptions() []option.ClientOption func insertMetadata(ctx context.Context, mds ...metadata.MD) context.Context func versionGo() string versionGo returns the Go runtime version. The returned string has no whitespace, suitable for reporting in header. Package-Level Variables (only one, which is unexported) /* one unexported ... *//* one unexported: */ var newClientHook clientHook Package-Level Constants (only one, which is unexported) /* one unexported ... *//* one unexported: */ const versionClient = "20200912"

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64) Golds is a Go 101 project developed by Tapir Liu. PR and bug reports are welcome and can be submitted to the issue list. Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.