type AcknowledgeTaskRequest struct {// ScheduleTime: Required. The task's current schedule time, available in the// schedule_time returned by LeaseTasks response or RenewLease response. This// restriction is to ensure that your worker currently holds the lease.ScheduleTimestring `json:"scheduleTime,omitempty"`// ForceSendFields is a list of field names (e.g. "ScheduleTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AcknowledgeTaskRequest)MarshalJSON¶

func (sAcknowledgeTaskRequest) MarshalJSON() ([]byte,error)

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

funcNewApiQueueService¶added inv0.100.0

func NewApiQueueService(s *Service) *ApiQueueService

func (*ApiQueueService)Update¶added inv0.100.0

func (r *ApiQueueService) Update(httpbody *HttpBody) *ApiQueueUpdateCall

Update: Update queue list by uploading a queue.yaml file. The queue.yamlfile is supplied in the request body as a YAML encoded string. This methodwas added to support gcloud clients versions before 322.0.0. New clientsshould use CreateQueue instead of this method.

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

func (*ApiQueueUpdateCall)AppId¶added inv0.100.0

func (c *ApiQueueUpdateCall) AppId(appIdstring) *ApiQueueUpdateCall

AppId sets the optional parameter "appId": Required. The App ID is suppliedas an HTTP parameter. Unlike internal usage of App ID, it does not include aregion prefix. Rather, the App ID represents the Project ID against which tomake the request.

func (*ApiQueueUpdateCall)Context¶added inv0.100.0

func (c *ApiQueueUpdateCall) Context(ctxcontext.Context) *ApiQueueUpdateCall

Context sets the context to be used in this call's Do method.

func (*ApiQueueUpdateCall)Do¶added inv0.100.0

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

Do executes the "cloudtasks.api.queue.update" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ApiQueueUpdateCall)Fields¶added inv0.100.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ApiQueueUpdateCall)Header¶added inv0.100.0

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

type ApiService struct {Queue *ApiQueueService// contains filtered or unexported fields}

funcNewApiService¶added inv0.100.0

func NewApiService(s *Service) *ApiService

type AppEngineHttpRequest struct {// AppEngineRouting: Task-level setting for App Engine routing. If set,// 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. 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 a 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 explicitly// setting `Content-Type` to a particular media type when the task is created.// 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, Cloud Tasks sets some// headers when the task is dispatched, such as headers containing information// about the task; see request headers// (https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).// These headers are set only when the task is dispatched, so they are not// visible when the task is returned in a Cloud Tasks response. Although there// is no specific limit for the maximum number of headers or the size, there is// a limit on the maximum size of the Task. For more information, see the// CreateTask documentation.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 fails with error// code 405 (Method Not Allowed). See Writing a push task request handler// (https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)// and the App Engine documentation for your runtime on How Requests are// Handled// (https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).//// Possible values://   "HTTP_METHOD_UNSPECIFIED" - HTTP method unspecified//   "POST" - HTTP POST//   "GET" - HTTP GET//   "HEAD" - HTTP HEAD//   "PUT" - HTTP PUT//   "DELETE" - HTTP DELETE//   "PATCH" - HTTP PATCH//   "OPTIONS" - HTTP OPTIONSHttpMethodstring `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.Payloadstring `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.RelativeUrlstring `json:"relativeUrl,omitempty"`// ForceSendFields is a list of field names (e.g. "AppEngineRouting") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AppEngineHttpRequest)MarshalJSON¶

func (sAppEngineHttpRequest) MarshalJSON() ([]byte,error)

type AppEngineHttpTarget struct {// AppEngineRoutingOverride: Overrides for the task-level app_engine_routing.// If set, `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AppEngineHttpTarget)MarshalJSON¶

func (sAppEngineHttpTarget) MarshalJSON() ([]byte,error)

type AppEngineRouting struct {// Host: Output only. The host that the task is sent to. For more information,// see How Requests are Routed// (https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).// The host is constructed as: * `host = [application_domain_name]` `|// [service] + '.' + [application_domain_name]` `| [version] + '.' +// [application_domain_name]` `| [version_dot_service]+ '.' +// [application_domain_name]` `| [instance] + '.' + [application_domain_name]`// `| [instance_dot_service] + '.' + [application_domain_name]` `|// [instance_dot_version] + '.' + [application_domain_name]` `|// [instance_dot_version_dot_service] + '.' + [application_domain_name]` *// `application_domain_name` = The domain name of the app, for example// .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 =` service * `version =` version * `version_dot_service =` version// `+ '.' +` service * `instance =` instance * `instance_dot_service =`// instance `+ '.' +` service * `instance_dot_version =` instance `+ '.' +`// version * `instance_dot_version_dot_service =` instance `+ '.' +` version `+// '.' +` service If service is empty, then the task will be sent to the// service which is the default service when the task is attempted. If version// is empty, then the task will be sent to the version which is the default// version when the task is attempted. If instance is empty, then the task will// be sent to an instance which is available when the task is attempted. If// service, version, or instance is invalid, then the task will be sent to the// default version of the default service when the task is attempted.Hoststring `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// (https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).// App Engine Flex does not support instances. For more information, see App// Engine Standard request routing// (https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)// and App Engine Flex request routing// (https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).Instancestring `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. For some queues or tasks// which were created using the App Engine Task Queue API, host is not parsable// into service, version, and 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 host is not parsable, then service,// version, and instance are the empty string.Servicestring `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. For some queues or tasks// which were created using the App Engine Task Queue API, host is not parsable// into service, version, and 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 host is not parsable, then service,// version, and instance are the empty string.Versionstring `json:"version,omitempty"`// ForceSendFields is a list of field names (e.g. "Host") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AppEngineRouting)MarshalJSON¶

func (sAppEngineRouting) MarshalJSON() ([]byte,error)

type AttemptStatus struct {// DispatchTime: Output only. The time that this attempt was dispatched.// `dispatch_time` will be truncated to the nearest microsecond.DispatchTimestring `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 unset.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.ResponseTimestring `json:"responseTime,omitempty"`// ScheduleTime: Output only. The time that this attempt was scheduled.// `schedule_time` will be truncated to the nearest microsecond.ScheduleTimestring `json:"scheduleTime,omitempty"`// ForceSendFields is a list of field names (e.g. "DispatchTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AttemptStatus)MarshalJSON¶

func (sAttemptStatus) MarshalJSON() ([]byte,error)

type Binding struct {// Condition: The condition that is associated with this binding. If the// condition evaluates to `true`, then this binding applies to the current// request. If the condition evaluates to `false`, then this binding does not// apply to the current request. However, a different role binding might grant// the same role to one or more of the principals in this binding. To learn// which resources support conditions in their IAM policies, see the IAM// documentation// (https://cloud.google.com/iam/help/conditions/resource-policies).Condition *Expr `json:"condition,omitempty"`// Members: Specifies the principals requesting access for a Google Cloud// 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. Does not include identities that come from external identity// providers (IdPs) through identity federation. * `user:{emailid}`: An email// address that represents a specific Google account. For example,// `alice@example.com` . * `serviceAccount:{emailid}`: An email address that// represents a Google service account. For example,// `my-other-app@appspot.gserviceaccount.com`. *// `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An// identifier for a Kubernetes service account// (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).// For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *// `group:{emailid}`: An email address that represents a Google group. For// example, `admins@example.com`. * `domain:{domain}`: The G Suite domain// (primary) that represents all the users of that domain. For example,// `google.com` or `example.com`. *// `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/sub// ject/{subject_attribute_value}`: A single identity in a workforce identity// pool. *// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/// group/{group_id}`: All workforce identities in a group. *// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/// attribute.{attribute_name}/{attribute_value}`: All workforce identities with// a specific attribute value. *// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/// *`: All identities in a workforce identity pool. *// `principal://iam.googleapis.com/projects/{project_number}/locations/global/wo// rkloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single// identity in a workload identity pool. *// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global// /workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool// group. *// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global// /workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}// `: All identities in a workload identity pool with a certain attribute. *// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global// /workloadIdentityPools/{pool_id}/*`: All identities in a workload identity// pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus// unique identifier) representing a user that has been recently deleted. For// example, `alice@example.com?uid=123456789012345678901`. If the user is// recovered, this value reverts to `user:{emailid}` and the recovered user// retains the role in the binding. *// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus// unique identifier) representing a service account that has been recently// deleted. For example,// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the// service account is undeleted, this value reverts to// `serviceAccount:{emailid}` and the undeleted service account retains the// role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email// address (plus unique identifier) representing a Google group that has been// recently deleted. For example,// `admins@example.com?uid=123456789012345678901`. If the group is recovered,// this value reverts to `group:{emailid}` and the recovered group retains the// role in the binding. *// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool// _id}/subject/{subject_attribute_value}`: Deleted single identity in a// workforce identity pool. For example,// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-po// ol-id/subject/my-subject-attribute-value`.Members []string `json:"members,omitempty"`// Role: Role that is assigned to the list of `members`, or principals. For// example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview// of the IAM roles and permissions, see the IAM documentation// (https://cloud.google.com/iam/docs/roles-overview). For a list of the// available pre-defined roles, see here// (https://cloud.google.com/iam/docs/understanding-roles).Rolestring `json:"role,omitempty"`// ForceSendFields is a list of field names (e.g. "Condition") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Condition") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Binding)MarshalJSON¶

func (sBinding) MarshalJSON() ([]byte,error)

type BufferTaskRequest struct {// Body: Optional. Body of the HTTP request. The body can take any generic// value. The value is written to the HttpRequest of the [Task].Body *HttpBody `json:"body,omitempty"`// ForceSendFields is a list of field names (e.g. "Body") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Body") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (BufferTaskRequest)MarshalJSON¶added inv0.96.0

func (sBufferTaskRequest) MarshalJSON() ([]byte,error)

type BufferTaskResponse struct {// Task: The created task.Task *Task `json:"task,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Task") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Task") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (BufferTaskResponse)MarshalJSON¶added inv0.96.0

func (sBufferTaskResponse) MarshalJSON() ([]byte,error)

type CancelLeaseRequest struct {// ResponseView: The response_view specifies which subset of the Task will be// returned. By default response_view is 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 FULL requires// `cloudtasks.tasks.fullView` Google IAM (https://cloud.google.com/iam/)// permission on the Task 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 in// AppEngineHttpRequest and payload in PullMessage). These payloads are// 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.//   "FULL" - All information is returned. Authorization for FULL requires// `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)// permission on the Queue resource.ResponseViewstring `json:"responseView,omitempty"`// ScheduleTime: Required. The task's current schedule time, available in the// schedule_time returned by LeaseTasks response or RenewLease response. This// restriction is to ensure that your worker currently holds the lease.ScheduleTimestring `json:"scheduleTime,omitempty"`// ForceSendFields is a list of field names (e.g. "ResponseView") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CancelLeaseRequest)MarshalJSON¶

func (sCancelLeaseRequest) MarshalJSON() ([]byte,error)

type CmekConfig struct {// KmsKey: Resource name of the Cloud KMS key, of the form// `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KE// Y_ID`, that will be used to encrypt the Queues & Tasks in the region.// Setting this as blank will turn off CMEK encryption.KmsKeystring `json:"kmsKey,omitempty"`// Name: Output only. The config resource name which includes the project and// location and must end in 'cmekConfig', in the format// projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`Namestring `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. "KmsKey") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "KmsKey") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CmekConfig)MarshalJSON¶added inv0.142.0

func (sCmekConfig) MarshalJSON() ([]byte,error)

type CreateTaskRequest struct {// ResponseView: The response_view specifies which subset of the Task will be// returned. By default response_view is 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 FULL requires// `cloudtasks.tasks.fullView` Google IAM (https://cloud.google.com/iam/)// permission on the Task 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 in// AppEngineHttpRequest and payload in PullMessage). These payloads are// 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.//   "FULL" - All information is returned. Authorization for FULL requires// `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)// permission on the Queue resource.ResponseViewstring `json:"responseView,omitempty"`// Task: Required. The task to add. Task names have the following format:// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.// The user can optionally specify a task name. If a name is not specified then// the system will generate a random unique task id, which will be set in the// task returned in the response. If 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 ALREADY_EXISTS. The IDs of// deleted tasks are not immediately available for reuse. It can take up to 24// hours (or 9 days if the task's queue was created using a queue.yaml or// queue.xml) for the task ID to be released and made available again. Because// there is an extra lookup cost to identify duplicate task names, these// 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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CreateTaskRequest)MarshalJSON¶

func (sCreateTaskRequest) MarshalJSON() ([]byte,error)

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

type Expr struct {// Description: Optional. Description of the expression. This is a longer text// which describes the expression, e.g. when hovered over it in a UI.Descriptionstring `json:"description,omitempty"`// Expression: Textual representation of an expression in Common Expression// Language syntax.Expressionstring `json:"expression,omitempty"`// Location: Optional. String indicating the location of the expression for// error reporting, e.g. a file name and a position in the file.Locationstring `json:"location,omitempty"`// Title: Optional. Title for the expression, i.e. a short string describing// its purpose. This can be used e.g. in UIs which allow to enter the// expression.Titlestring `json:"title,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Expr)MarshalJSON¶

func (sExpr) MarshalJSON() ([]byte,error)

type GetIamPolicyRequest struct {// Options: OPTIONAL: A `GetPolicyOptions` object for specifying options to// `GetIamPolicy`.Options *GetPolicyOptions `json:"options,omitempty"`// ForceSendFields is a list of field names (e.g. "Options") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Options") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GetIamPolicyRequest)MarshalJSON¶added inv0.10.0

func (sGetIamPolicyRequest) MarshalJSON() ([]byte,error)

type GetPolicyOptions struct {// RequestedPolicyVersion: Optional. The maximum policy version that will be// used to format the policy. Valid values are 0, 1, and 3. Requests specifying// an invalid value will be rejected. Requests for policies with any// conditional role bindings must specify version 3. Policies with no// conditional role bindings may specify any valid value or leave the field// unset. The policy in the response might use the policy version that you// specified, or it might use a lower policy version. For example, if you// specify version 3, but the policy has no conditional role bindings, the// response uses version 1. To learn which resources support conditions in// their IAM policies, see the IAM documentation// (https://cloud.google.com/iam/help/conditions/resource-policies).RequestedPolicyVersionint64 `json:"requestedPolicyVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "RequestedPolicyVersion") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "RequestedPolicyVersion") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GetPolicyOptions)MarshalJSON¶added inv0.10.0

func (sGetPolicyOptions) MarshalJSON() ([]byte,error)

type Header struct {// Key: The key of the header.Keystring `json:"key,omitempty"`// Value: The value of the header.Valuestring `json:"value,omitempty"`// ForceSendFields is a list of field names (e.g. "Key") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Key") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Header)MarshalJSON¶added inv0.88.0

func (sHeader) MarshalJSON() ([]byte,error)

type HeaderOverride struct {// Header: Header embodying a key and a value. Do not put business sensitive or// personally identifying data in the HTTP Header Override Configuration or// other similar fields in accordance with Section 12 (Resource Fields) of the// Service Specific Terms (https://cloud.google.com/terms/service-terms).Header *Header `json:"header,omitempty"`// ForceSendFields is a list of field names (e.g. "Header") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Header") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (HeaderOverride)MarshalJSON¶added inv0.88.0

func (sHeaderOverride) MarshalJSON() ([]byte,error)

type HttpBody struct {// ContentType: The HTTP Content-Type header value specifying the content type// of the body.ContentTypestring `json:"contentType,omitempty"`// Data: The HTTP request/response body as raw binary.Datastring `json:"data,omitempty"`// Extensions: Application specific response metadata. Must be set in the first// response for streaming APIs.Extensions []googleapi.RawMessage `json:"extensions,omitempty"`// ForceSendFields is a list of field names (e.g. "ContentType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ContentType") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (HttpBody)MarshalJSON¶added inv0.88.0

func (sHttpBody) MarshalJSON() ([]byte,error)

type HttpRequest struct {// Body: HTTP request body. A request body is allowed only if the HTTP method// is POST, PUT, or PATCH. It is an error to set body on a task with an// incompatible HttpMethod.Bodystring `json:"body,omitempty"`// Headers: HTTP request headers. This map contains the header field names and// values. Headers can be set when running the task is created or task is// created. These headers represent a subset of the headers that will accompany// the task's HTTP request. Some HTTP request headers will be ignored or// replaced. A partial list of headers that will be ignored or replaced is: *// Any header that is prefixed with "X-CloudTasks-" will be treated as service// header. Service headers define properties of the task and are predefined in// CloudTask. * Host: This will be computed by Cloud Tasks and derived from// HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. *// User-Agent: This will be set to "Google-Cloud-Tasks". * `X-Google-*`:// Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be// set by Cloud Tasks. You can explicitly set `Content-Type` to a media type// when the task is created. For example, `Content-Type` can be set to// "application/octet-stream" or "application/json". Headers which can have// multiple values (according to RFC2616) can be specified using// comma-separated values. The size of the headers must be less than 80KB.Headers map[string]string `json:"headers,omitempty"`// HttpMethod: The HTTP method to use for the request. The default is POST.//// Possible values://   "HTTP_METHOD_UNSPECIFIED" - HTTP method unspecified//   "POST" - HTTP POST//   "GET" - HTTP GET//   "HEAD" - HTTP HEAD//   "PUT" - HTTP PUT//   "DELETE" - HTTP DELETE//   "PATCH" - HTTP PATCH//   "OPTIONS" - HTTP OPTIONSHttpMethodstring `json:"httpMethod,omitempty"`// OauthToken: If specified, an OAuth token// (https://developers.google.com/identity/protocols/OAuth2) will be generated// and attached as an `Authorization` header in the HTTP request. This type of// authorization should generally only be used when calling Google APIs hosted// on *.googleapis.com.OauthToken *OAuthToken `json:"oauthToken,omitempty"`// OidcToken: If specified, an OIDC// (https://developers.google.com/identity/protocols/OpenIDConnect) token will// be generated and attached as an `Authorization` header in the HTTP request.// This type of authorization can be used for many scenarios, including calling// Cloud Run, or endpoints where you intend to validate the token yourself.OidcToken *OidcToken `json:"oidcToken,omitempty"`// Url: Required. The full url path that the request will be sent to. This// string must begin with either "http://" or "https://". Some examples are:// `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will encode// some characters for safety and compatibility. The maximum allowed URL length// is 2083 characters after encoding. The `Location` header response from a// redirect response [`300` - `399`] may be followed. The redirect is not// counted as a separate attempt.Urlstring `json:"url,omitempty"`// ForceSendFields is a list of field names (e.g. "Body") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Body") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (HttpRequest)MarshalJSON¶added inv0.88.0

func (sHttpRequest) MarshalJSON() ([]byte,error)

type HttpTarget struct {// HeaderOverrides: HTTP target headers. This map contains the header field// names and values. Headers will be set when running the task is created// and/or task is created. These headers represent a subset of the headers that// will accompany the task's HTTP request. Some HTTP request headers will be// ignored or replaced. A partial list of headers that will be ignored or// replaced is: * Any header that is prefixed with "X-CloudTasks-" will be// treated as service header. Service headers define properties of the task and// are predefined in CloudTask. * Host: This will be computed by Cloud Tasks// and derived from HttpRequest.url. * Content-Length: This will be computed by// Cloud Tasks. * User-Agent: This will be set to "Google-CloudTasks". *// `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only.// `Content-Type` won't be set by Cloud Tasks. You can explicitly set// `Content-Type` to a media type when the task is created. For example,// `Content-Type` can be set to "application/octet-stream" or// "application/json". Headers which can have multiple values (according to// RFC2616) can be specified using comma-separated values. The size of the// headers must be less than 80KB. Queue-level headers to override headers of// all the tasks in the queue. Do not put business sensitive or personally// identifying data in the HTTP Header Override Configuration or other similar// fields in accordance with Section 12 (Resource Fields) of the Service// Specific Terms (https://cloud.google.com/terms/service-terms).HeaderOverrides []*HeaderOverride `json:"headerOverrides,omitempty"`// HttpMethod: The HTTP method to use for the request. When specified, it// overrides HttpRequest for the task. Note that if the value is set to// HttpMethod the HttpRequest of the task will be ignored at execution time.//// Possible values://   "HTTP_METHOD_UNSPECIFIED" - HTTP method unspecified//   "POST" - HTTP POST//   "GET" - HTTP GET//   "HEAD" - HTTP HEAD//   "PUT" - HTTP PUT//   "DELETE" - HTTP DELETE//   "PATCH" - HTTP PATCH//   "OPTIONS" - HTTP OPTIONSHttpMethodstring `json:"httpMethod,omitempty"`// OauthToken: If specified, an OAuth token// (https://developers.google.com/identity/protocols/OAuth2) is generated and// attached as an `Authorization` header in the HTTP request. This type of// authorization should generally be used only when calling Google APIs hosted// on *.googleapis.com. Note that both the service account email and the scope// MUST be specified when using the queue-level authorization override.OauthToken *OAuthToken `json:"oauthToken,omitempty"`// OidcToken: If specified, an OIDC// (https://developers.google.com/identity/protocols/OpenIDConnect) token is// generated and attached as an `Authorization` header in the HTTP request.// This type of authorization can be used for many scenarios, including calling// Cloud Run, or endpoints where you intend to validate the token yourself.// Note that both the service account email and the audience MUST be specified// when using the queue-level authorization override.OidcToken *OidcToken `json:"oidcToken,omitempty"`// UriOverride: Uri override. When specified, overrides the execution Uri for// all the tasks in the queue.UriOverride *UriOverride `json:"uriOverride,omitempty"`// ForceSendFields is a list of field names (e.g. "HeaderOverrides") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "HeaderOverrides") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (HttpTarget)MarshalJSON¶added inv0.88.0

func (sHttpTarget) MarshalJSON() ([]byte,error)

type LeaseTasksRequest struct {// Filter: `filter` can be used to specify a subset of tasks to lease. When// `filter` is set to `tag=` then the response will contain only tasks whose// tag is equal to “. “ must be less than 500 characters. 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` *// `function = "oldest_tag()" The `oldest_tag()` function returns tasks which// have the same tag as the oldest task (ordered by schedule time). SDK// compatibility: Although the SDK allows tags to be either string or bytes// (https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),// only UTF-8 encoded tags can be used in Cloud Tasks. Tag which aren't UTF-8// encoded can't be used in the filter and the task's tag will be displayed as// empty in Cloud Tasks.Filterstring `json:"filter,omitempty"`// LeaseDuration: Required. The duration of the lease. Each task returned in// the response will have its schedule_time set to the current time plus the// `lease_duration`. The task is leased until its schedule_time; thus, the task// will not be returned to another LeaseTasks call before its schedule_time.// After the worker has successfully finished the work associated with the// task, the worker must call via AcknowledgeTask before the schedule_time.// Otherwise the task will be returned to a later LeaseTasks call so that// another worker can retry it. The maximum lease duration is 1 week.// `lease_duration` will be truncated to the nearest second.LeaseDurationstring `json:"leaseDuration,omitempty"`// MaxTasks: The maximum number of tasks to lease. The system will make a best// effort to return as close to as `max_tasks` as possible. The largest that// `max_tasks` can be is 1000. The maximum total size of a lease tasks response// is 32 MB. If the sum of all task sizes requested reaches this limit, fewer// tasks than requested are returned.MaxTasksint64 `json:"maxTasks,omitempty"`// ResponseView: The response_view specifies which subset of the Task will be// returned. By default response_view is 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 FULL requires// `cloudtasks.tasks.fullView` Google IAM (https://cloud.google.com/iam/)// permission on the Task 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 in// AppEngineHttpRequest and payload in PullMessage). These payloads are// 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.//   "FULL" - All information is returned. Authorization for FULL requires// `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)// permission on the Queue resource.ResponseViewstring `json:"responseView,omitempty"`// ForceSendFields is a list of field names (e.g. "Filter") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (LeaseTasksRequest)MarshalJSON¶

func (sLeaseTasksRequest) MarshalJSON() ([]byte,error)

type LeaseTasksResponse 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 or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (LeaseTasksResponse)MarshalJSON¶

func (sLeaseTasksResponse) MarshalJSON() ([]byte,error)

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.NextPageTokenstring `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ListLocationsResponse)MarshalJSON¶

func (sListLocationsResponse) MarshalJSON() ([]byte,error)

type ListQueuesResponse struct {// NextPageToken: A token to retrieve next page of results. To return the next// page of results, call ListQueues with this value as the page_token. If the// next_page_token is empty, there are no more results. The page token is valid// for only 2 hours.NextPageTokenstring `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ListQueuesResponse)MarshalJSON¶

func (sListQueuesResponse) MarshalJSON() ([]byte,error)

type ListTasksResponse struct {// NextPageToken: A token to retrieve next page of results. To return the next// page of results, call ListTasks with this value as the page_token. If the// next_page_token is empty, there are no more results.NextPageTokenstring `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ListTasksResponse)MarshalJSON¶

func (sListTasksResponse) MarshalJSON() ([]byte,error)

type Location struct {// DisplayName: The friendly name for this location, typically a nearby city// name. For example, "Tokyo".DisplayNamestring `json:"displayName,omitempty"`// 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".LocationIdstring `json:"locationId,omitempty"`// Metadata: Service-specific metadata. For example the available capacity at// the given location.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: Resource name for the location, which may vary between// implementations. For example:// "projects/example-project/locations/us-east1"Namestring `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. "DisplayName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DisplayName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Location)MarshalJSON¶

func (sLocation) MarshalJSON() ([]byte,error)

type OAuthToken struct {// Scope: OAuth scope to be used for generating OAuth access token. If not// specified, "https://www.googleapis.com/auth/cloud-platform" will be used.Scopestring `json:"scope,omitempty"`// ServiceAccountEmail: Service account email// (https://cloud.google.com/iam/docs/service-accounts) to be used for// generating OAuth token. The service account must be within the same project// as the queue. The caller must have iam.serviceAccounts.actAs permission for// the service account.ServiceAccountEmailstring `json:"serviceAccountEmail,omitempty"`// ForceSendFields is a list of field names (e.g. "Scope") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Scope") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (OAuthToken)MarshalJSON¶added inv0.88.0

func (sOAuthToken) MarshalJSON() ([]byte,error)

type OidcToken struct {// Audience: Audience to be used when generating OIDC token. If not specified,// the URI specified in target will be used.Audiencestring `json:"audience,omitempty"`// ServiceAccountEmail: Service account email// (https://cloud.google.com/iam/docs/service-accounts) to be used for// generating OIDC token. The service account must be within the same project// as the queue. The caller must have iam.serviceAccounts.actAs permission for// the service account.ServiceAccountEmailstring `json:"serviceAccountEmail,omitempty"`// ForceSendFields is a list of field names (e.g. "Audience") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Audience") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (OidcToken)MarshalJSON¶added inv0.88.0

func (sOidcToken) MarshalJSON() ([]byte,error)

type PathOverride struct {// Path: The URI path (e.g., /users/1234). Default is an empty string.Pathstring `json:"path,omitempty"`// ForceSendFields is a list of field names (e.g. "Path") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Path") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (PathOverride)MarshalJSON¶added inv0.107.0

func (sPathOverride) MarshalJSON() ([]byte,error)

type PauseQueueRequest struct {}

type Policy struct {// Bindings: Associates a list of `members`, or principals, with a `role`.// Optionally, may specify a `condition` that determines how and when the// `bindings` are applied. Each of the `bindings` must contain at least one// principal. The `bindings` in a `Policy` can refer to up to 1,500 principals;// up to 250 of these principals can be Google groups. Each occurrence of a// principal counts towards these limits. For example, if the `bindings` grant// 50 different roles to `user:alice@example.com`, and not to any other// principal, then you can add another 1,450 principals to the `bindings` in// the `Policy`.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.// **Important:** If you use IAM Conditions, you must include the `etag` field// whenever you call `setIamPolicy`. If you omit this field, then IAM allows// you to overwrite a version `3` policy with a version `1` policy, and all of// the conditions in the version `3` policy are lost.Etagstring `json:"etag,omitempty"`// Version: Specifies the format of the policy. Valid values are `0`, `1`, and// `3`. Requests that specify an invalid value are rejected. Any operation that// affects conditional role bindings must specify version `3`. This requirement// applies to the following operations: * Getting a policy that includes a// conditional role binding * Adding a conditional role binding to a policy *// Changing a conditional role binding in a policy * Removing any role binding,// with or without a condition, from a policy that includes conditions// **Important:** If you use IAM Conditions, you must include the `etag` field// whenever you call `setIamPolicy`. If you omit this field, then IAM allows// you to overwrite a version `3` policy with a version `1` policy, and all of// the conditions in the version `3` policy are lost. If a policy does not// include any conditions, operations on that policy may specify any valid// version or leave the field unset. To learn which resources support// conditions in their IAM policies, see the IAM documentation// (https://cloud.google.com/iam/help/conditions/resource-policies).Versionint64 `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Policy)MarshalJSON¶

func (sPolicy) MarshalJSON() ([]byte,error)

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

func (*ProjectsLocationsGetCall)Context¶

func (c *ProjectsLocationsGetCall) Context(ctxcontext.Context) *ProjectsLocationsGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGetCall)Do¶

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

Do executes the "cloudtasks.projects.locations.get" call.Any non-2xx status code is an error. Response headers are in either*Location.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsGetCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsGetCall)IfNoneMatch¶

func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTagstring) *ProjectsLocationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

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

func (*ProjectsLocationsGetCmekConfigCall)Context¶added inv0.142.0

func (c *ProjectsLocationsGetCmekConfigCall) Context(ctxcontext.Context) *ProjectsLocationsGetCmekConfigCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGetCmekConfigCall)Do¶added inv0.142.0

func (c *ProjectsLocationsGetCmekConfigCall) Do(opts ...googleapi.CallOption) (*CmekConfig,error)

Do executes the "cloudtasks.projects.locations.getCmekConfig" call.Any non-2xx status code is an error. Response headers are in either*CmekConfig.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsGetCmekConfigCall)Fields¶added inv0.142.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsGetCmekConfigCall)Header¶added inv0.142.0

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsGetCmekConfigCall)IfNoneMatch¶added inv0.142.0

func (c *ProjectsLocationsGetCmekConfigCall) IfNoneMatch(entityTagstring) *ProjectsLocationsGetCmekConfigCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

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

func (*ProjectsLocationsListCall)Context¶

func (c *ProjectsLocationsListCall) Context(ctxcontext.Context) *ProjectsLocationsListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsListCall)Do¶

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

Do executes the "cloudtasks.projects.locations.list" call.Any non-2xx status code is an error. Response headers are in either*ListLocationsResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsListCall)ExtraLocationTypes¶added inv0.230.0

func (c *ProjectsLocationsListCall) ExtraLocationTypes(extraLocationTypes ...string) *ProjectsLocationsListCall

ExtraLocationTypes sets the optional parameter "extraLocationTypes": Do notuse this field. It is unsupported and is ignored unless explicitlydocumented otherwise. This is primarily for internal usage.

func (*ProjectsLocationsListCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsListCall)Filter¶

func (c *ProjectsLocationsListCall) Filter(filterstring) *ProjectsLocationsListCall

Filter sets the optional parameter "filter": A filter to narrow down resultsto a preferred subset. The filtering language accepts strings like"displayName=tokyo", and is documented in more detail in AIP-160(https://google.aip.dev/160).

func (*ProjectsLocationsListCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsListCall)IfNoneMatch¶

func (c *ProjectsLocationsListCall) IfNoneMatch(entityTagstring) *ProjectsLocationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsListCall)PageSize¶

func (c *ProjectsLocationsListCall) PageSize(pageSizeint64) *ProjectsLocationsListCall

PageSize sets the optional parameter "pageSize": The maximum number ofresults to return. If not set, the service selects a default.

func (*ProjectsLocationsListCall)PageToken¶

func (c *ProjectsLocationsListCall) PageToken(pageTokenstring) *ProjectsLocationsListCall

PageToken sets the optional parameter "pageToken": A page token receivedfrom the `next_page_token` field in the response. Send that page token toreceive the subsequent page.

func (*ProjectsLocationsListCall)Pages¶

func (c *ProjectsLocationsListCall) Pages(ctxcontext.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 struct {// contains filtered or unexported fields}

func (*ProjectsLocationsQueuesCreateCall)Context¶

func (c *ProjectsLocationsQueuesCreateCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesCreateCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesCreateCall)Do¶

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

Do executes the "cloudtasks.projects.locations.queues.create" call.Any non-2xx status code is an error. Response headers are in either*Queue.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesCreateCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

func (*ProjectsLocationsQueuesDeleteCall)Context¶

func (c *ProjectsLocationsQueuesDeleteCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesDeleteCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesDeleteCall)Do¶

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

Do executes the "cloudtasks.projects.locations.queues.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesDeleteCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

func (*ProjectsLocationsQueuesGetCall)Context¶

func (c *ProjectsLocationsQueuesGetCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesGetCall)Do¶

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

Do executes the "cloudtasks.projects.locations.queues.get" call.Any non-2xx status code is an error. Response headers are in either*Queue.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesGetCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsQueuesGetCall)IfNoneMatch¶

func (c *ProjectsLocationsQueuesGetCall) IfNoneMatch(entityTagstring) *ProjectsLocationsQueuesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsQueuesGetCall)ReadMask¶added inv0.22.0

func (c *ProjectsLocationsQueuesGetCall) ReadMask(readMaskstring) *ProjectsLocationsQueuesGetCall

ReadMask sets the optional parameter "readMask": Read mask is used for amore granular control over what the API returns. If the mask is not presentall fields will be returned except [Queue.stats]. [Queue.stats] will bereturned only if it was explicitly specified in the mask.

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

func (*ProjectsLocationsQueuesGetIamPolicyCall)Context¶

func (c *ProjectsLocationsQueuesGetIamPolicyCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesGetIamPolicyCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesGetIamPolicyCall)Do¶

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

Do executes the "cloudtasks.projects.locations.queues.getIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesGetIamPolicyCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

func (*ProjectsLocationsQueuesListCall)Context¶

func (c *ProjectsLocationsQueuesListCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesListCall)Do¶

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

Do executes the "cloudtasks.projects.locations.queues.list" call.Any non-2xx status code is an error. Response headers are in either*ListQueuesResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsQueuesListCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesListCall)Filter¶

func (c *ProjectsLocationsQueuesListCall) Filter(filterstring) *ProjectsLocationsQueuesListCall

Filter sets the optional parameter "filter": `filter` can be used to specifya subset of queues. Any Queue field can be used as a filter and severaloperators as supported. For example: `<=, <, >=, >, !=, =, :`. The filtersyntax is the same as described in Stackdriver's Advanced Logs Filters(https://cloud.google.com/logging/docs/view/advanced_filters). Sample filter"app_engine_http_target: *". Note that using filters might cause fewerqueues than the requested_page size to be returned.

func (*ProjectsLocationsQueuesListCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsQueuesListCall)IfNoneMatch¶

func (c *ProjectsLocationsQueuesListCall) IfNoneMatch(entityTagstring) *ProjectsLocationsQueuesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsQueuesListCall)PageSize¶

func (c *ProjectsLocationsQueuesListCall) PageSize(pageSizeint64) *ProjectsLocationsQueuesListCall

PageSize sets the optional parameter "pageSize": Requested page size. Themaximum page size is 9800. If unspecified, the page size will be themaximum. Fewer queues than requested might be returned, even if more queuesexist; use the next_page_token in the response to determine if more queuesexist.

func (*ProjectsLocationsQueuesListCall)PageToken¶

func (c *ProjectsLocationsQueuesListCall) PageToken(pageTokenstring) *ProjectsLocationsQueuesListCall

PageToken sets the optional parameter "pageToken": A token identifying thepage of results to return. To request the first page results, page_tokenmust be empty. To request the next page of results, page_token must be thevalue of next_page_token returned from the previous call to ListQueuesmethod. It is an error to switch the value of the filter while iteratingthrough pages.

func (*ProjectsLocationsQueuesListCall)Pages¶

func (c *ProjectsLocationsQueuesListCall) Pages(ctxcontext.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.

func (*ProjectsLocationsQueuesListCall)ReadMask¶added inv0.36.0

func (c *ProjectsLocationsQueuesListCall) ReadMask(readMaskstring) *ProjectsLocationsQueuesListCall

ReadMask sets the optional parameter "readMask": Read mask is used for amore granular control over what the API returns. If the mask is not presentall fields will be returned except [Queue.stats]. [Queue.stats] will bereturned only if it was explicitly specified in the mask.

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

func (*ProjectsLocationsQueuesPatchCall)Context¶

func (c *ProjectsLocationsQueuesPatchCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesPatchCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesPatchCall)Do¶

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

Do executes the "cloudtasks.projects.locations.queues.patch" call.Any non-2xx status code is an error. Response headers are in either*Queue.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesPatchCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsQueuesPatchCall)UpdateMask¶

func (c *ProjectsLocationsQueuesPatchCall) UpdateMask(updateMaskstring) *ProjectsLocationsQueuesPatchCall

UpdateMask sets the optional parameter "updateMask": A mask used to specifywhich fields of the queue are being updated. If empty, then all fields willbe updated.

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

func (*ProjectsLocationsQueuesPauseCall)Context¶

func (c *ProjectsLocationsQueuesPauseCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesPauseCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesPauseCall)Do¶

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

Do executes the "cloudtasks.projects.locations.queues.pause" call.Any non-2xx status code is an error. Response headers are in either*Queue.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesPauseCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

func (*ProjectsLocationsQueuesPurgeCall)Context¶

func (c *ProjectsLocationsQueuesPurgeCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesPurgeCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesPurgeCall)Do¶

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

Do executes the "cloudtasks.projects.locations.queues.purge" call.Any non-2xx status code is an error. Response headers are in either*Queue.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesPurgeCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

func (*ProjectsLocationsQueuesResumeCall)Context¶

func (c *ProjectsLocationsQueuesResumeCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesResumeCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesResumeCall)Do¶

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

Do executes the "cloudtasks.projects.locations.queues.resume" call.Any non-2xx status code is an error. Response headers are in either*Queue.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesResumeCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

funcNewProjectsLocationsQueuesService¶

func NewProjectsLocationsQueuesService(s *Service) *ProjectsLocationsQueuesService

func (*ProjectsLocationsQueuesService)Create¶

func (r *ProjectsLocationsQueuesService) Create(parentstring, queue *Queue) *ProjectsLocationsQueuesCreateCall

Create: Creates a queue. Queues created with this method allow tasks to livefor a maximum of 31 days. After a task is 31 days old, the task will bedeleted regardless of whether it was dispatched or not. WARNING: Using thismethod may have unintended side effects if you are using an App Engine`queue.yaml` or `queue.xml` file to manage your queues. Read Overview ofQueue Management and queue.yaml(https://cloud.google.com/tasks/docs/queue-yaml) before using this method.

• parent: The location name in which the queue will be created. For example:`projects/PROJECT_ID/locations/LOCATION_ID` The list of allowed locationscan be obtained by calling Cloud Tasks' implementation of ListLocations.

func (*ProjectsLocationsQueuesService)Delete¶

func (r *ProjectsLocationsQueuesService) Delete(namestring) *ProjectsLocationsQueuesDeleteCall

Delete: Deletes a queue. This command will delete the queue even if it hastasks in it. Note: If you delete a queue, you may be prevented from creatinga new queue with the same name as the deleted queue for a tombstone windowof up to 3 days. During this window, the CreateQueue operation may appear torecreate the queue, but this can be misleading. If you attempt to create aqueue with the same name as one that is in the tombstone window, runGetQueue to confirm that the queue creation was successful. If GetQueuereturns 200 response code, your queue was successfully created with the nameof the previously deleted queue. Otherwise, your queue did not successfullyrecreate. WARNING: Using this method may have unintended side effects if youare using an App Engine `queue.yaml` or `queue.xml` file to manage yourqueues. Read Overview of Queue Management and queue.yaml(https://cloud.google.com/tasks/docs/queue-yaml) before using this method.

• name: The queue name. For example:`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`.

func (*ProjectsLocationsQueuesService)Get¶

func (r *ProjectsLocationsQueuesService) Get(namestring) *ProjectsLocationsQueuesGetCall

Get: Gets a queue.

• name: The resource name of the queue. For example:`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`.

func (*ProjectsLocationsQueuesService)GetIamPolicy¶

func (r *ProjectsLocationsQueuesService) GetIamPolicy(resourcestring, getiampolicyrequest *GetIamPolicyRequest) *ProjectsLocationsQueuesGetIamPolicyCall

GetIamPolicy: Gets the access control policy for a Queue. Returns an emptypolicy if the resource exists and does not have a policy set. Authorizationrequires the following Google IAM (https://cloud.google.com/iam) permissionon the specified resource parent: * `cloudtasks.queues.getIamPolicy`

• resource: REQUIRED: The resource for which the policy is being requested.See Resource names (https://cloud.google.com/apis/design/resource_names)for the appropriate value for this field.

func (*ProjectsLocationsQueuesService)List¶

func (r *ProjectsLocationsQueuesService) List(parentstring) *ProjectsLocationsQueuesListCall

List: Lists queues. Queues are returned in lexicographical order.

• parent: The location name. For example:`projects/PROJECT_ID/locations/LOCATION_ID`.

func (*ProjectsLocationsQueuesService)Patch¶

func (r *ProjectsLocationsQueuesService) Patch(namestring, queue *Queue) *ProjectsLocationsQueuesPatchCall

Patch: Updates a queue. This method creates the queue if it does not existand updates the queue if it does exist. Queues created with this methodallow tasks to live for a maximum of 31 days. After a task is 31 days old,the task will be deleted regardless of whether it was dispatched or not.WARNING: Using this method may have unintended side effects if you are usingan App Engine `queue.yaml` or `queue.xml` file to manage your queues. ReadOverview of Queue Management and queue.yaml(https://cloud.google.com/tasks/docs/queue-yaml) before using this method.

• name: Caller-specified and required in CreateQueue, after which it becomesoutput only. The queue name. The queue name must have the followingformat: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` *`PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-),colons (:), or periods (.). For more information, see Identifying projects(https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
• `LOCATION_ID` is the canonical ID for the queue's location. The list ofavailable locations can be obtained by calling ListLocations. For moreinformation, seehttps://cloud.google.com/about/locations/. * `QUEUE_ID`can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). Themaximum length is 100 characters.

func (*ProjectsLocationsQueuesService)Pause¶

func (r *ProjectsLocationsQueuesService) Pause(namestring, pausequeuerequest *PauseQueueRequest) *ProjectsLocationsQueuesPauseCall

Pause: Pauses the queue. If a queue is paused then the system will stopdispatching tasks until the queue is resumed via ResumeQueue. Tasks canstill be added when the queue is paused. A queue is paused if its state isPAUSED.

• name: The queue name. For example:`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`.

func (*ProjectsLocationsQueuesService)Purge¶

func (r *ProjectsLocationsQueuesService) Purge(namestring, purgequeuerequest *PurgeQueueRequest) *ProjectsLocationsQueuesPurgeCall

Purge: Purges a queue by deleting all of its tasks. All tasks created beforethis method is called are permanently deleted. Purge operations can take upto one minute to take effect. Tasks might be dispatched before the purgetakes effect. A purge is irreversible.

• name: The queue name. For example:`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`.

func (*ProjectsLocationsQueuesService)Resume¶

func (r *ProjectsLocationsQueuesService) Resume(namestring, resumequeuerequest *ResumeQueueRequest) *ProjectsLocationsQueuesResumeCall

Resume: Resume a queue. This method resumes a queue after it has been PAUSEDor DISABLED. The state of a queue is stored in the queue's state; aftercalling this method it will be set to RUNNING. WARNING: Resuming manyhigh-QPS queues at the same time can lead to target overloading. If you areresuming high-QPS queues, follow the 500/50/5 pattern described in ManagingCloud Tasks Scaling Risks(https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).

• name: The queue name. For example:`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`.

func (*ProjectsLocationsQueuesService)SetIamPolicy¶

func (r *ProjectsLocationsQueuesService) SetIamPolicy(resourcestring, setiampolicyrequest *SetIamPolicyRequest) *ProjectsLocationsQueuesSetIamPolicyCall

SetIamPolicy: Sets the access control policy for a Queue. Replaces anyexisting policy. Note: The Cloud Console does not check queue-level IAMpermissions yet. Project-level permissions are required to use the CloudConsole. Authorization requires the following Google IAM(https://cloud.google.com/iam) permission on the specified resource parent:* `cloudtasks.queues.setIamPolicy`

• resource: REQUIRED: The resource for which the policy is being specified.See Resource names (https://cloud.google.com/apis/design/resource_names)for the appropriate value for this field.

func (*ProjectsLocationsQueuesService)TestIamPermissions¶

func (r *ProjectsLocationsQueuesService) TestIamPermissions(resourcestring, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsLocationsQueuesTestIamPermissionsCall

TestIamPermissions: Returns permissions that a caller has on a Queue. If theresource does not exist, this will return an empty set of permissions, not aNOT_FOUND error. Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorization checking.This operation may "fail open" without warning.

• resource: REQUIRED: The resource for which the policy detail is beingrequested. See Resource names(https://cloud.google.com/apis/design/resource_names) for the appropriatevalue for this field.

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

func (*ProjectsLocationsQueuesSetIamPolicyCall)Context¶

func (c *ProjectsLocationsQueuesSetIamPolicyCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesSetIamPolicyCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesSetIamPolicyCall)Do¶

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

Do executes the "cloudtasks.projects.locations.queues.setIamPolicy" call.Any non-2xx status code is an error. Response headers are in either*Policy.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesSetIamPolicyCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

func (*ProjectsLocationsQueuesTasksAcknowledgeCall)Context¶

func (c *ProjectsLocationsQueuesTasksAcknowledgeCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesTasksAcknowledgeCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesTasksAcknowledgeCall)Do¶

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

Do executes the "cloudtasks.projects.locations.queues.tasks.acknowledge" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesTasksAcknowledgeCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

func (*ProjectsLocationsQueuesTasksBufferCall)Context¶added inv0.96.0

func (c *ProjectsLocationsQueuesTasksBufferCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesTasksBufferCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesTasksBufferCall)Do¶added inv0.96.0

func (c *ProjectsLocationsQueuesTasksBufferCall) Do(opts ...googleapi.CallOption) (*BufferTaskResponse,error)

Do executes the "cloudtasks.projects.locations.queues.tasks.buffer" call.Any non-2xx status code is an error. Response headers are in either*BufferTaskResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsQueuesTasksBufferCall)Fields¶added inv0.96.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesTasksBufferCall)Header¶added inv0.96.0

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

func (*ProjectsLocationsQueuesTasksCancelLeaseCall)Context¶

func (c *ProjectsLocationsQueuesTasksCancelLeaseCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesTasksCancelLeaseCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesTasksCancelLeaseCall)Do¶

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

Do executes the "cloudtasks.projects.locations.queues.tasks.cancelLease" call.Any non-2xx status code is an error. Response headers are in either*Task.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesTasksCancelLeaseCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

func (*ProjectsLocationsQueuesTasksCreateCall)Context¶

func (c *ProjectsLocationsQueuesTasksCreateCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesTasksCreateCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesTasksCreateCall)Do¶

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

Do executes the "cloudtasks.projects.locations.queues.tasks.create" call.Any non-2xx status code is an error. Response headers are in either*Task.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesTasksCreateCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

func (*ProjectsLocationsQueuesTasksDeleteCall)Context¶

func (c *ProjectsLocationsQueuesTasksDeleteCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesTasksDeleteCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesTasksDeleteCall)Do¶

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

Do executes the "cloudtasks.projects.locations.queues.tasks.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesTasksDeleteCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

func (*ProjectsLocationsQueuesTasksGetCall)Context¶

func (c *ProjectsLocationsQueuesTasksGetCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesTasksGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesTasksGetCall)Do¶

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

Do executes the "cloudtasks.projects.locations.queues.tasks.get" call.Any non-2xx status code is an error. Response headers are in either*Task.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesTasksGetCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsQueuesTasksGetCall)IfNoneMatch¶

func (c *ProjectsLocationsQueuesTasksGetCall) IfNoneMatch(entityTagstring) *ProjectsLocationsQueuesTasksGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsQueuesTasksGetCall)ResponseView¶

func (c *ProjectsLocationsQueuesTasksGetCall) ResponseView(responseViewstring) *ProjectsLocationsQueuesTasksGetCall

ResponseView sets the optional parameter "responseView": The response_viewspecifies which subset of the Task will be returned. By defaultresponse_view is BASIC; not all information is retrieved by default becausesome data, such as payloads, might be desirable to return only when neededbecause of its large size or because of the sensitivity of data that itcontains. Authorization for FULL requires `cloudtasks.tasks.fullView` GoogleIAM (https://cloud.google.com/iam/) permission on the Task 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 inAppEngineHttpRequest and payload in PullMessage). These payloads aredesirable to return only when needed, because they can be large and becauseof the sensitivity of the data that you choose to store in it.

"FULL" - All information is returned. Authorization for FULL requires

`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)permission on the Queue resource.

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

func (*ProjectsLocationsQueuesTasksLeaseCall)Context¶

func (c *ProjectsLocationsQueuesTasksLeaseCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesTasksLeaseCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesTasksLeaseCall)Do¶

func (c *ProjectsLocationsQueuesTasksLeaseCall) Do(opts ...googleapi.CallOption) (*LeaseTasksResponse,error)

Do executes the "cloudtasks.projects.locations.queues.tasks.lease" call.Any non-2xx status code is an error. Response headers are in either*LeaseTasksResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsQueuesTasksLeaseCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesTasksLeaseCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

func (*ProjectsLocationsQueuesTasksListCall)Context¶

func (c *ProjectsLocationsQueuesTasksListCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesTasksListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesTasksListCall)Do¶

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

Do executes the "cloudtasks.projects.locations.queues.tasks.list" call.Any non-2xx status code is an error. Response headers are in either*ListTasksResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsQueuesTasksListCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesTasksListCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsQueuesTasksListCall)IfNoneMatch¶

func (c *ProjectsLocationsQueuesTasksListCall) IfNoneMatch(entityTagstring) *ProjectsLocationsQueuesTasksListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsLocationsQueuesTasksListCall)PageSize¶

func (c *ProjectsLocationsQueuesTasksListCall) PageSize(pageSizeint64) *ProjectsLocationsQueuesTasksListCall

PageSize sets the optional parameter "pageSize": Maximum page size. Fewertasks than requested might be returned, even if more tasks exist; usenext_page_token in the response to determine if more tasks exist. Themaximum page size is 1000. If unspecified, the page size will be themaximum.

func (*ProjectsLocationsQueuesTasksListCall)PageToken¶

func (c *ProjectsLocationsQueuesTasksListCall) PageToken(pageTokenstring) *ProjectsLocationsQueuesTasksListCall

PageToken sets the optional parameter "pageToken": A token identifying thepage of results to return. To request the first page results, page_tokenmust be empty. To request the next page of results, page_token must be thevalue of next_page_token returned from the previous call to ListTasksmethod. The page token is valid for only 2 hours.

func (*ProjectsLocationsQueuesTasksListCall)Pages¶

func (c *ProjectsLocationsQueuesTasksListCall) Pages(ctxcontext.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(responseViewstring) *ProjectsLocationsQueuesTasksListCall

ResponseView sets the optional parameter "responseView": The response_viewspecifies which subset of the Task will be returned. By defaultresponse_view is BASIC; not all information is retrieved by default becausesome data, such as payloads, might be desirable to return only when neededbecause of its large size or because of the sensitivity of data that itcontains. Authorization for FULL requires `cloudtasks.tasks.fullView` GoogleIAM (https://cloud.google.com/iam/) permission on the Task 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 inAppEngineHttpRequest and payload in PullMessage). These payloads aredesirable to return only when needed, because they can be large and becauseof the sensitivity of the data that you choose to store in it.

"FULL" - All information is returned. Authorization for FULL requires

`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)permission on the Queue resource.

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

func (*ProjectsLocationsQueuesTasksRenewLeaseCall)Context¶

func (c *ProjectsLocationsQueuesTasksRenewLeaseCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesTasksRenewLeaseCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesTasksRenewLeaseCall)Do¶

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

Do executes the "cloudtasks.projects.locations.queues.tasks.renewLease" call.Any non-2xx status code is an error. Response headers are in either*Task.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesTasksRenewLeaseCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

func (*ProjectsLocationsQueuesTasksRunCall)Context¶

func (c *ProjectsLocationsQueuesTasksRunCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesTasksRunCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesTasksRunCall)Do¶

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

Do executes the "cloudtasks.projects.locations.queues.tasks.run" call.Any non-2xx status code is an error. Response headers are in either*Task.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether 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. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesTasksRunCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

funcNewProjectsLocationsQueuesTasksService¶

func NewProjectsLocationsQueuesTasksService(s *Service) *ProjectsLocationsQueuesTasksService

func (*ProjectsLocationsQueuesTasksService)Acknowledge¶

func (r *ProjectsLocationsQueuesTasksService) Acknowledge(namestring, acknowledgetaskrequest *AcknowledgeTaskRequest) *ProjectsLocationsQueuesTasksAcknowledgeCall

Acknowledge: Acknowledges a pull task. The worker, that is, the entity thatleased this task must call this method to indicate that the work associatedwith the task has finished. The worker must acknowledge a task within thelease_duration or the lease will expire and the task will become availableto be leased again. After the task is acknowledged, it will not be returnedby a later LeaseTasks, GetTask, or ListTasks.

• name: The task name. For example:`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.

func (*ProjectsLocationsQueuesTasksService)Buffer¶added inv0.96.0

func (r *ProjectsLocationsQueuesTasksService) Buffer(queuestring, taskIdstring, buffertaskrequest *BufferTaskRequest) *ProjectsLocationsQueuesTasksBufferCall

Buffer: Creates and buffers a new task without the need to explicitly definea Task message. The queue must have HTTP target. To create the task with acustom ID, use the following format and set TASK_ID to your desired ID:projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID:buffer To create the task with an automatically generated ID, use the followingformat:projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks:buffer.

• queue: The parent queue name. For example:projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue mustalready exist.
• taskId: Optional. Task ID for the task being created. If not provided, arandom task ID is assigned to the task.

func (*ProjectsLocationsQueuesTasksService)CancelLease¶

func (r *ProjectsLocationsQueuesTasksService) CancelLease(namestring, cancelleaserequest *CancelLeaseRequest) *ProjectsLocationsQueuesTasksCancelLeaseCall

CancelLease: Cancel a pull task's lease. The worker can use this method tocancel a task's lease by setting its schedule_time to now. This will makethe task available to be leased to the next caller of LeaseTasks.

• name: The task name. For example:`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.

func (*ProjectsLocationsQueuesTasksService)Create¶

func (r *ProjectsLocationsQueuesTasksService) Create(parentstring, createtaskrequest *CreateTaskRequest) *ProjectsLocationsQueuesTasksCreateCall

Create: Creates a task and adds it to a queue. Tasks cannot be updated aftercreation; there is no UpdateTask command. * For App Engine queues, themaximum task size is 100KB. * For pull queues, the maximum task size is 1MB.

• parent: The queue name. For example:`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue mustalready exist.

func (*ProjectsLocationsQueuesTasksService)Delete¶

func (r *ProjectsLocationsQueuesTasksService) Delete(namestring) *ProjectsLocationsQueuesTasksDeleteCall

Delete: Deletes a task. A task can be deleted if it is scheduled ordispatched. A task cannot be deleted if it has completed successfully orpermanently failed.

• name: The task name. For example:`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.

func (*ProjectsLocationsQueuesTasksService)Get¶

func (r *ProjectsLocationsQueuesTasksService) Get(namestring) *ProjectsLocationsQueuesTasksGetCall

Get: Gets a task.

• name: The task name. For example:`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.

func (*ProjectsLocationsQueuesTasksService)Lease¶

func (r *ProjectsLocationsQueuesTasksService) Lease(parentstring, leasetasksrequest *LeaseTasksRequest) *ProjectsLocationsQueuesTasksLeaseCall

Lease: Leases tasks from a pull queue for lease_duration. This method isinvoked by the worker to obtain a lease. The worker must acknowledge thetask via AcknowledgeTask after they have performed the work associated withthe task. The payload is intended to store data that the worker needs toperform the work associated with the task. To return the payloads in theresponse, set response_view to FULL. A maximum of 10 qps of LeaseTasksrequests are allowed per queue. RESOURCE_EXHAUSTED is returned when thislimit is exceeded. RESOURCE_EXHAUSTED is also returned whenmax_tasks_dispatched_per_second is exceeded.

• parent: The queue name. For example:`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`.

func (*ProjectsLocationsQueuesTasksService)List¶

func (r *ProjectsLocationsQueuesTasksService) List(parentstring) *ProjectsLocationsQueuesTasksListCall

List: Lists the tasks in a queue. By default, only the BASIC view isretrieved due to performance considerations; response_view controls thesubset of information which is returned. The tasks may be returned in anyorder. The ordering may change at any time.

• parent: The queue name. For example:`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`.

func (*ProjectsLocationsQueuesTasksService)RenewLease¶

func (r *ProjectsLocationsQueuesTasksService) RenewLease(namestring, renewleaserequest *RenewLeaseRequest) *ProjectsLocationsQueuesTasksRenewLeaseCall

RenewLease: Renew the current lease of a pull task. The worker can use thismethod to extend the lease by a new duration, starting from now. The newtask lease will be returned in the task's schedule_time.

• name: The task name. For example:`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.

func (*ProjectsLocationsQueuesTasksService)Run¶

func (r *ProjectsLocationsQueuesTasksService) Run(namestring, runtaskrequest *RunTaskRequest) *ProjectsLocationsQueuesTasksRunCall

Run: Forces a task to run now. When this method is called, Cloud Tasks willdispatch the task, even if the task is already running, the queue hasreached its RateLimits or is PAUSED. This command is meant to be used formanual debugging. For example, RunTask can be used to retry a failed taskafter a fix has been made or to manually force a task to be dispatched now.The dispatched task is returned. That is, the task that is returned containsthe status after the task is dispatched but before the task is received byits target. If Cloud Tasks receives a successful response from the task'starget, then the task will be deleted; otherwise the task's schedule_timewill be reset to the time that RunTask was called plus the retry delayspecified in the queue's RetryConfig. RunTask returns NOT_FOUND when it iscalled on a task that has already succeeded or permanently failed. RunTaskcannot be called on a pull task.

• name: The task name. For example:`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.

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

func (*ProjectsLocationsQueuesTestIamPermissionsCall)Context¶

func (c *ProjectsLocationsQueuesTestIamPermissionsCall) Context(ctxcontext.Context) *ProjectsLocationsQueuesTestIamPermissionsCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsQueuesTestIamPermissionsCall)Do¶

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

Do executes the "cloudtasks.projects.locations.queues.testIamPermissions" call.Any non-2xx status code is an error. Response headers are in either*TestIamPermissionsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsQueuesTestIamPermissionsCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsQueuesTestIamPermissionsCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

funcNewProjectsLocationsService¶

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService)Get¶

func (r *ProjectsLocationsService) Get(namestring) *ProjectsLocationsGetCall

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService)GetCmekConfig¶added inv0.142.0

func (r *ProjectsLocationsService) GetCmekConfig(namestring) *ProjectsLocationsGetCmekConfigCall

GetCmekConfig: Gets the CMEK config. Gets the Customer Managed EncryptionKey configured with the Cloud Tasks lcoation. By default there is no kms_keyconfigured.

• name: The config. For example:projects/PROJECT_ID/locations/LOCATION_ID/CmekConfig`.

func (*ProjectsLocationsService)List¶

func (r *ProjectsLocationsService) List(namestring) *ProjectsLocationsListCall

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

- name: The resource that owns the locations collection, if applicable.

func (*ProjectsLocationsService)UpdateCmekConfig¶added inv0.142.0

func (r *ProjectsLocationsService) UpdateCmekConfig(namestring, cmekconfig *CmekConfig) *ProjectsLocationsUpdateCmekConfigCall

UpdateCmekConfig: Creates or Updates a CMEK config. Updates the CustomerManaged Encryption Key assotiated with the Cloud Tasks location (Creates ifthe key does not already exist). All new tasks created in the location willbe encrypted at-rest with the KMS-key provided in the config.

• name: Output only. The config resource name which includes the project andlocation and must end in 'cmekConfig', in the formatprojects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`.

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

func (*ProjectsLocationsUpdateCmekConfigCall)Context¶added inv0.142.0

func (c *ProjectsLocationsUpdateCmekConfigCall) Context(ctxcontext.Context) *ProjectsLocationsUpdateCmekConfigCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsUpdateCmekConfigCall)Do¶added inv0.142.0

func (c *ProjectsLocationsUpdateCmekConfigCall) Do(opts ...googleapi.CallOption) (*CmekConfig,error)

Do executes the "cloudtasks.projects.locations.updateCmekConfig" call.Any non-2xx status code is an error. Response headers are in either*CmekConfig.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsUpdateCmekConfigCall)Fields¶added inv0.142.0

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsUpdateCmekConfigCall)Header¶added inv0.142.0

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsLocationsUpdateCmekConfigCall)UpdateMask¶added inv0.142.0

func (c *ProjectsLocationsUpdateCmekConfigCall) UpdateMask(updateMaskstring) *ProjectsLocationsUpdateCmekConfigCall

UpdateMask sets the optional parameter "updateMask": List of fields to beupdated in this request.

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

funcNewProjectsService¶

func NewProjectsService(s *Service) *ProjectsService

type PullMessage struct {// Payload: A data payload consumed by the worker to execute the task.Payloadstring `json:"payload,omitempty"`// Tag: The task's tag. Tags allow similar tasks to be processed in a batch. If// you label tasks with a tag, your worker can lease tasks with the same tag// using filter. For example, if you want to aggregate the events associated// with a specific user once a day, you could tag tasks with the user ID. The// task's tag can only be set when the task is created. The tag must be less// than 500 characters. SDK compatibility: Although the SDK allows tags to be// either string or bytes// (https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),// only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8// encoded, the tag will be empty when the task is returned by Cloud Tasks.Tagstring `json:"tag,omitempty"`// ForceSendFields is a list of field names (e.g. "Payload") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (PullMessage)MarshalJSON¶

func (sPullMessage) MarshalJSON() ([]byte,error)

type PullTarget struct {}

type PurgeQueueRequest struct {}

type QueryOverride struct {// QueryParams: The query parameters (e.g., qparam1=123&qparam2=456). Default// is an empty string.QueryParamsstring `json:"queryParams,omitempty"`// ForceSendFields is a list of field names (e.g. "QueryParams") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "QueryParams") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (QueryOverride)MarshalJSON¶added inv0.107.0

func (sQueryOverride) MarshalJSON() ([]byte,error)

type Queue struct {// AppEngineHttpTarget: App Engine HTTP target. An App Engine queue is a queue// that has an AppEngineHttpTarget.AppEngineHttpTarget *AppEngineHttpTarget `json:"appEngineHttpTarget,omitempty"`// HttpTarget: An http_target is used to override the target values for HTTP// tasks.HttpTarget *HttpTarget `json:"httpTarget,omitempty"`// Name: Caller-specified and required in CreateQueue, after which it becomes// output only. The queue name. The queue name must have the following format:// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID`// can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or// periods (.). For more information, see Identifying projects// (https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)// * `LOCATION_ID` is the canonical ID for the queue's location. The list of// available locations can be obtained by calling ListLocations. For more// information, seehttps://cloud.google.com/about/locations/. * `QUEUE_ID` can// contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum// length is 100 characters.Namestring `json:"name,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// PurgeQueue, the App Engine Task Queue SDK, or the Cloud Console// (https://cloud.google.com/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// unset if the queue has never been purged.PurgeTimestring `json:"purgeTime,omitempty"`// RateLimits: Rate limits for task dispatches. rate_limits and retry_config// are related because they both control task attempts however they control how// tasks are attempted in different ways: * 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). *// retry_config controls what happens to particular a task after its first// attempt fails. That is, 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// (https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).RetryConfig *RetryConfig `json:"retryConfig,omitempty"`// State: Output only. The state of the queue. `state` can only be changed by// called PauseQueue, ResumeQueue, or uploading queue.yaml/xml// (https://cloud.google.com/appengine/docs/python/config/queueref).// UpdateQueue cannot be used to change `state`.//// Possible values://   "STATE_UNSPECIFIED" - Unspecified state.//   "RUNNING" - The queue is running. Tasks can be dispatched. If the queue// was created using Cloud Tasks and the queue has had no activity (method// calls or task dispatches) for 30 days, the queue may take a few minutes to// re-activate. Some method calls may return NOT_FOUND and tasks may not be// dispatched for a few minutes until the queue has been re-activated.//   "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 LeaseTasks calls will// return a FAILED_PRECONDITION.//   "DISABLED" - The queue is disabled. A queue becomes `DISABLED` when// [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref)// or// [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queu// eref) 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 LeaseTasks calls return a// `FAILED_PRECONDITION` error. To permanently delete this queue and all of its// tasks, call DeleteQueue.Statestring `json:"state,omitempty"`// Stats: Output only. The realtime, informational statistics for a queue. In// order to receive the statistics the caller should include this field in the// FieldMask.Stats *QueueStats `json:"stats,omitempty"`// TaskTtl: The maximum amount of time that a task will be retained in this// queue. Queues created by Cloud Tasks have a default `task_ttl` of 31 days.// After a task has lived for `task_ttl`, the task will be deleted regardless// of whether it was dispatched or not. The `task_ttl` for queues created via// queue.yaml/xml is equal to the maximum duration because there is a storage// quota (https://cloud.google.com/appengine/quotas#Task_Queue) for these// queues. To view the maximum valid duration, see the documentation for// Duration.TaskTtlstring `json:"taskTtl,omitempty"`// TombstoneTtl: The task tombstone time to live (TTL). After a task is deleted// or completed, the task's tombstone is retained for the length of time// specified by `tombstone_ttl`. The tombstone is used by task de-duplication;// another task with the same name can't be created until the tombstone has// expired. For more information about task de-duplication, see the// documentation for CreateTaskRequest. Queues created by Cloud Tasks have a// default `tombstone_ttl` of 1 hour.TombstoneTtlstring `json:"tombstoneTtl,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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Queue)MarshalJSON¶

func (sQueue) MarshalJSON() ([]byte,error)

type QueueStats struct {// ConcurrentDispatchesCount: Output only. The number of requests that the// queue has dispatched but has not received a reply for yet.ConcurrentDispatchesCountint64 `json:"concurrentDispatchesCount,omitempty,string"`// EffectiveExecutionRate: Output only. The current maximum number of tasks per// second executed by the queue. The maximum value of this variable is// controlled by the RateLimits of the Queue. However, this value could be less// to avoid overloading the endpoints tasks in the queue are targeting.EffectiveExecutionRatefloat64 `json:"effectiveExecutionRate,omitempty"`// ExecutedLastMinuteCount: Output only. The number of tasks that the queue has// dispatched and received a reply for during the last minute. This variable// counts both successful and non-successful executions.ExecutedLastMinuteCountint64 `json:"executedLastMinuteCount,omitempty,string"`// OldestEstimatedArrivalTime: Output only. An estimation of the nearest time// in the future where a task in the queue is scheduled to be executed.OldestEstimatedArrivalTimestring `json:"oldestEstimatedArrivalTime,omitempty"`// TasksCount: Output only. An estimation of the number of tasks in the queue,// that is, the tasks in the queue that haven't been executed, the tasks in the// queue which the queue has dispatched but has not yet received a reply for,// and the failed tasks that the queue is retrying.TasksCountint64 `json:"tasksCount,omitempty,string"`// ForceSendFields is a list of field names (e.g. "ConcurrentDispatchesCount")// to unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ConcurrentDispatchesCount") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (QueueStats)MarshalJSON¶added inv0.37.0

func (sQueueStats) MarshalJSON() ([]byte,error)

func (*QueueStats)UnmarshalJSON¶added inv0.37.0

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

type RateLimits struct {// MaxBurstSize: The max burst size. Max burst size limits how fast tasks in// queue are 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. The token bucket// (https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the// rate of task dispatches. Each queue has a token bucket that holds tokens, up// to the maximum specified by `max_burst_size`. Each time a task is// dispatched, a token is removed from the bucket. Tasks will be dispatched// until the queue's bucket runs out of tokens. The bucket will be continuously// refilled with new tokens based on max_dispatches_per_second. The default// value of `max_burst_size` is picked by Cloud Tasks based on the value of// max_dispatches_per_second. The maximum value of `max_burst_size` is 500. For// App Engine queues that were created or updated using `queue.yaml/xml`,// `max_burst_size` is equal to bucket_size// (https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).// If UpdateQueue is called on a queue without explicitly setting a value for// `max_burst_size`, `max_burst_size` value will get updated if UpdateQueue is// updating max_dispatches_per_second.MaxBurstSizeint64 `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. If unspecified when the queue is created, Cloud Tasks// will pick the default. The maximum allowed value is 5,000. This field is// output only for pull queues and always -1, which indicates no limit. No// other queue types can have `max_concurrent_tasks` set to -1. This field has// the same meaning as max_concurrent_requests in queue.yaml/xml// (https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).MaxConcurrentTasksint64 `json:"maxConcurrentTasks,omitempty"`// MaxTasksDispatchedPerSecond: The maximum rate at which tasks are dispatched// from this queue. If unspecified when the queue is created, Cloud Tasks will// pick the default. * For App Engine queues, the maximum allowed value is 500.// * This field is output only for pull queues. In addition to the// `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of LeaseTasks// requests are allowed per pull queue. This field has the same meaning as rate// in queue.yaml/xml// (https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).MaxTasksDispatchedPerSecondfloat64 `json:"maxTasksDispatchedPerSecond,omitempty"`// ForceSendFields is a list of field names (e.g. "MaxBurstSize") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (RateLimits)MarshalJSON¶

func (sRateLimits) MarshalJSON() ([]byte,error)

func (*RateLimits)UnmarshalJSON¶

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

type RenewLeaseRequest struct {// LeaseDuration: Required. The desired new lease duration, starting from now.// The maximum lease duration is 1 week. `lease_duration` will be truncated to// the nearest second.LeaseDurationstring `json:"leaseDuration,omitempty"`// ResponseView: The response_view specifies which subset of the Task will be// returned. By default response_view is 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 FULL requires// `cloudtasks.tasks.fullView` Google IAM (https://cloud.google.com/iam/)// permission on the Task 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 in// AppEngineHttpRequest and payload in PullMessage). These payloads are// 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.//   "FULL" - All information is returned. Authorization for FULL requires// `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)// permission on the Queue resource.ResponseViewstring `json:"responseView,omitempty"`// ScheduleTime: Required. The task's current schedule time, available in the// schedule_time returned by LeaseTasks response or RenewLease response. This// restriction is to ensure that your worker currently holds the lease.ScheduleTimestring `json:"scheduleTime,omitempty"`// ForceSendFields is a list of field names (e.g. "LeaseDuration") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LeaseDuration") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (RenewLeaseRequest)MarshalJSON¶

func (sRenewLeaseRequest) MarshalJSON() ([]byte,error)

type ResumeQueueRequest struct {}

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.MaxAttemptsint64 `json:"maxAttempts,omitempty"`// MaxBackoff: A task will be scheduled for retry between min_backoff and// max_backoff duration after it fails, if the queue's RetryConfig specifies// that the task should be retried. If unspecified when the queue is created,// Cloud Tasks will pick the default. This field is output only for pull// queues. `max_backoff` will be truncated to the nearest second. This field// has the same meaning as max_backoff_seconds in queue.yaml/xml// (https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).MaxBackoffstring `json:"maxBackoff,omitempty"`// MaxDoublings: The time between retries will double `max_doublings` times. A// task's retry interval starts at min_backoff, then doubles `max_doublings`// times, then increases linearly, and finally retries at intervals of// max_backoff up to max_attempts times. For example, if min_backoff is 10s,// max_backoff is 300s, and `max_doublings` is 3, then the a task will first be// retried in 10s. The retry interval will double three times, and then// increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of// max_backoff until the task has been attempted max_attempts times. Thus, the// requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If// unspecified when the queue is created, Cloud Tasks will pick the default.// This field is output only for pull queues. This field has the same meaning// as max_doublings in queue.yaml/xml// (https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).MaxDoublingsint64 `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// max_attempts times, no further attempts will be made and the task will be// deleted. If zero, then the task age is unlimited. If unspecified when the// queue is created, Cloud Tasks will pick the default. This field is output// only for pull queues. `max_retry_duration` will be truncated to the nearest// second. This field has the same meaning as task_age_limit in queue.yaml/xml// (https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).MaxRetryDurationstring `json:"maxRetryDuration,omitempty"`// MinBackoff: A task will be scheduled for retry between min_backoff and// max_backoff duration after it fails, if the queue's RetryConfig specifies// that the task should be retried. If unspecified when the queue is created,// Cloud Tasks will pick the default. This field is output only for pull// queues. `min_backoff` will be truncated to the nearest second. This field// has the same meaning as min_backoff_seconds in queue.yaml/xml// (https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).MinBackoffstring `json:"minBackoff,omitempty"`// UnlimitedAttempts: If true, then the number of attempts is unlimited.UnlimitedAttemptsbool `json:"unlimitedAttempts,omitempty"`// ForceSendFields is a list of field names (e.g. "MaxAttempts") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (RetryConfig)MarshalJSON¶

func (sRetryConfig) MarshalJSON() ([]byte,error)

type RunTaskRequest struct {// ResponseView: The response_view specifies which subset of the Task will be// returned. By default response_view is 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 FULL requires// `cloudtasks.tasks.fullView` Google IAM (https://cloud.google.com/iam/)// permission on the Task 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 in// AppEngineHttpRequest and payload in PullMessage). These payloads are// 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.//   "FULL" - All information is returned. Authorization for FULL requires// `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)// permission on the Queue resource.ResponseViewstring `json:"responseView,omitempty"`// ForceSendFields is a list of field names (e.g. "ResponseView") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (RunTaskRequest)MarshalJSON¶

func (sRunTaskRequest) MarshalJSON() ([]byte,error)

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentApi *ApiServiceProjects *ProjectsService// contains filtered or unexported fields}

funcNewService¶added inv0.3.0

func NewService(ctxcontext.Context, opts ...option.ClientOption) (*Service,error)

NewService creates a new Service.

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 Google Cloud 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 or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (SetIamPolicyRequest)MarshalJSON¶

func (sSetIamPolicyRequest) MarshalJSON() ([]byte,error)

type Status struct {// Code: The status code, which should be an enum value of google.rpc.Code.Codeint64 `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.Messagestring `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Code") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Status)MarshalJSON¶

func (sStatus) MarshalJSON() ([]byte,error)

type Task struct {// AppEngineHttpRequest: App Engine HTTP request that is sent to the task's// target. Can be set only if app_engine_http_target is set on the queue. An// App Engine task is a task that has AppEngineHttpRequest set.AppEngineHttpRequest *AppEngineHttpRequest `json:"appEngineHttpRequest,omitempty"`// CreateTime: Output only. The time that the task was created. `create_time`// will be truncated to the nearest second.CreateTimestring `json:"createTime,omitempty"`// HttpRequest: HTTP request that is sent to the task's target. An HTTP task is// a task that has HttpRequest set.HttpRequest *HttpRequest `json:"httpRequest,omitempty"`// Name: Optionally caller-specified in CreateTask. The task name. The task// name must have the following format:// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` *// `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-),// colons (:), or periods (.). For more information, see Identifying projects// (https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)// * `LOCATION_ID` is the canonical ID for the task's location. The list of// available locations can be obtained by calling ListLocations. For more// information, seehttps://cloud.google.com/about/locations/. * `QUEUE_ID` can// contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum// length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]),// numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500// characters.Namestring `json:"name,omitempty"`// PullMessage: LeaseTasks to process the task. Can be set only if pull_target// is set on the queue. A pull task is a task that has PullMessage set.PullMessage *PullMessage `json:"pullMessage,omitempty"`// ScheduleTime: The time when the task is scheduled to be attempted. For App// Engine queues, this is when the task will be attempted or retried. 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 lease_duration.// `schedule_time` will be truncated to the nearest microsecond.ScheduleTimestring `json:"scheduleTime,omitempty"`// Status: Output only. The task status.Status *TaskStatus `json:"status,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 in// AppEngineHttpRequest and payload in PullMessage). These payloads are// 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.//   "FULL" - All information is returned. Authorization for FULL requires// `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)// permission on the Queue resource.Viewstring `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Task)MarshalJSON¶

func (sTask) MarshalJSON() ([]byte,error)

type TaskStatus struct {// AttemptDispatchCount: Output only. The number of attempts dispatched. This// count includes attempts which have been dispatched but haven't received a// response.AttemptDispatchCountint64 `json:"attemptDispatchCount,omitempty"`// AttemptResponseCount: Output only. The number of attempts which have// received a response. This field is not calculated for pull tasks.AttemptResponseCountint64 `json:"attemptResponseCount,omitempty"`// FirstAttemptStatus: Output only. The status of the task's first attempt.// Only dispatch_time will be set. The other AttemptStatus information is not// retained by Cloud Tasks. This field is not calculated for pull tasks.FirstAttemptStatus *AttemptStatus `json:"firstAttemptStatus,omitempty"`// LastAttemptStatus: Output only. The status of the task's last attempt. This// field is not calculated for pull tasks.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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (TaskStatus)MarshalJSON¶

func (sTaskStatus) MarshalJSON() ([]byte,error)

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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (TestIamPermissionsRequest)MarshalJSON¶

func (sTestIamPermissionsRequest) MarshalJSON() ([]byte,error)

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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (TestIamPermissionsResponse)MarshalJSON¶

func (sTestIamPermissionsResponse) MarshalJSON() ([]byte,error)

type UriOverride struct {// Host: Host override. When specified, replaces the host part of the task URL.// For example, if the task URL is "https://www.google.com," and host value is// set to "example.net", the overridden URI will be changed to// "https://example.net." Host value cannot be an empty string// (INVALID_ARGUMENT).Hoststring `json:"host,omitempty"`// PathOverride: URI path. When specified, replaces the existing path of the// task URL. Setting the path value to an empty string clears the URI path// segment.PathOverride *PathOverride `json:"pathOverride,omitempty"`// Port: Port override. When specified, replaces the port part of the task URI.// For instance, for a URI "https://www.example.com/example" and port=123, the// overridden URI becomes "https://www.example.com:123/example". Note that the// port value must be a positive integer. Setting the port to 0 (Zero) clears// the URI port.Portint64 `json:"port,omitempty,string"`// QueryOverride: URI Query. When specified, replaces the query part of the// task URI. Setting the query value to an empty string clears the URI query// segment.QueryOverride *QueryOverride `json:"queryOverride,omitempty"`// Scheme: Scheme override. When specified, the task URI scheme is replaced by// the provided value (HTTP or HTTPS).//// Possible values://   "SCHEME_UNSPECIFIED" - Scheme unspecified. Defaults to HTTPS.//   "HTTP" - Convert the scheme to HTTP, e.g., "https://www.example.com" will// change to "http://www.example.com".//   "HTTPS" - Convert the scheme to HTTPS, e.g., "http://www.example.com" will// change to "https://www.example.com".Schemestring `json:"scheme,omitempty"`// UriOverrideEnforceMode: URI Override Enforce Mode When specified, determines// the Target UriOverride mode. If not specified, it defaults to ALWAYS.//// Possible values://   "URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED" - OverrideMode Unspecified.// Defaults to ALWAYS.//   "IF_NOT_EXISTS" - In the IF_NOT_EXISTS mode, queue-level configuration is// only applied where task-level configuration does not exist.//   "ALWAYS" - In the ALWAYS mode, queue-level configuration overrides all// task-level configurationUriOverrideEnforceModestring `json:"uriOverrideEnforceMode,omitempty"`// ForceSendFields is a list of field names (e.g. "Host") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (UriOverride)MarshalJSON¶added inv0.88.0

func (sUriOverride) MarshalJSON() ([]byte,error)