cloudtasks

package
v0.0.0-...-0b0e2e0 Latest Latest
Warning

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

 Go to latest Published: Nov 8, 2017 License: BSD-3-Clause Imports: 13 Imported by: 0

Documentation

Overview

Package cloudtasks provides access to the Cloud Tasks API.

See https://cloud.google.com/cloud-tasks/

Usage example: 

import "google.golang.org/api/cloudtasks/v2beta2"
...
cloudtasksService, err := cloudtasks.New(oauthHttpClient)

Index

Constants

View Source 
const (
	// View and manage your data across Google Cloud Platform services
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AcknowledgeTaskRequest 

type AcknowledgeTaskRequest struct {
	// ScheduleTime: Required.
	//
	// The task's current schedule time, available in the
	// Task.schedule_time
	// returned in PullTasksResponse.tasks or
	// CloudTasks.RenewLease. This restriction is to check that
	// the caller is acknowledging the correct task.
	ScheduleTime string `json:"scheduleTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ScheduleTime") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ScheduleTime") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AcknowledgeTaskRequest: Request message for acknowledging a task using CloudTasks.AcknowledgeTask.

func (*AcknowledgeTaskRequest) MarshalJSON 

func (s *AcknowledgeTaskRequest) MarshalJSON() ([]byte, error)

type AppEngineHttpRequest 

type AppEngineHttpRequest struct {
	// AppEngineRouting: Task-level setting for App Engine routing.
	//
	// If set, 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.
	AppEngineRouting *AppEngineRouting `json:"appEngineRouting,omitempty"`

	// Headers: HTTP request headers.
	//
	// This map contains the header field names and values.
	// Headers can be set when the
	// [task is
	// created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).
	// Repeated headers are not supported but a header value can contain
	// commas.
	//
	// Cloud Tasks sets some headers to default values:
	//
	// * `User-Agent`: By default, this header is
	//   "AppEngine-Google; (+http://code.google.com/appengine)".
	//   This header can be modified, but Cloud Tasks will append
	//   "AppEngine-Google; (+http://code.google.com/appengine)" to the
	//   modified `User-Agent`.
	//
	// If the task has an AppEngineHttpRequest.payload, Cloud Tasks sets
	// the
	// following headers:
	//
	// * `Content-Type`: By default, the `Content-Type` header is set to
	//   "application/octet-stream". The default can be overridden by
	// explictly
	//   setting `Content-Type` to a particular media type when the
	//   [task is
	// created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).
	//   For example, `Content-Type` can be set to "application/json".
	// * `Content-Length`: This is computed by Cloud Tasks. This value is
	//   output only. It cannot be changed.
	//
	// The headers below cannot be set or overridden:
	//
	// * `Host`
	// * `X-Google-*`
	// * `X-AppEngine-*`
	//
	// In addition, some App Engine headers, which contain
	// task-specific information, are also be sent to the task handler;
	// see
	// [request
	// headers](/appengine/docs/python/taskqueue/push/creating-handlers#readi
	// ng_request_headers).
	Headers map[string]string `json:"headers,omitempty"`

	// HttpMethod: The HTTP method to use for the request. The default is
	// POST.
	//
	// The app's request handler for the task's target URL must be able to
	// handle
	// HTTP requests with this http_method, otherwise the task attempt will
	// fail
	// with error code 405 (Method Not Allowed). See
	// the Request-Line is not allowed for the resource identified by
	// the
	// Request-URI". See
	// [Writing a push task request
	// handler](/appengine/docs/java/taskqueue/push/creating-handlers#writing
	// _a_push_task_request_handler)
	// and the documentation for the request handlers in the language your
	// app is
	// written in e.g.
	// [python
	// RequestHandler](/appengine/docs/python/tools/webapp/requesthandlerclas
	// s).
	//
	// Possible values:
	//   "HTTP_METHOD_UNSPECIFIED" - HTTP method unspecified
	//   "POST" - HTTP Post
	//   "GET" - HTTP Get
	//   "HEAD" - HTTP Head
	//   "PUT" - HTTP Put
	//   "DELETE" - HTTP Delete
	HttpMethod string `json:"httpMethod,omitempty"`

	// Payload: Payload.
	//
	// The payload will be sent as the HTTP message body. A message
	// body, and thus a payload, is allowed only if the HTTP method is
	// POST or PUT. It is an error to set a data payload on a task with
	// an incompatible HttpMethod.
	Payload string `json:"payload,omitempty"`

	// RelativeUrl: The relative URL.
	//
	// The relative URL must begin with "/" and must be a valid HTTP
	// relative URL.
	// It can contain a path and query string arguments.
	// If the relative URL is empty, then the root path "/" will be used.
	// No spaces are allowed, and the maximum length allowed is 2083
	// characters.
	RelativeUrl string `json:"relativeUrl,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AppEngineRouting") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AppEngineRouting") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

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 Queue.app_engine_http_target set.

Using AppEngineHttpRequest requires [`appengine.applications.get`](/appengine/docs/admin-api/acce ss-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](/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](/appengine/docs/python/config/dispatchref).

The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level:

* If set, 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.

The `url` that the task will be sent to is:

* `url =` AppEngineRouting.host `+` AppEngineHttpRequest.relative_url

The task will be sent to a task handler by an HTTP request using the specified AppEngineHttpRequest.http_method (for example POST, HTTP GET, etc). The task attempt has succeeded if the task handler returns an HTTP response code in the range [200 - 299]. Error 503 is considered an App Engine system error instead of an application error. Requests returning error 503 will be retried regardless of retry configuration and not counted against retry counts. Any other response code or a failure to receive a response before the deadline is a failed attempt.

func (*AppEngineHttpRequest) MarshalJSON 

func (s *AppEngineHttpRequest) MarshalJSON() ([]byte, error)

type AppEngineHttpTarget 

type AppEngineHttpTarget struct {
	// AppEngineRoutingOverride: Overrides for the
	// task-level app_engine_routing.
	//
	// If set, 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.
	AppEngineRoutingOverride *AppEngineRouting `json:"appEngineRoutingOverride,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "AppEngineRoutingOverride") to unconditionally include in API
	// requests. By default, fields with empty values are omitted from API
	// requests. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AppEngineRoutingOverride")
	// to include in API requests with the JSON null value. By default,
	// fields with empty values are omitted from API requests. However, any
	// field with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

AppEngineHttpTarget: App Engine HTTP target.

The task will be delivered to the App Engine application hostname specified by its AppEngineHttpTarget and AppEngineHttpRequest. The documentation for AppEngineHttpRequest explains how the task's host URL is constructed.

Using AppEngineHttpTarget requires [`appengine.applications.get`](/appengine/docs/admin-api/acce ss-control) Google IAM permission for the project and the following scope:

`https://www.googleapis.com/auth/cloud-platform`

func (*AppEngineHttpTarget) MarshalJSON 

func (s *AppEngineHttpTarget) MarshalJSON() ([]byte, error)

type AppEngineQueueConfig 

type AppEngineQueueConfig struct {
	// AppEngineRoutingOverride: Deprecated. Use
	// AppEngineHttpTarget.app_engine_routing_override.
	AppEngineRoutingOverride *AppEngineRouting `json:"appEngineRoutingOverride,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "AppEngineRoutingOverride") to unconditionally include in API
	// requests. By default, fields with empty values are omitted from API
	// requests. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AppEngineRoutingOverride")
	// to include in API requests with the JSON null value. By default,
	// fields with empty values are omitted from API requests. However, any
	// field with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

AppEngineQueueConfig: Deprecated. Use AppEngineHttpTarget.

func (*AppEngineQueueConfig) MarshalJSON 

func (s *AppEngineQueueConfig) MarshalJSON() ([]byte, error)

type AppEngineRouting 

type AppEngineRouting struct {
	// Host: Output only.
	//
	// The host that the task is sent to. For more information, see
	// [How Requests are
	// Routed](/appengine/docs/standard/python/how-requests-are-routed).
	//
	// The
	//  host is constructed as:
	//
	//
	// * `host = [application_domain_name]`</br>
	//   `| [service] + '.' + [application_domain_name]`</br>
	//   `| [version] + '.' + [application_domain_name]`</br>
	//   `| [version_dot_service]+ '.' + [application_domain_name]`</br>
	//   `| [instance] + '.' + [application_domain_name]`</br>
	//   `| [instance_dot_service] + '.' + [application_domain_name]`</br>
	//   `| [instance_dot_version] + '.' + [application_domain_name]`</br>
	//   `| [instance_dot_version_dot_service] + '.' +
	// [application_domain_name]`
	//
	// * `application_domain_name` = The domain name of the app, for
	//   example <app-id>.appspot.com, which is associated with the
	//   queue's project ID. Some tasks which were created using the App
	// Engine
	//   SDK use a custom domain name.
	//
	// * `service =` AppEngineRouting.service
	//
	// * `version =` AppEngineRouting.version
	//
	// * `version_dot_service =`
	//   AppEngineRouting.version `+ '.' +` AppEngineRouting.service
	//
	// * `instance =` AppEngineRouting.instance
	//
	// * `instance_dot_service =`
	//   AppEngineRouting.instance `+ '.' +` AppEngineRouting.service
	//
	// * `instance_dot_version =`
	//   AppEngineRouting.instance `+ '.' +` AppEngineRouting.version
	//
	// * `instance_dot_version_dot_service =`
	//   AppEngineRouting.instance `+ '.' +`
	//   AppEngineRouting.version `+ '.' +` AppEngineRouting.service
	//
	// If AppEngineRouting.service is empty, then the task will be sent
	// to the service which is the default service when the task is
	// attempted.
	//
	// If AppEngineRouting.version is empty, then the task will be sent
	// to the version which is the default version when the task is
	// attempted.
	//
	// If AppEngineRouting.instance is empty, then the task will be sent
	// to an instance which is available when the task is attempted.
	//
	// When AppEngineRouting.service is "default",
	// AppEngineRouting.version is "default", and
	// AppEngineRouting.instance is empty, AppEngineRouting.host
	// is
	// shortened to just the `application_domain_name`.
	//
	// If AppEngineRouting.service, AppEngineRouting.version,
	// or
	// AppEngineRouting.instance is invalid, then the task will be sent
	// to the default version of the default service when the task is
	// attempted.
	Host string `json:"host,omitempty"`

	// Instance: App instance.
	//
	// By default, the task is sent to an instance which is available
	// when
	// the task is attempted.
	//
	// Requests can only be sent to a specific instance if
	// [manual scaling is used in App Engine
	// Standard](/appengine/docs/python/an-overview-of-app-engine?hl=en_US#sc
	// aling_types_and_instance_classes).
	// App Engine Flex does not support instances. For more information,
	// see
	// [App Engine Standard request
	// routing](/appengine/docs/standard/python/how-requests-are-routed)
	// and [App Engine Flex request
	// routing](/appengine/docs/flexible/python/how-requests-are-routed).
	Instance string `json:"instance,omitempty"`

	// Service: App service.
	//
	// By default, the task is sent to the service which is the
	// default
	// service when the task is attempted ("default").
	//
	// For some queues or tasks which were created using the App Engine Task
	// Queue
	// API, AppEngineRouting.host is not parsable
	// into
	// AppEngineRouting.service, AppEngineRouting.version,
	// and
	// AppEngineRouting.instance. For example, some tasks which were
	// created
	// using the App Engine SDK use a custom domain name; custom domains are
	// not
	// parsed by Cloud Tasks. If AppEngineRouting.host is not parsable,
	// then
	// AppEngineRouting.service, AppEngineRouting.version,
	// and
	// AppEngineRouting.instance are the empty string.
	Service string `json:"service,omitempty"`

	// Version: App version.
	//
	// By default, the task is sent to the version which is the
	// default
	// version when the task is attempted ("default").
	//
	// For some queues or tasks which were created using the App Engine Task
	// Queue
	// API, AppEngineRouting.host is not parsable
	// into
	// AppEngineRouting.service, AppEngineRouting.version,
	// and
	// AppEngineRouting.instance. For example, some tasks which were
	// created
	// using the App Engine SDK use a custom domain name; custom domains are
	// not
	// parsed by Cloud Tasks. If AppEngineRouting.host is not parsable,
	// then
	// AppEngineRouting.service, AppEngineRouting.version,
	// and
	// AppEngineRouting.instance are the empty string.
	Version string `json:"version,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Host") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Host") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AppEngineRouting: App Engine Routing.

For more information about services, versions, and instances see [An Overview of App Engine](/appengine/docs/python/an-overview-of-app-engine), [Microservi ces Architecture on Google App Engine](/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](/appengine/docs/standard/python/how-requests-are-routed), and 

[App Engine Flex request

routing](/appengine/docs/flexible/python/how-requests-are-routed).

func (*AppEngineRouting) MarshalJSON 

func (s *AppEngineRouting) MarshalJSON() ([]byte, error)

type AppEngineTaskTarget 

type AppEngineTaskTarget struct {
	// AppEngineRouting: Deprecated. Use
	// AppEngineHttpRequest.app_engine_routing.
	AppEngineRouting *AppEngineRouting `json:"appEngineRouting,omitempty"`

	// Headers: Deprecated. Use AppEngineHttpRequest.headers.
	Headers map[string]string `json:"headers,omitempty"`

	// HttpMethod: Deprecated. Use AppEngineHttpRequest.http_method.
	//
	// Possible values:
	//   "HTTP_METHOD_UNSPECIFIED" - HTTP method unspecified
	//   "POST" - HTTP Post
	//   "GET" - HTTP Get
	//   "HEAD" - HTTP Head
	//   "PUT" - HTTP Put
	//   "DELETE" - HTTP Delete
	HttpMethod string `json:"httpMethod,omitempty"`

	// Payload: Deprecated. Use AppEngineHttpRequest.payload.
	Payload string `json:"payload,omitempty"`

	// RelativeUrl: Deprecated. Use AppEngineHttpRequest.relative_url.
	RelativeUrl string `json:"relativeUrl,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AppEngineRouting") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AppEngineRouting") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

AppEngineTaskTarget: Deprecated. Use AppEngineHttpRequest.

func (*AppEngineTaskTarget) MarshalJSON 

func (s *AppEngineTaskTarget) MarshalJSON() ([]byte, error)

type AttemptStatus 

type AttemptStatus struct {
	// DispatchTime: Output only.
	//
	// The time that this attempt was dispatched.
	//
	// `dispatch_time` will be truncated to the nearest microsecond.
	DispatchTime string `json:"dispatchTime,omitempty"`

	// ResponseStatus: Output only.
	//
	// The response from the target for this attempt.
	//
	// If the task has not been attempted or the task is currently
	// running
	// then the response status is google.rpc.Code.UNKNOWN.
	ResponseStatus *Status `json:"responseStatus,omitempty"`

	// ResponseTime: Output only.
	//
	// The time that this attempt response was received.
	//
	// `response_time` will be truncated to the nearest microsecond.
	ResponseTime string `json:"responseTime,omitempty"`

	// ScheduleTime: Output only.
	//
	// The time that this attempt was scheduled.
	//
	// `schedule_time` will be truncated to the nearest microsecond.
	ScheduleTime string `json:"scheduleTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DispatchTime") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DispatchTime") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AttemptStatus: The status of a task attempt.

func (*AttemptStatus) MarshalJSON 

func (s *AttemptStatus) MarshalJSON() ([]byte, error)

type Binding 

type Binding struct {
	// Members: Specifies the identities requesting access for a Cloud
	// Platform resource.
	// `members` can have the following values:
	//
	// * `allUsers`: A special identifier that represents anyone who is
	//    on the internet; with or without a Google account.
	//
	// * `allAuthenticatedUsers`: A special identifier that represents
	// anyone
	//    who is authenticated with a Google account or a service
	// account.
	//
	// * `user:{emailid}`: An email address that represents a specific
	// Google
	//    account. For example, `alice@gmail.com` or `joe@example.com`.
	//
	//
	// * `serviceAccount:{emailid}`: An email address that represents a
	// service
	//    account. For example,
	// `my-other-app@appspot.gserviceaccount.com`.
	//
	// * `group:{emailid}`: An email address that represents a Google
	// group.
	//    For example, `admins@example.com`.
	//
	//
	// * `domain:{domain}`: A Google Apps domain name that represents all
	// the
	//    users of that domain. For example, `google.com` or
	// `example.com`.
	//
	//
	Members []string `json:"members,omitempty"`

	// Role: Role that is assigned to `members`.
	// For example, `roles/viewer`, `roles/editor`, or
	// `roles/owner`.
	// Required
	Role string `json:"role,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Members") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Members") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Binding: Associates `members` with a `role`.

func (*Binding) MarshalJSON 

func (s *Binding) MarshalJSON() ([]byte, error)

type CancelLeaseRequest 

type CancelLeaseRequest struct {
	// ResponseView: The response_view specifies which subset of the Task
	// will be
	// returned.
	//
	// By default response_view is Task.View.BASIC; 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.
	//
	// Authorization for Task.View.FULL requires
	// `cloudtasks.tasks.fullView`
	// [Google IAM](/iam/) permission on the
	// Task.name resource.
	//
	// Possible values:
	//   "VIEW_UNSPECIFIED" - Unspecified. Defaults to BASIC.
	//   "BASIC" - The basic view omits fields which can be large or can
	// contain
	// sensitive data.
	//
	// This view does not include the payload.
	//   "FULL" - All information is returned.
	//
	// Payloads might be desirable to return only when needed, because
	// they can be large and because of the sensitivity of the data
	// that you choose to store in it.
	//
	// Authorization for Task.View.FULL requires
	// `cloudtasks.tasks.fullView` [Google
	// IAM](https://cloud.google.com/iam/)
	// permission on the Queue.name resource.
	ResponseView string `json:"responseView,omitempty"`

	// ScheduleTime: Required.
	//
	// The task's current schedule time, available in the
	// Task.schedule_time
	// returned in PullTasksResponse.tasks or
	// CloudTasks.RenewLease. This restriction is to check that
	// the caller is canceling the correct task.
	ScheduleTime string `json:"scheduleTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ResponseView") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ResponseView") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CancelLeaseRequest: Request message for canceling a lease using CloudTasks.CancelLease.

func (*CancelLeaseRequest) MarshalJSON 

func (s *CancelLeaseRequest) MarshalJSON() ([]byte, error)

type CreateTaskRequest 

type CreateTaskRequest struct {
	// ResponseView: The response_view specifies which subset of the Task
	// will be
	// returned.
	//
	// By default response_view is Task.View.BASIC; 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.
	//
	// Authorization for Task.View.FULL requires
	// `cloudtasks.tasks.fullView`
	// [Google IAM](/iam/) permission on the
	// Task.name resource.
	//
	// Possible values:
	//   "VIEW_UNSPECIFIED" - Unspecified. Defaults to BASIC.
	//   "BASIC" - The basic view omits fields which can be large or can
	// contain
	// sensitive data.
	//
	// This view does not include the payload.
	//   "FULL" - All information is returned.
	//
	// Payloads might be desirable to return only when needed, because
	// they can be large and because of the sensitivity of the data
	// that you choose to store in it.
	//
	// Authorization for Task.View.FULL requires
	// `cloudtasks.tasks.fullView` [Google
	// IAM](https://cloud.google.com/iam/)
	// permission on the Queue.name resource.
	ResponseView string `json:"responseView,omitempty"`

	// Task: Required.
	//
	// The task to add.
	//
	// Task names have the following
	// format:
	// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tas
	// ks/TASK_ID`.
	// The user can optionally specify a name for the task in
	// Task.name. If a name is not specified then the system will
	// generate a random unique task id, which will be returned in
	// the
	// response's Task.name.
	//
	// If Task.schedule_time is not set or is in the past then Cloud
	// Tasks will set it to the current time.
	//
	// Task De-duplication:
	//
	// Explicitly specifying a task ID enables task de-duplication.  If
	// a task's ID is identical to that of an existing task or a task
	// that was deleted or completed recently then the call will fail
	// with google.rpc.Code.ALREADY_EXISTS. If the task's queue was
	// created using Cloud Tasks, then another task with the same name
	// can't be created for ~1hour after the original task was deleted
	// or completed. If the task's queue was created using queue.yaml
	// or
	// queue.xml, then another task with the same name can't be created
	// for ~9days after the original task was deleted or completed.
	//
	// Because there is an extra lookup cost to identify duplicate
	// task
	// names, these CloudTasks.CreateTask calls have significantly
	// increased latency. Using hashed strings for the task id or for
	// the prefix of the task id is recommended. Choosing task ids that
	// are sequential or have sequential prefixes, for example using
	// a
	// timestamp, causes an increase in latency and error rates in all
	// task commands. The infrastructure relies on an approximately
	// uniform distribution of task ids to store and serve
	// tasks
	// efficiently.
	Task *Task `json:"task,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ResponseView") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ResponseView") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CreateTaskRequest: Request message for CloudTasks.CreateTask.

func (*CreateTaskRequest) MarshalJSON 

func (s *CreateTaskRequest) MarshalJSON() ([]byte, error)

type Empty 

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`
}

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 `Empty` is empty JSON object `{}`.

type GetIamPolicyRequest 

type GetIamPolicyRequest struct {
}

GetIamPolicyRequest: Request message for `GetIamPolicy` method.

type ListLocationsResponse 

type ListLocationsResponse struct {
	// Locations: A list of locations that matches the specified filter in
	// the request.
	Locations []*Location `json:"locations,omitempty"`

	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Locations") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Locations") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListLocationsResponse: The response message for Locations.ListLocations.

func (*ListLocationsResponse) MarshalJSON 

func (s *ListLocationsResponse) MarshalJSON() ([]byte, error)

type ListQueuesResponse 

type ListQueuesResponse struct {
	// NextPageToken: A token to retrieve next page of results.
	//
	// To return the next page of results, call
	// CloudTasks.ListQueues with this value as
	// the
	// ListQueuesRequest.page_token.
	//
	// If the next_page_token is empty, there are no more results.
	//
	// The page token is valid for only 2 hours.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Queues: The list of queues.
	Queues []*Queue `json:"queues,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListQueuesResponse: Response message for CloudTasks.ListQueues.

func (*ListQueuesResponse) MarshalJSON 

func (s *ListQueuesResponse) MarshalJSON() ([]byte, error)

type ListTasksResponse 

type ListTasksResponse struct {
	// NextPageToken: A token to retrieve next page of results.
	//
	// To return the next page of results, call
	// CloudTasks.ListTasks with this value as
	// the
	// ListTasksRequest.page_token.
	//
	// If the next_page_token is empty, there are no more results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Tasks: The list of tasks.
	Tasks []*Task `json:"tasks,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListTasksResponse: Response message for listing tasks using CloudTasks.ListTasks.

func (*ListTasksResponse) MarshalJSON 

func (s *ListTasksResponse) MarshalJSON() ([]byte, error)

type Location 

type Location struct {
	// Labels: Cross-service attributes for the location. For example
	//
	//     {"cloud.googleapis.com/region": "us-east1"}
	Labels map[string]string `json:"labels,omitempty"`

	// LocationId: The canonical id for this location. For example:
	// "us-east1".
	LocationId string `json:"locationId,omitempty"`

	// Metadata: Service-specific metadata. For example the available
	// capacity at the given
	// location.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`

	// Name: Resource name for the location, which may vary between
	// implementations.
	// For example: "projects/example-project/locations/us-east1"
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Labels") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Labels") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Location: A resource that represents Google Cloud Platform location.

func (*Location) MarshalJSON 

func (s *Location) MarshalJSON() ([]byte, error)

type PauseQueueRequest 

type PauseQueueRequest struct {
}

PauseQueueRequest: Request message for CloudTasks.PauseQueue.

type Policy 

type Policy struct {
	// Bindings: Associates a list of `members` to a `role`.
	// `bindings` with no members will result in an error.
	Bindings []*Binding `json:"bindings,omitempty"`

	// Etag: `etag` is used for optimistic concurrency control as a way to
	// help
	// prevent simultaneous updates of a policy from overwriting each
	// other.
	// It is strongly suggested that systems make use of the `etag` in
	// the
	// read-modify-write cycle to perform policy updates in order to avoid
	// race
	// conditions: An `etag` is returned in the response to `getIamPolicy`,
	// and
	// systems are expected to put that etag in the request to
	// `setIamPolicy` to
	// ensure that their change will be applied to the same version of the
	// policy.
	//
	// If no `etag` is provided in the call to `setIamPolicy`, then the
	// existing
	// policy is overwritten blindly.
	Etag string `json:"etag,omitempty"`

	// Version: Version of the `Policy`. The default version is 0.
	Version int64 `json:"version,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Bindings") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Bindings") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Policy: Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.

A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.

**Example** 

{
  "bindings": [
    {
      "role": "roles/owner",
      "members": [
        "user:mike@example.com",
        "group:admins@example.com",
        "domain:google.com",

"serviceAccount:my-other-app@appspot.gserviceaccount.com", 

      ]
    },
    {
      "role": "roles/viewer",
      "members": ["user:sean@example.com"]
    }
  ]
}

For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).

func (*Policy) MarshalJSON 

func (s *Policy) MarshalJSON() ([]byte, error)

type ProjectsLocationsGetCall 

type ProjectsLocationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsGetCall) Context 

func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsGetCall) Do 

func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error)

Do executes the "cloudtasks.projects.locations.get" call. Exactly one of *Location or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Location.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsGetCall) Fields 

func (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsGetCall) Header 

func (c *ProjectsLocationsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsGetCall) IfNoneMatch 

func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsListCall 

type ProjectsLocationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsListCall) Context 

func (c *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsListCall) Do 

func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, error)

Do executes the "cloudtasks.projects.locations.list" call. Exactly one of *ListLocationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListLocationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsListCall) Fields 

func (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsListCall) Filter 

func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsLocationsListCall) Header 

func (c *ProjectsLocationsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsListCall) IfNoneMatch 

func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsListCall) PageSize 

func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall

PageSize sets the optional parameter "pageSize": The standard list page size.

func (*ProjectsLocationsListCall) PageToken 

func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall

PageToken sets the optional parameter "pageToken": The standard list page token.

func (*ProjectsLocationsListCall) Pages 

func (c *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsQueuesCreateCall 

type ProjectsLocationsQueuesCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesCreateCall) Context 

func (c *ProjectsLocationsQueuesCreateCall) Context(ctx context.Context) *ProjectsLocationsQueuesCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesCreateCall) Do 

func (c *ProjectsLocationsQueuesCreateCall) Do(opts ...googleapi.CallOption) (*Queue, error)

Do executes the "cloudtasks.projects.locations.queues.create" call. Exactly one of *Queue or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Queue.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesCreateCall) Fields 

func (c *ProjectsLocationsQueuesCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesCreateCall) Header 

func (c *ProjectsLocationsQueuesCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsQueuesDeleteCall 

type ProjectsLocationsQueuesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesDeleteCall) Context 

func (c *ProjectsLocationsQueuesDeleteCall) Context(ctx context.Context) *ProjectsLocationsQueuesDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesDeleteCall) Do 

func (c *ProjectsLocationsQueuesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "cloudtasks.projects.locations.queues.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesDeleteCall) Fields 

func (c *ProjectsLocationsQueuesDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesDeleteCall) Header 

func (c *ProjectsLocationsQueuesDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsQueuesGetCall 

type ProjectsLocationsQueuesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesGetCall) Context 

func (c *ProjectsLocationsQueuesGetCall) Context(ctx context.Context) *ProjectsLocationsQueuesGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesGetCall) Do 

func (c *ProjectsLocationsQueuesGetCall) Do(opts ...googleapi.CallOption) (*Queue, error)

Do executes the "cloudtasks.projects.locations.queues.get" call. Exactly one of *Queue or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Queue.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesGetCall) Fields 

func (c *ProjectsLocationsQueuesGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesGetCall) Header 

func (c *ProjectsLocationsQueuesGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsQueuesGetCall) IfNoneMatch 

func (c *ProjectsLocationsQueuesGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsQueuesGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsQueuesGetIamPolicyCall 

type ProjectsLocationsQueuesGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesGetIamPolicyCall) Context 

func (c *ProjectsLocationsQueuesGetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsQueuesGetIamPolicyCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesGetIamPolicyCall) Do 

func (c *ProjectsLocationsQueuesGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "cloudtasks.projects.locations.queues.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesGetIamPolicyCall) Fields 

func (c *ProjectsLocationsQueuesGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesGetIamPolicyCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesGetIamPolicyCall) Header 

func (c *ProjectsLocationsQueuesGetIamPolicyCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsQueuesListCall 

type ProjectsLocationsQueuesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesListCall) Context 

func (c *ProjectsLocationsQueuesListCall) Context(ctx context.Context) *ProjectsLocationsQueuesListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesListCall) Do 

func (c *ProjectsLocationsQueuesListCall) Do(opts ...googleapi.CallOption) (*ListQueuesResponse, error)

Do executes the "cloudtasks.projects.locations.queues.list" call. Exactly one of *ListQueuesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListQueuesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesListCall) Fields 

func (c *ProjectsLocationsQueuesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesListCall) Filter 

func (c *ProjectsLocationsQueuesListCall) Filter(filter string) *ProjectsLocationsQueuesListCall

Filter sets the optional parameter "filter": `filter` can be used to specify a subset of queues. Any Queue field can be used as a filter and several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as described in [Stackdriver's Advanced Logs Filters](/logging/docs/view/advanced_filters).

Sample filter "app_engine_http_target: *".

Note that using filters might cause fewer queues than the requested_page size to be returned.

func (*ProjectsLocationsQueuesListCall) Header 

func (c *ProjectsLocationsQueuesListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsQueuesListCall) IfNoneMatch 

func (c *ProjectsLocationsQueuesListCall) IfNoneMatch(entityTag string) *ProjectsLocationsQueuesListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsQueuesListCall) PageSize 

func (c *ProjectsLocationsQueuesListCall) PageSize(pageSize int64) *ProjectsLocationsQueuesListCall

PageSize sets the optional parameter "pageSize": Requested page size.

The maximum page size is 9800. If unspecified, the page size will be the maximum. Fewer queues than requested might be returned, even if more queues exist; use ListQueuesResponse.next_page_token to determine if more queues exist.

func (*ProjectsLocationsQueuesListCall) PageToken 

func (c *ProjectsLocationsQueuesListCall) PageToken(pageToken string) *ProjectsLocationsQueuesListCall

PageToken sets the optional parameter "pageToken": A token identifying the page of results to return.

To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of ListQueuesResponse.next_page_token returned from the previous call to CloudTasks.ListQueues method. It is an error to switch the value of ListQueuesRequest.filter while iterating through pages.

func (*ProjectsLocationsQueuesListCall) Pages 

func (c *ProjectsLocationsQueuesListCall) Pages(ctx context.Context, f func(*ListQueuesResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsQueuesPatchCall 

type ProjectsLocationsQueuesPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesPatchCall) Context 

func (c *ProjectsLocationsQueuesPatchCall) Context(ctx context.Context) *ProjectsLocationsQueuesPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesPatchCall) Do 

func (c *ProjectsLocationsQueuesPatchCall) Do(opts ...googleapi.CallOption) (*Queue, error)

Do executes the "cloudtasks.projects.locations.queues.patch" call. Exactly one of *Queue or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Queue.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesPatchCall) Fields 

func (c *ProjectsLocationsQueuesPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesPatchCall) Header 

func (c *ProjectsLocationsQueuesPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsQueuesPatchCall) UpdateMask 

func (c *ProjectsLocationsQueuesPatchCall) UpdateMask(updateMask string) *ProjectsLocationsQueuesPatchCall

UpdateMask sets the optional parameter "updateMask": A mask used to specify which fields of the queue are being updated.

If empty, then all fields will be updated.

type ProjectsLocationsQueuesPauseCall 

type ProjectsLocationsQueuesPauseCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesPauseCall) Context 

func (c *ProjectsLocationsQueuesPauseCall) Context(ctx context.Context) *ProjectsLocationsQueuesPauseCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesPauseCall) Do 

func (c *ProjectsLocationsQueuesPauseCall) Do(opts ...googleapi.CallOption) (*Queue, error)

Do executes the "cloudtasks.projects.locations.queues.pause" call. Exactly one of *Queue or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Queue.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesPauseCall) Fields 

func (c *ProjectsLocationsQueuesPauseCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesPauseCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesPauseCall) Header 

func (c *ProjectsLocationsQueuesPauseCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsQueuesPurgeCall 

type ProjectsLocationsQueuesPurgeCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesPurgeCall) Context 

func (c *ProjectsLocationsQueuesPurgeCall) Context(ctx context.Context) *ProjectsLocationsQueuesPurgeCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesPurgeCall) Do 

func (c *ProjectsLocationsQueuesPurgeCall) Do(opts ...googleapi.CallOption) (*Queue, error)

Do executes the "cloudtasks.projects.locations.queues.purge" call. Exactly one of *Queue or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Queue.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesPurgeCall) Fields 

func (c *ProjectsLocationsQueuesPurgeCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesPurgeCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesPurgeCall) Header 

func (c *ProjectsLocationsQueuesPurgeCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsQueuesResumeCall 

type ProjectsLocationsQueuesResumeCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesResumeCall) Context 

func (c *ProjectsLocationsQueuesResumeCall) Context(ctx context.Context) *ProjectsLocationsQueuesResumeCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesResumeCall) Do 

func (c *ProjectsLocationsQueuesResumeCall) Do(opts ...googleapi.CallOption) (*Queue, error)

Do executes the "cloudtasks.projects.locations.queues.resume" call. Exactly one of *Queue or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Queue.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesResumeCall) Fields 

func (c *ProjectsLocationsQueuesResumeCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesResumeCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesResumeCall) Header 

func (c *ProjectsLocationsQueuesResumeCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsQueuesService 

type ProjectsLocationsQueuesService struct {
	Tasks *ProjectsLocationsQueuesTasksService
	// contains filtered or unexported fields
}

func NewProjectsLocationsQueuesService 

func NewProjectsLocationsQueuesService(s *Service) *ProjectsLocationsQueuesService

func (*ProjectsLocationsQueuesService) Create 

func (r *ProjectsLocationsQueuesService) Create(parent string, queue *Queue) *ProjectsLocationsQueuesCreateCall

Create: Creates a queue.

WARNING: This method is only available to whitelisted users. Using this method carries some risk. Read [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) carefully and then sign up for [whitelist access to this method](https://goo.gl/Fe5mUy).

func (*ProjectsLocationsQueuesService) Delete 

func (r *ProjectsLocationsQueuesService) Delete(name string) *ProjectsLocationsQueuesDeleteCall

Delete: 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: This method is only available to whitelisted users. Using this method carries some risk. Read [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) carefully and then sign up for [whitelist access to this method](https://goo.gl/Fe5mUy).

func (*ProjectsLocationsQueuesService) Get 

func (r *ProjectsLocationsQueuesService) Get(name string) *ProjectsLocationsQueuesGetCall

Get: Gets a queue.

func (*ProjectsLocationsQueuesService) GetIamPolicy 

func (r *ProjectsLocationsQueuesService) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *ProjectsLocationsQueuesGetIamPolicyCall

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](/iam) permission on the specified resource parent:

* `cloudtasks.queues.getIamPolicy`

func (*ProjectsLocationsQueuesService) List 

func (r *ProjectsLocationsQueuesService) List(parent string) *ProjectsLocationsQueuesListCall

List: Lists queues.

Queues are returned in lexicographical order.

func (*ProjectsLocationsQueuesService) Patch 

func (r *ProjectsLocationsQueuesService) Patch(name string, queue *Queue) *ProjectsLocationsQueuesPatchCall

Patch: Updates a queue.

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

WARNING: This method is only available to whitelisted users. Using this method carries some risk. Read [Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml) carefully and then sign up for [whitelist access to this method](https://goo.gl/Fe5mUy).

func (*ProjectsLocationsQueuesService) Pause 

func (r *ProjectsLocationsQueuesService) Pause(name string, pausequeuerequest *PauseQueueRequest) *ProjectsLocationsQueuesPauseCall

Pause: Pauses the queue.

If a queue is paused then the system will stop executing the tasks in the queue until it is resumed via CloudTasks.ResumeQueue. Tasks can still be added when the queue is paused. The state of the queue is stored in Queue.queue_state; if paused it will be set to Queue.QueueState.PAUSED.

func (*ProjectsLocationsQueuesService) Purge 

func (r *ProjectsLocationsQueuesService) Purge(name string, purgequeuerequest *PurgeQueueRequest) *ProjectsLocationsQueuesPurgeCall

Purge: 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.

func (*ProjectsLocationsQueuesService) Resume 

func (r *ProjectsLocationsQueuesService) Resume(name string, resumequeuerequest *ResumeQueueRequest) *ProjectsLocationsQueuesResumeCall

Resume: Resume a queue.

This method resumes a queue after it has been Queue.QueueState.PAUSED or Queue.QueueState.DISABLED. The state of a queue is stored in Queue.queue_state; after calling this method it will be set to Queue.QueueState.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](/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05 .pdf).

func (*ProjectsLocationsQueuesService) SetIamPolicy 

func (r *ProjectsLocationsQueuesService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsLocationsQueuesSetIamPolicyCall

SetIamPolicy: Sets the access control policy for a Queue. Replaces any existing policy.

Authorization requires the following [Google IAM](/iam) permission on the specified resource parent:

* `cloudtasks.queues.setIamPolicy`

func (*ProjectsLocationsQueuesService) TestIamPermissions 

func (r *ProjectsLocationsQueuesService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsLocationsQueuesTestIamPermissionsCall

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

type ProjectsLocationsQueuesSetIamPolicyCall 

type ProjectsLocationsQueuesSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesSetIamPolicyCall) Context 

func (c *ProjectsLocationsQueuesSetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsQueuesSetIamPolicyCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesSetIamPolicyCall) Do 

func (c *ProjectsLocationsQueuesSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "cloudtasks.projects.locations.queues.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesSetIamPolicyCall) Fields 

func (c *ProjectsLocationsQueuesSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesSetIamPolicyCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesSetIamPolicyCall) Header 

func (c *ProjectsLocationsQueuesSetIamPolicyCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsQueuesTasksAcknowledgeCall 

type ProjectsLocationsQueuesTasksAcknowledgeCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesTasksAcknowledgeCall) Context 

func (c *ProjectsLocationsQueuesTasksAcknowledgeCall) Context(ctx context.Context) *ProjectsLocationsQueuesTasksAcknowledgeCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesTasksAcknowledgeCall) Do 

func (c *ProjectsLocationsQueuesTasksAcknowledgeCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "cloudtasks.projects.locations.queues.tasks.acknowledge" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesTasksAcknowledgeCall) Fields 

func (c *ProjectsLocationsQueuesTasksAcknowledgeCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesTasksAcknowledgeCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesTasksAcknowledgeCall) Header 

func (c *ProjectsLocationsQueuesTasksAcknowledgeCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsQueuesTasksCancelLeaseCall 

type ProjectsLocationsQueuesTasksCancelLeaseCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesTasksCancelLeaseCall) Context 

func (c *ProjectsLocationsQueuesTasksCancelLeaseCall) Context(ctx context.Context) *ProjectsLocationsQueuesTasksCancelLeaseCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesTasksCancelLeaseCall) Do 

func (c *ProjectsLocationsQueuesTasksCancelLeaseCall) Do(opts ...googleapi.CallOption) (*Task, error)

Do executes the "cloudtasks.projects.locations.queues.tasks.cancelLease" call. Exactly one of *Task or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Task.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesTasksCancelLeaseCall) Fields 

func (c *ProjectsLocationsQueuesTasksCancelLeaseCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesTasksCancelLeaseCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesTasksCancelLeaseCall) Header 

func (c *ProjectsLocationsQueuesTasksCancelLeaseCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsQueuesTasksCreateCall 

type ProjectsLocationsQueuesTasksCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesTasksCreateCall) Context 

func (c *ProjectsLocationsQueuesTasksCreateCall) Context(ctx context.Context) *ProjectsLocationsQueuesTasksCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesTasksCreateCall) Do 

func (c *ProjectsLocationsQueuesTasksCreateCall) Do(opts ...googleapi.CallOption) (*Task, error)

Do executes the "cloudtasks.projects.locations.queues.tasks.create" call. Exactly one of *Task or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Task.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesTasksCreateCall) Fields 

func (c *ProjectsLocationsQueuesTasksCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesTasksCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesTasksCreateCall) Header 

func (c *ProjectsLocationsQueuesTasksCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsQueuesTasksDeleteCall 

type ProjectsLocationsQueuesTasksDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesTasksDeleteCall) Context 

func (c *ProjectsLocationsQueuesTasksDeleteCall) Context(ctx context.Context) *ProjectsLocationsQueuesTasksDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesTasksDeleteCall) Do 

func (c *ProjectsLocationsQueuesTasksDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "cloudtasks.projects.locations.queues.tasks.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesTasksDeleteCall) Fields 

func (c *ProjectsLocationsQueuesTasksDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesTasksDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesTasksDeleteCall) Header 

func (c *ProjectsLocationsQueuesTasksDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsQueuesTasksGetCall 

type ProjectsLocationsQueuesTasksGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesTasksGetCall) Context 

func (c *ProjectsLocationsQueuesTasksGetCall) Context(ctx context.Context) *ProjectsLocationsQueuesTasksGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesTasksGetCall) Do 

func (c *ProjectsLocationsQueuesTasksGetCall) Do(opts ...googleapi.CallOption) (*Task, error)

Do executes the "cloudtasks.projects.locations.queues.tasks.get" call. Exactly one of *Task or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Task.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesTasksGetCall) Fields 

func (c *ProjectsLocationsQueuesTasksGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesTasksGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesTasksGetCall) Header 

func (c *ProjectsLocationsQueuesTasksGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsQueuesTasksGetCall) IfNoneMatch 

func (c *ProjectsLocationsQueuesTasksGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsQueuesTasksGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsQueuesTasksGetCall) ResponseView 

func (c *ProjectsLocationsQueuesTasksGetCall) ResponseView(responseView string) *ProjectsLocationsQueuesTasksGetCall

ResponseView sets the optional parameter "responseView": The response_view specifies which subset of the Task will be returned.

By default response_view is Task.View.BASIC; 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.

Authorization for Task.View.FULL requires `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the Task.name resource.

Possible values: 

"VIEW_UNSPECIFIED"
"BASIC"
"FULL"

type ProjectsLocationsQueuesTasksListCall 

type ProjectsLocationsQueuesTasksListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesTasksListCall) Context 

func (c *ProjectsLocationsQueuesTasksListCall) Context(ctx context.Context) *ProjectsLocationsQueuesTasksListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesTasksListCall) Do 

func (c *ProjectsLocationsQueuesTasksListCall) Do(opts ...googleapi.CallOption) (*ListTasksResponse, error)

Do executes the "cloudtasks.projects.locations.queues.tasks.list" call. Exactly one of *ListTasksResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListTasksResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesTasksListCall) Fields 

func (c *ProjectsLocationsQueuesTasksListCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesTasksListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesTasksListCall) Header 

func (c *ProjectsLocationsQueuesTasksListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsQueuesTasksListCall) IfNoneMatch 

func (c *ProjectsLocationsQueuesTasksListCall) IfNoneMatch(entityTag string) *ProjectsLocationsQueuesTasksListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsQueuesTasksListCall) OrderBy 

func (c *ProjectsLocationsQueuesTasksListCall) OrderBy(orderBy string) *ProjectsLocationsQueuesTasksListCall

OrderBy sets the optional parameter "orderBy": Sort order used for the query. The only fields supported for sorting are `schedule_time` and `pull_message.tag`. All results will be returned in approximately ascending order. The default ordering is by `schedule_time`.

func (*ProjectsLocationsQueuesTasksListCall) PageSize 

func (c *ProjectsLocationsQueuesTasksListCall) PageSize(pageSize int64) *ProjectsLocationsQueuesTasksListCall

PageSize sets the optional parameter "pageSize": Requested page size. Fewer tasks than requested might be returned.

The maximum page size is 1000. If unspecified, the page size will be the maximum. Fewer tasks than requested might be returned, even if more tasks exist; use ListTasksResponse.next_page_token to determine if more tasks exist.

func (*ProjectsLocationsQueuesTasksListCall) PageToken 

func (c *ProjectsLocationsQueuesTasksListCall) PageToken(pageToken string) *ProjectsLocationsQueuesTasksListCall

PageToken sets the optional parameter "pageToken": A token identifying the page of results to return.

To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of ListTasksResponse.next_page_token returned from the previous call to CloudTasks.ListTasks method.

The page token is valid for only 2 hours.

func (*ProjectsLocationsQueuesTasksListCall) Pages 

func (c *ProjectsLocationsQueuesTasksListCall) Pages(ctx context.Context, f func(*ListTasksResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsLocationsQueuesTasksListCall) ResponseView 

func (c *ProjectsLocationsQueuesTasksListCall) ResponseView(responseView string) *ProjectsLocationsQueuesTasksListCall

ResponseView sets the optional parameter "responseView": The response_view specifies which subset of the Task will be returned.

By default response_view is Task.View.BASIC; 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.

Authorization for Task.View.FULL requires `cloudtasks.tasks.fullView` [Google IAM](/iam/) permission on the Task.name resource.

Possible values: 

"VIEW_UNSPECIFIED"
"BASIC"
"FULL"

type ProjectsLocationsQueuesTasksPullCall 

type ProjectsLocationsQueuesTasksPullCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesTasksPullCall) Context 

func (c *ProjectsLocationsQueuesTasksPullCall) Context(ctx context.Context) *ProjectsLocationsQueuesTasksPullCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesTasksPullCall) Do 

func (c *ProjectsLocationsQueuesTasksPullCall) Do(opts ...googleapi.CallOption) (*PullTasksResponse, error)

Do executes the "cloudtasks.projects.locations.queues.tasks.pull" call. Exactly one of *PullTasksResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *PullTasksResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesTasksPullCall) Fields 

func (c *ProjectsLocationsQueuesTasksPullCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesTasksPullCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesTasksPullCall) Header 

func (c *ProjectsLocationsQueuesTasksPullCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsQueuesTasksRenewLeaseCall 

type ProjectsLocationsQueuesTasksRenewLeaseCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesTasksRenewLeaseCall) Context 

func (c *ProjectsLocationsQueuesTasksRenewLeaseCall) Context(ctx context.Context) *ProjectsLocationsQueuesTasksRenewLeaseCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesTasksRenewLeaseCall) Do 

func (c *ProjectsLocationsQueuesTasksRenewLeaseCall) Do(opts ...googleapi.CallOption) (*Task, error)

Do executes the "cloudtasks.projects.locations.queues.tasks.renewLease" call. Exactly one of *Task or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Task.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesTasksRenewLeaseCall) Fields 

func (c *ProjectsLocationsQueuesTasksRenewLeaseCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesTasksRenewLeaseCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesTasksRenewLeaseCall) Header 

func (c *ProjectsLocationsQueuesTasksRenewLeaseCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsQueuesTasksRunCall 

type ProjectsLocationsQueuesTasksRunCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesTasksRunCall) Context 

func (c *ProjectsLocationsQueuesTasksRunCall) Context(ctx context.Context) *ProjectsLocationsQueuesTasksRunCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesTasksRunCall) Do 

func (c *ProjectsLocationsQueuesTasksRunCall) Do(opts ...googleapi.CallOption) (*Task, error)

Do executes the "cloudtasks.projects.locations.queues.tasks.run" call. Exactly one of *Task or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Task.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesTasksRunCall) Fields 

func (c *ProjectsLocationsQueuesTasksRunCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesTasksRunCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesTasksRunCall) Header 

func (c *ProjectsLocationsQueuesTasksRunCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsQueuesTasksService 

type ProjectsLocationsQueuesTasksService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsQueuesTasksService 

func NewProjectsLocationsQueuesTasksService(s *Service) *ProjectsLocationsQueuesTasksService

func (*ProjectsLocationsQueuesTasksService) Acknowledge 

func (r *ProjectsLocationsQueuesTasksService) Acknowledge(name string, acknowledgetaskrequest *AcknowledgeTaskRequest) *ProjectsLocationsQueuesTasksAcknowledgeCall

Acknowledge: Acknowledges a pull task.

The lease holder, that is, the entity that received this task in a PullTasksResponse, must call this method to indicate that the work associated with the task has finished.

The lease holder must acknowledge a task within the PullTasksRequest.lease_duration or the lease will expire and the task will become ready to be returned in a different PullTasksResponse. After the task is acknowledged, it will not be returned by a later CloudTasks.PullTasks, CloudTasks.GetTask, or CloudTasks.ListTasks.

func (*ProjectsLocationsQueuesTasksService) CancelLease 

func (r *ProjectsLocationsQueuesTasksService) CancelLease(name string, cancelleaserequest *CancelLeaseRequest) *ProjectsLocationsQueuesTasksCancelLeaseCall

CancelLease: Cancel a pull task's lease.

The lease holder can use this method to cancel a task's lease by setting Task.schedule_time to now. This will make the task available to be leased to the next caller of CloudTasks.PullTasks.

func (*ProjectsLocationsQueuesTasksService) Create 

func (r *ProjectsLocationsQueuesTasksService) Create(parent string, createtaskrequest *CreateTaskRequest) *ProjectsLocationsQueuesTasksCreateCall

Create: Creates a task and adds it to a queue.

To add multiple tasks at the same time, use [HTTP batching](/storage/docs/json_api/v1/how-tos/batch) or the batching documentation for your client library, for example https://developers.google.com/api-client-library/python/guide/ batch.

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

* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget), 

the maximum task size is 100KB.
  • For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this the maximum task size is 1MB.

func (*ProjectsLocationsQueuesTasksService) Delete 

func (r *ProjectsLocationsQueuesTasksService) Delete(name string) *ProjectsLocationsQueuesTasksDeleteCall

Delete: Deletes a task.

A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has completed successfully or permanently failed.

func (*ProjectsLocationsQueuesTasksService) Get 

func (r *ProjectsLocationsQueuesTasksService) Get(name string) *ProjectsLocationsQueuesTasksGetCall

Get: Gets a task.

func (*ProjectsLocationsQueuesTasksService) List 

func (r *ProjectsLocationsQueuesTasksService) List(parent string) *ProjectsLocationsQueuesTasksListCall

List: Lists the tasks in a queue.

By default response_view is Task.View.BASIC; not all information is retrieved by default due to performance considerations; ListTasksRequest.response_view controls the subset of information which is returned.

func (*ProjectsLocationsQueuesTasksService) Pull 

func (r *ProjectsLocationsQueuesTasksService) Pull(name string, pulltasksrequest *PullTasksRequest) *ProjectsLocationsQueuesTasksPullCall

Pull: Pulls tasks from a pull queue and acquires a lease on them for a specified PullTasksRequest.lease_duration.

This method is invoked by the lease holder to obtain the lease. The lease holder must acknowledge the task via CloudTasks.AcknowledgeTask after they have performed the work associated with the task.

The payload is intended to store data that the lease holder needs to perform the work associated with the task. To return the payloads in the PullTasksResponse, set PullTasksRequest.response_view to Task.View.FULL.

A maximum of 10 qps of CloudTasks.PullTasks requests are allowed per queue. google.rpc.Code.RESOURCE_EXHAUSTED is returned when this limit is exceeded. google.rpc.Code.RESOURCE_EXHAUSTED is also returned when RateLimits.max_tasks_dispatched_per_second is exceeded.

func (*ProjectsLocationsQueuesTasksService) RenewLease 

func (r *ProjectsLocationsQueuesTasksService) RenewLease(name string, renewleaserequest *RenewLeaseRequest) *ProjectsLocationsQueuesTasksRenewLeaseCall

RenewLease: Renew the current lease of a pull task.

The lease holder can use this method to extend the lease by a new duration, starting from now. The new task lease will be returned in Task.schedule_time.

func (*ProjectsLocationsQueuesTasksService) Run 

func (r *ProjectsLocationsQueuesTasksService) Run(name string, runtaskrequest *RunTaskRequest) *ProjectsLocationsQueuesTasksRunCall

Run: Forces a task to run now.

This command is meant to be used for manual debugging. For example, 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.

When this method is called, Cloud Tasks will dispatch the task to its target, even if the queue is Queue.QueueState.PAUSED.

The dispatched task is returned. That is, the task that is returned contains the Task.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 handler, then the task will be deleted; otherwise the task's Task.schedule_time will be reset to the time that CloudTasks.RunTask was called plus the retry delay specified in the queue and task's RetryConfig.

CloudTasks.RunTask returns google.rpc.Code.NOT_FOUND when it is called on a task that has already succeeded or permanently failed. google.rpc.Code.FAILED_PRECONDITION is returned when CloudTasks.RunTask is called on task that is dispatched or already running.

type ProjectsLocationsQueuesTestIamPermissionsCall 

type ProjectsLocationsQueuesTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsQueuesTestIamPermissionsCall) Context 

func (c *ProjectsLocationsQueuesTestIamPermissionsCall) Context(ctx context.Context) *ProjectsLocationsQueuesTestIamPermissionsCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsQueuesTestIamPermissionsCall) Do 

func (c *ProjectsLocationsQueuesTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)

Do executes the "cloudtasks.projects.locations.queues.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsQueuesTestIamPermissionsCall) Fields 

func (c *ProjectsLocationsQueuesTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesTestIamPermissionsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsQueuesTestIamPermissionsCall) Header 

func (c *ProjectsLocationsQueuesTestIamPermissionsCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsService 

type ProjectsLocationsService struct {
	Queues *ProjectsLocationsQueuesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService 

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) Get 

func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall

Get: Get information about a location.

func (*ProjectsLocationsService) List 

func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall

List: Lists information about the supported locations for this service.

type ProjectsService 

type ProjectsService struct {
	Locations *ProjectsLocationsService
	// contains filtered or unexported fields
}

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

type PullMessage 

type PullMessage struct {
	// Payload: A data payload consumed by the task worker to execute the
	// task.
	Payload string `json:"payload,omitempty"`

	// Tag: A meta-data tag for this task.
	//
	// This value is used by CloudTasks.PullTasks calls
	// when
	// PullTasksRequest.filter is `tag=<tag>`.
	//
	// The tag must be less than 500 bytes.
	Tag string `json:"tag,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Payload") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Payload") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PullMessage: The pull message contains data that can be used by the caller of CloudTasks.PullTasks to process the task.

This proto can only be used for tasks in a queue which has Queue.pull_target set.

func (*PullMessage) MarshalJSON 

func (s *PullMessage) MarshalJSON() ([]byte, error)

type PullQueueConfig 

type PullQueueConfig struct {
}

PullQueueConfig: Deprecated. Use PullTarget.

type PullTarget 

type PullTarget struct {
}

PullTarget: Pull target.

type PullTaskTarget 

type PullTaskTarget struct {
	// Payload: Deprecated. Use PullMessage.payload.
	Payload string `json:"payload,omitempty"`

	// Tag: Deprecated. Use PullMessage.tag.
	Tag string `json:"tag,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Payload") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Payload") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PullTaskTarget: Deprecated. Use PullMessage.

func (*PullTaskTarget) MarshalJSON 

func (s *PullTaskTarget) MarshalJSON() ([]byte, error)

type PullTasksRequest 

type PullTasksRequest struct {
	// Filter: `filter` can be used to specify a subset of tasks to
	// lease.
	//
	// When `filter` is set to `tag=<my-tag>` then the
	// PullTasksResponse will contain only tasks whose
	// PullMessage.tag is equal to `<my-tag>`. `<my-tag>` must be less
	// than
	// 500 bytes.
	//
	// When `filter` is set to `tag_function=oldest_tag()`, only tasks which
	// have
	// the same tag as the task with the oldest schedule_time will be
	// returned.
	//
	// Grammar Syntax:
	//
	// * `filter = "tag=" tag | "tag_function=" function`
	//
	// * `tag = string | bytes`
	//
	// * `function = "oldest_tag()"
	//
	// The `oldest_tag()` function returns tasks which have the same tag as
	// the
	// oldest task (ordered by schedule time).
	Filter string `json:"filter,omitempty"`

	// LeaseDuration: The duration of the lease.
	//
	// Each task returned in the PullTasksResponse will have
	// its
	// Task.schedule_time set to the current time plus the
	// `lease_duration`. A task that has been returned in
	// a
	// PullTasksResponse is leased -- that task will not be
	// returned in a different PullTasksResponse before
	// the
	// Task.schedule_time.
	//
	// After the lease holder has successfully finished the work
	// associated with the task, the lease holder must
	// call
	// CloudTasks.AcknowledgeTask. If the task is not acknowledged
	// via CloudTasks.AcknowledgeTask before the
	// Task.schedule_time then it will be returned in a
	// later
	// PullTasksResponse so that another lease holder can process
	// it.
	//
	// The maximum lease duration is 1 week.
	// `lease_duration` will be truncated to the nearest second.
	LeaseDuration string `json:"leaseDuration,omitempty"`

	// MaxTasks: The maximum number of tasks to lease. The maximum that can
	// be
	// requested is 1000.
	MaxTasks int64 `json:"maxTasks,omitempty"`

	// ResponseView: The response_view specifies which subset of the Task
	// will be
	// returned.
	//
	// By default response_view is Task.View.BASIC; 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.
	//
	// Authorization for Task.View.FULL requires
	// `cloudtasks.tasks.fullView`
	// [Google IAM](/iam/) permission on the
	// Task.name resource.
	//
	// Possible values:
	//   "VIEW_UNSPECIFIED" - Unspecified. Defaults to BASIC.
	//   "BASIC" - The basic view omits fields which can be large or can
	// contain
	// sensitive data.
	//
	// This view does not include the payload.
	//   "FULL" - All information is returned.
	//
	// Payloads might be desirable to return only when needed, because
	// they can be large and because of the sensitivity of the data
	// that you choose to store in it.
	//
	// Authorization for Task.View.FULL requires
	// `cloudtasks.tasks.fullView` [Google
	// IAM](https://cloud.google.com/iam/)
	// permission on the Queue.name resource.
	ResponseView string `json:"responseView,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Filter") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Filter") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PullTasksRequest: Request message for pulling tasks using CloudTasks.PullTasks.

func (*PullTasksRequest) MarshalJSON 

func (s *PullTasksRequest) MarshalJSON() ([]byte, error)

type PullTasksResponse 

type PullTasksResponse struct {
	// Tasks: The leased tasks.
	Tasks []*Task `json:"tasks,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Tasks") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Tasks") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PullTasksResponse: Response message for pulling tasks using CloudTasks.PullTasks.

func (*PullTasksResponse) MarshalJSON 

func (s *PullTasksResponse) MarshalJSON() ([]byte, error)

type PurgeQueueRequest 

type PurgeQueueRequest struct {
}

PurgeQueueRequest: Request message for CloudTasks.PurgeQueue.

type Queue 

type Queue struct {
	// AppEngineHttpTarget: App Engine HTTP target.
	//
	// An App Engine queue is a queue that has an AppEngineHttpTarget.
	AppEngineHttpTarget *AppEngineHttpTarget `json:"appEngineHttpTarget,omitempty"`

	// AppEngineQueueConfig: Deprecated. Use Queue.app_engine_http_target.
	AppEngineQueueConfig *AppEngineQueueConfig `json:"appEngineQueueConfig,omitempty"`

	// Name: The queue name.
	//
	// The queue name must have the following
	// format:
	// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
	//
	// *
	//  `PROJECT_ID` can contain uppercase and lowercase letters,
	//   numbers, hyphens, colons, and periods; that is, it must match
	//   the regular expression: `[a-zA-Z\\d-:\\.]+`.
	// * `QUEUE_ID` can contain uppercase and lowercase letters,
	//   numbers, and hyphens; that is, it must match the regular
	//   expression: `[a-zA-Z\\d-]+`. The maximum length is 100
	//   characters.
	//
	// Caller-specified and required in CreateQueueRequest, after which
	// it becomes output only.
	Name string `json:"name,omitempty"`

	// PullQueueConfig: Deprecated. Use Queue.pull_target.
	PullQueueConfig *PullQueueConfig `json:"pullQueueConfig,omitempty"`

	// PullTarget: Pull target.
	//
	// A pull queue is a queue that has a PullTarget.
	PullTarget *PullTarget `json:"pullTarget,omitempty"`

	// PurgeTime: Output only.
	//
	// The last time this queue was purged. All tasks that were
	// created before this time were purged.
	//
	// A queue can be purged using CloudTasks.PurgeQueue, the
	// [App Engine Task Queue SDK, or the Cloud
	// Console](/appengine/docs/standard/python/taskqueue/push/deleting-tasks
	// -and-queues#purging_all_tasks_from_a_queue).
	//
	// Purge time will be truncated to the nearest microsecond. Purge
	// time will be zero if the queue has never been purged.
	PurgeTime string `json:"purgeTime,omitempty"`

	// QueueState: Output only.
	//
	// The state of the queue.
	//
	// `queue_state` can only be changed by called
	// CloudTasks.PauseQueue, CloudTasks.ResumeQueue, or
	// uploading
	// [queue.yaml](/appengine/docs/python/config/queueref).
	// CloudT
	// asks.UpdateQueue cannot be used to change `queue_state`.
	//
	// Possible values:
	//   "QUEUE_STATE_UNSPECIFIED" - Unspecified state.
	//   "RUNNING" - The queue is running. Tasks can be dispatched.
	//   "PAUSED" - Tasks are paused by the user. If the queue is paused
	// then Cloud
	// Tasks will stop delivering tasks from it, but more tasks can
	// still be added to it by the user. When a pull queue is paused,
	// all CloudTasks.PullTasks calls will return a
	// `FAILED_PRECONDITION` error.
	//   "DISABLED" - The queue is disabled.
	//
	// A queue becomes `DISABLED`
	// when
	// [queue.yaml](/appengine/docs/python/config/queueref)
	// or
	// [queue.xml](appengine/docs/standard/java/config/queueref) is
	// uploaded
	// which does not contain the queue. You cannot directly disable a
	// queue.
	//
	// When a queue is disabled, tasks can still be added to a queue
	// but the tasks are not dispatched and CloudTasks.PullTasks
	// calls
	// return a `FAILED_PRECONDITION` error.
	//
	// To permanently delete this queue and all of its tasks,
	// call
	// CloudTasks.DeleteQueue.
	QueueState string `json:"queueState,omitempty"`

	// RateLimits: Rate limits for task dispatches.
	//
	// Queue.rate_limits and Queue.retry_config are related because
	// they
	// both control task attempts however they control how tasks are
	// attempted in
	// different ways:
	//
	// * Queue.rate_limits controls the total rate of dispatches from a
	// queue
	//   (i.e. all traffic dispatched from the queue, regardless of whether
	// the
	//   dispatch is from a first attempt or a retry).
	// * Queue.retry_config controls what happens to particular a task
	// after
	//   its first attempt fails. That is, Queue.retry_config controls task
	//   retries (the second attempt, third attempt, etc).
	RateLimits *RateLimits `json:"rateLimits,omitempty"`

	// RetryConfig: Settings that determine the retry behavior.
	//
	// * For tasks created using Cloud Tasks: the queue-level retry
	// settings
	//   apply to all tasks in the queue that were created using Cloud
	// Tasks.
	//   Retry settings cannot be set on individual tasks.
	// * For tasks created using the App Engine SDK: the queue-level retry
	//   settings apply to all tasks in the queue which do not have retry
	// settings
	//   explicitly set on the task and were created by the App Engine SDK.
	// See
	//   [App Engine
	// documentation](/appengine/docs/standard/python/taskqueue/push/retrying
	// -tasks).
	RetryConfig *RetryConfig `json:"retryConfig,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AppEngineHttpTarget")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AppEngineHttpTarget") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

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.

func (*Queue) MarshalJSON 

func (s *Queue) MarshalJSON() ([]byte, error)

type RateLimits 

type RateLimits struct {
	// MaxBurstSize: Output only.
	//
	// The max burst size limits how fast the queue is processed when
	// many tasks are in the queue and the rate is high. This field
	// allows the queue to have a high rate so processing starts
	// shortly
	// after a task is enqueued, but still limits resource usage when
	// many tasks are enqueued in a short period of time.
	//
	// * For App Engine queues, if
	//   RateLimits.max_tasks_dispatched_per_second is 1, this
	//   field is 10; otherwise this field is
	//   RateLimits.max_tasks_dispatched_per_second / 5.
	// * For pull queues, this field is output only and always
	// 10,000.
	//
	// Note: For App Engine queues that were created
	// through
	// `queue.yaml/xml`, `max_burst_size` might not have the same
	// settings as specified above; CloudTasks.UpdateQueue can be
	// used to set `max_burst_size` only to the values specified
	// above.
	//
	// This field has the same meaning as
	// [bucket_size in
	// queue.yaml](/appengine/docs/standard/python/config/queueref#bucket_siz
	// e).
	MaxBurstSize int64 `json:"maxBurstSize,omitempty"`

	// MaxConcurrentTasks: The maximum number of concurrent tasks that Cloud
	// Tasks allows
	// to be dispatched for this queue. After this threshold has
	// been
	// reached, Cloud Tasks stops dispatching tasks until the number
	// of
	// concurrent requests decreases.
	//
	// The maximum allowed value is 5,000.
	//
	// * For App Engine queues, this field is 10 by default.
	// * For pull queues, this field is output only and always -1, which
	//   indicates no limit.
	//
	// This field has the same meaning as
	// [max_concurrent_requests in
	// queue.yaml](/appengine/docs/standard/python/config/queueref#max_concur
	// rent_requests).
	MaxConcurrentTasks int64 `json:"maxConcurrentTasks,omitempty"`

	// MaxTasksDispatchedPerSecond: The maximum rate at which tasks are
	// dispatched from this
	// queue.
	//
	// The maximum allowed value is 500.
	//
	// * For App Engine queues, this field is 1 by default.
	// * For pull queues, this field is output only and always 10,000.
	//
	// This field has the same meaning as
	// [rate in
	// queue.yaml](/appengine/docs/standard/python/config/queueref#rate).
	MaxTasksDispatchedPerSecond float64 `json:"maxTasksDispatchedPerSecond,omitempty"`

	// ForceSendFields is a list of field names (e.g. "MaxBurstSize") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "MaxBurstSize") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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.

func (*RateLimits) MarshalJSON 

func (s *RateLimits) MarshalJSON() ([]byte, error)

func (*RateLimits) UnmarshalJSON 

func (s *RateLimits) UnmarshalJSON(data []byte) error

type RenewLeaseRequest 

type RenewLeaseRequest struct {
	// NewLeaseDuration: Required.
	//
	// The desired new lease duration, starting from now.
	//
	//
	// The maximum lease duration is 1 week.
	// `new_lease_duration` will be truncated to the nearest second.
	NewLeaseDuration string `json:"newLeaseDuration,omitempty"`

	// ResponseView: The response_view specifies which subset of the Task
	// will be
	// returned.
	//
	// By default response_view is Task.View.BASIC; 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.
	//
	// Authorization for Task.View.FULL requires
	// `cloudtasks.tasks.fullView`
	// [Google IAM](/iam/) permission on the
	// Task.name resource.
	//
	// Possible values:
	//   "VIEW_UNSPECIFIED" - Unspecified. Defaults to BASIC.
	//   "BASIC" - The basic view omits fields which can be large or can
	// contain
	// sensitive data.
	//
	// This view does not include the payload.
	//   "FULL" - All information is returned.
	//
	// Payloads might be desirable to return only when needed, because
	// they can be large and because of the sensitivity of the data
	// that you choose to store in it.
	//
	// Authorization for Task.View.FULL requires
	// `cloudtasks.tasks.fullView` [Google
	// IAM](https://cloud.google.com/iam/)
	// permission on the Queue.name resource.
	ResponseView string `json:"responseView,omitempty"`

	// ScheduleTime: Required.
	//
	// The task's current schedule time, available in the
	// Task.schedule_time
	// returned in PullTasksResponse.tasks or
	// CloudTasks.RenewLease. This restriction is to check that
	// the caller is renewing the correct task.
	ScheduleTime string `json:"scheduleTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "NewLeaseDuration") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NewLeaseDuration") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

RenewLeaseRequest: Request message for renewing a lease using CloudTasks.RenewLease.

func (*RenewLeaseRequest) MarshalJSON 

func (s *RenewLeaseRequest) MarshalJSON() ([]byte, error)

type ResumeQueueRequest 

type ResumeQueueRequest struct {
}

ResumeQueueRequest: Request message for CloudTasks.ResumeQueue.

type RetryConfig 

type RetryConfig struct {
	// MaxAttempts: The maximum number of attempts for a task.
	//
	// Cloud Tasks will attempt the task `max_attempts` times (that
	// is, if the first attempt fails, then there will be
	// `max_attempts - 1` retries).  Must be > 0.
	MaxAttempts int64 `json:"maxAttempts,omitempty"`

	// MaxBackoff: The maximum amount of time to wait before retrying a task
	// after
	// it fails. The default is 1 hour.
	//
	// * For [App Engine
	// queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),
	//   this field is 1 hour by default.
	// * For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this
	// field
	//   is output only and always 0.
	//
	// `max_backoff` will be truncated to the nearest second.
	//
	// This field has the same meaning as
	// [max_backoff_seconds in
	// queue.yaml](/appengine/docs/standard/python/config/queueref#retry_para
	// meters).
	MaxBackoff string `json:"maxBackoff,omitempty"`

	// MaxDoublings: The time between retries increases exponentially
	// `max_doublings` times.
	// `max_doublings` is maximum number of times that the interval between
	// failed
	// task retries will be doubled before the interval increases
	// linearly.
	// After max_doublings intervals, the retry interval will
	// be
	// 2^(max_doublings - 1) * RetryConfig.min_backoff.
	//
	// * For [App Engine
	// queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),
	//   this field is 16 by default.
	// * For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this
	// field
	//   is output only and always 0.
	//
	// This field has the same meaning as
	// [max_doublings in
	// queue.yaml](/appengine/docs/standard/python/config/queueref#retry_para
	// meters).
	MaxDoublings int64 `json:"maxDoublings,omitempty"`

	// MaxRetryDuration: If positive, `max_retry_duration` specifies the
	// time limit for retrying a
	// failed task, measured from when the task was first attempted.
	// Once
	// `max_retry_duration` time has passed *and* the task has been
	// attempted
	// RetryConfig.max_attempts times, no further attempts will be made
	// and
	// the task will be deleted.
	//
	// If zero, then the task age is unlimited.
	//
	// * For [App Engine
	// queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),
	//   this field is 0 seconds by default.
	// * For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this
	//   field is output only and always 0.
	//
	// `max_retry_duration` will be truncated to the nearest second.
	//
	// This field has the same meaning as
	// [task_age_limit in
	// queue.yaml](/appengine/docs/standard/python/config/queueref#retry_para
	// meters).
	MaxRetryDuration string `json:"maxRetryDuration,omitempty"`

	// MinBackoff: The minimum amount of time to wait before retrying a task
	// after
	// it fails.
	//
	// * For [App Engine
	// queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),
	//   this field is 0.1 seconds by default.
	// * For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this
	//   field is output only and always 0.
	//
	// `min_backoff` will be truncated to the nearest second.
	//
	// This field has the same meaning as
	// [min_backoff_seconds in
	// queue.yaml](/appengine/docs/standard/python/config/queueref#retry_para
	// meters).
	MinBackoff string `json:"minBackoff,omitempty"`

	// UnlimitedAttempts: If true, then the number of attempts is unlimited.
	UnlimitedAttempts bool `json:"unlimitedAttempts,omitempty"`

	// ForceSendFields is a list of field names (e.g. "MaxAttempts") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "MaxAttempts") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RetryConfig: Retry config.

These settings determine how a failed task attempt is retried.

func (*RetryConfig) MarshalJSON 

func (s *RetryConfig) MarshalJSON() ([]byte, error)

type RunTaskRequest 

type RunTaskRequest struct {
	// ResponseView: The response_view specifies which subset of the Task
	// will be
	// returned.
	//
	// By default response_view is Task.View.BASIC; 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.
	//
	// Authorization for Task.View.FULL requires
	// `cloudtasks.tasks.fullView`
	// [Google IAM](/iam/) permission on the
	// Task.name resource.
	//
	// Possible values:
	//   "VIEW_UNSPECIFIED" - Unspecified. Defaults to BASIC.
	//   "BASIC" - The basic view omits fields which can be large or can
	// contain
	// sensitive data.
	//
	// This view does not include the payload.
	//   "FULL" - All information is returned.
	//
	// Payloads might be desirable to return only when needed, because
	// they can be large and because of the sensitivity of the data
	// that you choose to store in it.
	//
	// Authorization for Task.View.FULL requires
	// `cloudtasks.tasks.fullView` [Google
	// IAM](https://cloud.google.com/iam/)
	// permission on the Queue.name resource.
	ResponseView string `json:"responseView,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ResponseView") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ResponseView") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RunTaskRequest: Request message for forcing a task to run now using CloudTasks.RunTask.

func (*RunTaskRequest) MarshalJSON 

func (s *RunTaskRequest) MarshalJSON() ([]byte, error)

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New 

func New(client *http.Client) (*Service, error)

type SetIamPolicyRequest 

type SetIamPolicyRequest struct {
	// Policy: REQUIRED: The complete policy to be applied to the
	// `resource`. The size of
	// the policy is limited to a few 10s of KB. An empty policy is a
	// valid policy but certain Cloud Platform services (such as
	// Projects)
	// might reject them.
	Policy *Policy `json:"policy,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Policy") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Policy") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SetIamPolicyRequest: Request message for `SetIamPolicy` method.

func (*SetIamPolicyRequest) MarshalJSON 

func (s *SetIamPolicyRequest) MarshalJSON() ([]byte, error)

type Status 

type Status struct {
	// Code: The status code, which should be an enum value of
	// google.rpc.Code.
	Code int64 `json:"code,omitempty"`

	// Details: A list of messages that carry the error details.  There is a
	// common set of
	// message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`

	// Message: A developer-facing error message, which should be in
	// English. Any
	// user-facing error message should be localized and sent in
	// the
	// google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Code") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Code") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be:

- Simple to use and understand for most users - Flexible enough to meet unexpected needs

Overview

The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions.

Language mapping

The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.

Other uses

The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.

Example uses of this error model include:

- Partial errors. If a service needs to return partial errors to the client, 

it may embed the `Status` in the normal response to indicate the

partial 

errors.

- Workflow errors. A typical workflow has multiple steps. Each step may 

have a `Status` message for error reporting.

- Batch operations. If a client uses batch request and batch response, the 

`Status` message should be used directly inside batch response,

one for 

each error sub-response.

- Asynchronous operations. If an API call embeds asynchronous operation 

results in its response, the status of those operations should

be 

represented directly using the `Status` message.

- Logging. If some API errors are stored in logs, the message `Status` could 

be used directly after any stripping needed for security/privacy

reasons.

func (*Status) MarshalJSON 

func (s *Status) MarshalJSON() ([]byte, error)

type Task 

type Task struct {
	// AppEngineHttpRequest: App Engine HTTP request that is sent to the
	// task's target. Can be set
	// only if Queue.app_engine_http_target is set.
	//
	// An App Engine task is a task that has AppEngineHttpRequest set.
	AppEngineHttpRequest *AppEngineHttpRequest `json:"appEngineHttpRequest,omitempty"`

	// AppEngineTaskTarget: Deprecated. Use Task.app_engine_http_request.
	AppEngineTaskTarget *AppEngineTaskTarget `json:"appEngineTaskTarget,omitempty"`

	// CreateTime: Output only.
	//
	// The time that the task was created.
	//
	// `create_time` will be truncated to the nearest second.
	CreateTime string `json:"createTime,omitempty"`

	// Name: The task name.
	//
	// The task name must have the following
	// format:
	// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tas
	// ks/TASK_ID`
	//
	// * `PROJECT_ID` can contain uppercase and lowercase letters,
	//   numbers, hyphens, colons, and periods; that is, it must match
	//   the regular expression: `[a-zA-Z\\d-:\\.]+`.
	// * `QUEUE_ID` can contain uppercase and lowercase letters,
	//   numbers, and hyphens; that is, it must match the regular
	//   expression: `[a-zA-Z\\d-]+`. The maximum length is 100
	//   characters.
	// * `TASK_ID` contain uppercase and lowercase letters, numbers,
	//   underscores, and hyphens; that is, it must match the regular
	//   expression: `[a-zA-Z\\d_-]+`. The maximum length is 500
	//   characters.
	//
	// Optionally caller-specified in CreateTaskRequest.
	Name string `json:"name,omitempty"`

	// PullMessage: Pull message contains data that should be used by the
	// caller of
	// CloudTasks.PullTasks to process the task. Can be set only
	// if
	// Queue.pull_target is set.
	//
	// A pull task is a task that has PullMessage set.
	PullMessage *PullMessage `json:"pullMessage,omitempty"`

	// PullTaskTarget: Deprecated. Use Task.pull_message.
	PullTaskTarget *PullTaskTarget `json:"pullTaskTarget,omitempty"`

	// ScheduleTime: The time when the task is scheduled to be
	// attempted.
	//
	// For pull queues, this is the time when the task is available to
	// be leased; if a task is currently leased, this is the time when
	// the current lease expires, that is, the time that the task was
	// leased plus the PullTasksRequest.lease_duration.
	//
	// For App Engine queues, this is when the task will be attempted or
	// retried.
	//
	// `schedule_time` will be truncated to the nearest microsecond.
	ScheduleTime string `json:"scheduleTime,omitempty"`

	// TaskStatus: Output only.
	//
	// Task status.
	TaskStatus *TaskStatus `json:"taskStatus,omitempty"`

	// View: Output only.
	//
	// The view specifies which subset of the Task has been
	// returned.
	//
	// Possible values:
	//   "VIEW_UNSPECIFIED" - Unspecified. Defaults to BASIC.
	//   "BASIC" - The basic view omits fields which can be large or can
	// contain
	// sensitive data.
	//
	// This view does not include the payload.
	//   "FULL" - All information is returned.
	//
	// Payloads might be desirable to return only when needed, because
	// they can be large and because of the sensitivity of the data
	// that you choose to store in it.
	//
	// Authorization for Task.View.FULL requires
	// `cloudtasks.tasks.fullView` [Google
	// IAM](https://cloud.google.com/iam/)
	// permission on the Queue.name resource.
	View string `json:"view,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g.
	// "AppEngineHttpRequest") to unconditionally include in API requests.
	// By default, fields with empty values are omitted from API requests.
	// However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AppEngineHttpRequest") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

Task: A unit of scheduled work.

func (*Task) MarshalJSON 

func (s *Task) MarshalJSON() ([]byte, error)

type TaskStatus 

type TaskStatus struct {
	// AttemptDispatchCount: Output only.
	//
	// The number of attempts dispatched. This count includes tasks which
	// have
	// been dispatched but haven't received a response.
	AttemptDispatchCount int64 `json:"attemptDispatchCount,omitempty,string"`

	// AttemptResponseCount: Output only.
	//
	// The number of attempts which have received a response.
	//
	// This field is not calculated for
	// [pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).
	AttemptResponseCount int64 `json:"attemptResponseCount,omitempty,string"`

	// FirstAttemptStatus: Output only.
	//
	// The status of the task's first attempt.
	//
	// Only AttemptStatus.dispatch_time will be set.
	// The other AttemptStatus information is not retained by Cloud
	// Tasks.
	//
	// This field is not calculated for
	// [pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).
	FirstAttemptStatus *AttemptStatus `json:"firstAttemptStatus,omitempty"`

	// LastAttemptStatus: Output only.
	//
	// The status of the task's last attempt.
	//
	// This field is not calculated for
	// [pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).
	LastAttemptStatus *AttemptStatus `json:"lastAttemptStatus,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "AttemptDispatchCount") to unconditionally include in API requests.
	// By default, fields with empty values are omitted from API requests.
	// However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AttemptDispatchCount") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

TaskStatus: Status of the task.

func (*TaskStatus) MarshalJSON 

func (s *TaskStatus) MarshalJSON() ([]byte, error)

type TestIamPermissionsRequest 

type TestIamPermissionsRequest struct {
	// Permissions: The set of permissions to check for the `resource`.
	// Permissions with
	// wildcards (such as '*' or 'storage.*') are not allowed. For
	// more
	// information see
	// [IAM
	// Overview](https://cloud.google.com/iam/docs/overview#permissions).
	Permissions []string `json:"permissions,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Permissions") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Permissions") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

TestIamPermissionsRequest: Request message for `TestIamPermissions` method.

func (*TestIamPermissionsRequest) MarshalJSON 

func (s *TestIamPermissionsRequest) MarshalJSON() ([]byte, error)

type TestIamPermissionsResponse 

type TestIamPermissionsResponse struct {
	// Permissions: A subset of `TestPermissionsRequest.permissions` that
	// the caller is
	// allowed.
	Permissions []string `json:"permissions,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Permissions") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Permissions") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

TestIamPermissionsResponse: Response message for `TestIamPermissions` method.

func (*TestIamPermissionsResponse) MarshalJSON 

func (s *TestIamPermissionsResponse) MarshalJSON() ([]byte, error)

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.