| // Copyright 2020 Google LLC. |
| // Use of this source code is governed by a BSD-style |
| // license that can be found in the LICENSE file. |
| |
| // Code generated file. DO NOT EDIT. |
| |
| // Package cloudtasks provides access to the Cloud Tasks API. |
| // |
| // This package is DEPRECATED. Use package cloud.google.com/go/cloudtasks/apiv2beta2 instead. |
| // |
| // For product documentation, see: https://cloud.google.com/tasks/ |
| // |
| // Creating a client |
| // |
| // Usage example: |
| // |
| // import "google.golang.org/api/cloudtasks/v2" |
| // ... |
| // ctx := context.Background() |
| // cloudtasksService, err := cloudtasks.NewService(ctx) |
| // |
| // In this example, Google Application Default Credentials are used for authentication. |
| // |
| // For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials. |
| // |
| // Other authentication options |
| // |
| // To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey: |
| // |
| // cloudtasksService, err := cloudtasks.NewService(ctx, option.WithAPIKey("AIza...")) |
| // |
| // To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource: |
| // |
| // config := &oauth2.Config{...} |
| // // ... |
| // token, err := config.Exchange(ctx, ...) |
| // cloudtasksService, err := cloudtasks.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token))) |
| // |
| // See https://godoc.org/google.golang.org/api/option/ for details on options. |
| package cloudtasks // import "google.golang.org/api/cloudtasks/v2" |
| |
| import ( |
| "bytes" |
| "context" |
| "encoding/json" |
| "errors" |
| "fmt" |
| "io" |
| "net/http" |
| "net/url" |
| "strconv" |
| "strings" |
| |
| googleapi "google.golang.org/api/googleapi" |
| gensupport "google.golang.org/api/internal/gensupport" |
| option "google.golang.org/api/option" |
| internaloption "google.golang.org/api/option/internaloption" |
| htransport "google.golang.org/api/transport/http" |
| ) |
| |
| // Always reference these packages, just in case the auto-generated code |
| // below doesn't. |
| var _ = bytes.NewBuffer |
| var _ = strconv.Itoa |
| var _ = fmt.Sprintf |
| var _ = json.NewDecoder |
| var _ = io.Copy |
| var _ = url.Parse |
| var _ = gensupport.MarshalJSON |
| var _ = googleapi.Version |
| var _ = errors.New |
| var _ = strings.Replace |
| var _ = context.Canceled |
| var _ = internaloption.WithDefaultEndpoint |
| |
| const apiId = "cloudtasks:v2" |
| const apiName = "cloudtasks" |
| const apiVersion = "v2" |
| const basePath = "https://cloudtasks.googleapis.com/" |
| const mtlsBasePath = "https://cloudtasks.mtls.googleapis.com/" |
| |
| // OAuth2 scopes used by this API. |
| const ( |
| // View and manage your data across Google Cloud Platform services |
| CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform" |
| ) |
| |
| // NewService creates a new Service. |
| func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) { |
| scopesOption := option.WithScopes( |
| "https://www.googleapis.com/auth/cloud-platform", |
| ) |
| // NOTE: prepend, so we don't override user-specified scopes. |
| opts = append([]option.ClientOption{scopesOption}, opts...) |
| opts = append(opts, internaloption.WithDefaultEndpoint(basePath)) |
| opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath)) |
| client, endpoint, err := htransport.NewClient(ctx, opts...) |
| if err != nil { |
| return nil, err |
| } |
| s, err := New(client) |
| if err != nil { |
| return nil, err |
| } |
| if endpoint != "" { |
| s.BasePath = endpoint |
| } |
| return s, nil |
| } |
| |
| // New creates a new Service. It uses the provided http.Client for requests. |
| // |
| // Deprecated: please use NewService instead. |
| // To provide a custom HTTP client, use option.WithHTTPClient. |
| // If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead. |
| func New(client *http.Client) (*Service, error) { |
| if client == nil { |
| return nil, errors.New("client is nil") |
| } |
| s := &Service{client: client, BasePath: basePath} |
| s.Projects = NewProjectsService(s) |
| return s, nil |
| } |
| |
| type Service struct { |
| client *http.Client |
| BasePath string // API endpoint base URL |
| UserAgent string // optional additional User-Agent fragment |
| |
| Projects *ProjectsService |
| } |
| |
| func (s *Service) userAgent() string { |
| if s.UserAgent == "" { |
| return googleapi.UserAgent |
| } |
| return googleapi.UserAgent + " " + s.UserAgent |
| } |
| |
| func NewProjectsService(s *Service) *ProjectsService { |
| rs := &ProjectsService{s: s} |
| rs.Locations = NewProjectsLocationsService(s) |
| return rs |
| } |
| |
| type ProjectsService struct { |
| s *Service |
| |
| Locations *ProjectsLocationsService |
| } |
| |
| func NewProjectsLocationsService(s *Service) *ProjectsLocationsService { |
| rs := &ProjectsLocationsService{s: s} |
| rs.Queues = NewProjectsLocationsQueuesService(s) |
| return rs |
| } |
| |
| type ProjectsLocationsService struct { |
| s *Service |
| |
| Queues *ProjectsLocationsQueuesService |
| } |
| |
| func NewProjectsLocationsQueuesService(s *Service) *ProjectsLocationsQueuesService { |
| rs := &ProjectsLocationsQueuesService{s: s} |
| rs.Tasks = NewProjectsLocationsQueuesTasksService(s) |
| return rs |
| } |
| |
| type ProjectsLocationsQueuesService struct { |
| s *Service |
| |
| Tasks *ProjectsLocationsQueuesTasksService |
| } |
| |
| func NewProjectsLocationsQueuesTasksService(s *Service) *ProjectsLocationsQueuesTasksService { |
| rs := &ProjectsLocationsQueuesTasksService{s: s} |
| return rs |
| } |
| |
| type ProjectsLocationsQueuesTasksService struct { |
| s *Service |
| } |
| |
| // AppEngineHttpRequest: App Engine HTTP request. |
| // |
| // The message defines the HTTP request that is sent to an App Engine |
| // app when |
| // the task is dispatched. |
| // |
| // Using AppEngineHttpRequest |
| // requires |
| // [`appengine.applications.get`](https://cloud.google.com/appen |
| // gine/docs/admin-api/access-control) |
| // Google IAM permission for the project |
| // and the following |
| // scope: |
| // |
| // `https://www.googleapis.com/auth/cloud-platform` |
| // |
| // The task will be delivered to the App Engine app which belongs to the |
| // same |
| // project as the queue. For more information, see |
| // [How Requests |
| // are |
| // Routed](https://cloud.google.com/appengine/docs/standard/python/ho |
| // w-requests-are-routed) |
| // and how routing is affected |
| // by |
| // [dispatch |
| // files](https://cloud.google.com/appengine/docs/python/con |
| // fig/dispatchref). |
| // Traffic is encrypted during transport and never leaves Google |
| // datacenters. |
| // Because this traffic is carried over a communication mechanism |
| // internal to |
| // Google, you cannot explicitly set the protocol (for example, HTTP or |
| // HTTPS). |
| // The request to the handler, however, will appear to have used the |
| // HTTP |
| // protocol. |
| // |
| // The AppEngineRouting used to construct the URL that the task |
| // is |
| // delivered to can be set at the queue-level or task-level: |
| // |
| // * If app_engine_routing_override is set on the |
| // queue, this value |
| // is used for all tasks in the queue, no matter what the setting is |
| // for the |
| // task-level |
| // app_engine_routing. |
| // |
| // |
| // The `url` that the task will be sent to is: |
| // |
| // * `url =` host `+` |
| // relative_uri |
| // |
| // Tasks can be dispatched to secure app handlers, unsecure app |
| // handlers, and |
| // URIs restricted |
| // with |
| // [`login: |
| // admin`](https://cloud.google.com/appengine/docs/standard |
| // /python/config/appref). |
| // Because tasks are not run as any user, they cannot be dispatched to |
| // URIs |
| // restricted |
| // with |
| // [`login: |
| // required`](https://cloud.google.com/appengine/docs/stand |
| // ard/python/config/appref) |
| // Task dispatches also do not follow redirects. |
| // |
| // The task attempt has succeeded if the app's request handler returns |
| // an HTTP |
| // response code in the range [`200` - `299`]. The task attempt has |
| // failed if |
| // the app's handler returns a non-2xx response code or Cloud Tasks |
| // does |
| // not receive response before the deadline. Failed |
| // tasks will be retried according to the |
| // retry configuration. `503` (Service Unavailable) is |
| // considered an App Engine system error instead of an application error |
| // and |
| // will cause Cloud Tasks' traffic congestion control to temporarily |
| // throttle |
| // the queue's dispatches. Unlike other types of task targets, a `429` |
| // (Too Many |
| // Requests) response from an app handler does not cause traffic |
| // congestion |
| // control to throttle the queue. |
| type AppEngineHttpRequest struct { |
| // AppEngineRouting: Task-level setting for App Engine routing. |
| // |
| // * If app_engine_routing_override is set on the |
| // queue, this |
| // value 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"` |
| |
| // Body: HTTP request body. |
| // |
| // A request body is allowed only if the HTTP method is POST or PUT. It |
| // is |
| // an error to set a body on a task with an incompatible HttpMethod. |
| Body string `json:"body,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 body, 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/tasks/docs/creating-app |
| // engine-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/taskqueu |
| // e/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 OPTIONS |
| HttpMethod string `json:"httpMethod,omitempty"` |
| |
| // RelativeUri: The relative URI. |
| // |
| // The relative URI must begin with "/" and must be a valid HTTP |
| // relative URI. |
| // It can contain a path and query string arguments. |
| // If the relative URI is empty, then the root path "/" will be used. |
| // No spaces are allowed, and the maximum length allowed is 2083 |
| // characters. |
| RelativeUri string `json:"relativeUri,omitempty"` |
| |
| // ForceSendFields is a list of field names (e.g. "AppEngineRouting") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "AppEngineRouting") to |
| // include in API requests with the JSON null value. By default, fields |
| // with empty values are omitted from API requests. However, any field |
| // with an empty value appearing in NullFields will be sent to the |
| // server as null. It is an error if a field in this list has a |
| // non-empty value. This may be used to include null fields in Patch |
| // requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *AppEngineHttpRequest) MarshalJSON() ([]byte, error) { |
| type NoMethod AppEngineHttpRequest |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // AppEngineRouting: App Engine Routing. |
| // |
| // Defines routing characteristics specific to App Engine - service, |
| // version, |
| // and instance. |
| // |
| // For more information about services, versions, and instances see |
| // [An Overview of |
| // App |
| // Engine](https://cloud.google.com/appengine/docs/python/an-overview |
| // -of-app-engine), |
| // [Microservices Architecture on Google |
| // App |
| // Engine](https://cloud.google.com/appengine/docs/python/microservic |
| // es-on-app-engine), |
| // [App Engine Standard |
| // request |
| // routing](https://cloud.google.com/appengine/docs/standard/pyth |
| // on/how-requests-are-routed), |
| // and [App Engine Flex |
| // request |
| // routing](https://cloud.google.com/appengine/docs/flexible/pyth |
| // on/how-requests-are-routed). |
| // |
| // Using AppEngineRouting |
| // requires |
| // [`appengine.applications.get`](https://cloud.google.com/appen |
| // gine/docs/admin-api/access-control) |
| // Google IAM permission for the project |
| // and the following |
| // scope: |
| // |
| // `https://www.googleapis.com/auth/cloud-platform` |
| type AppEngineRouting struct { |
| // Host: Output only. The host that the task is sent to. |
| // |
| // The host is constructed from the domain name of the app associated |
| // with |
| // the queue's project ID (for example <app-id>.appspot.com), and |
| // the |
| // service, version, |
| // and instance. Tasks which were created using |
| // the App Engine SDK might have a custom domain name. |
| // |
| // For more information, see |
| // [How Requests |
| // are |
| // Routed](https://cloud.google.com/appengine/docs/standard/python/ho |
| // w-requests-are-routed). |
| Host string `json:"host,omitempty"` |
| |
| // Instance: App instance. |
| // |
| // By default, the task is sent to an instance which is available |
| // when |
| // the task is attempted. |
| // |
| // Requests can only be sent to a specific instance if |
| // [manual scaling is used in App |
| // Engine |
| // Standard](https://cloud.google.com/appengine/docs/python/an-ove |
| // rview-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/pyth |
| // on/how-requests-are-routed) |
| // and [App Engine Flex |
| // request |
| // routing](https://cloud.google.com/appengine/docs/flexible/pyth |
| // on/how-requests-are-routed). |
| Instance string `json:"instance,omitempty"` |
| |
| // Service: App service. |
| // |
| // By default, the task is sent to the service which is the |
| // default |
| // service when the task is attempted. |
| // |
| // 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. |
| Service string `json:"service,omitempty"` |
| |
| // Version: App version. |
| // |
| // By default, the task is sent to the version which is the |
| // default |
| // version when the task is attempted. |
| // |
| // 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. |
| Version string `json:"version,omitempty"` |
| |
| // ForceSendFields is a list of field names (e.g. "Host") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "Host") to include in API |
| // requests with the JSON null value. By default, fields with empty |
| // values are omitted from API requests. However, any field with an |
| // empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *AppEngineRouting) MarshalJSON() ([]byte, error) { |
| type NoMethod AppEngineRouting |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // Attempt: The status of a task attempt. |
| type Attempt struct { |
| // DispatchTime: Output only. The time that this attempt was |
| // dispatched. |
| // |
| // `dispatch_time` will be truncated to the nearest microsecond. |
| DispatchTime string `json:"dispatchTime,omitempty"` |
| |
| // ResponseStatus: Output only. The response from the worker for this |
| // attempt. |
| // |
| // If `response_time` is unset, then the task has not been attempted or |
| // is |
| // currently running and the `response_status` field is meaningless. |
| ResponseStatus *Status `json:"responseStatus,omitempty"` |
| |
| // ResponseTime: Output only. The time that this attempt response was |
| // received. |
| // |
| // `response_time` will be truncated to the nearest microsecond. |
| ResponseTime string `json:"responseTime,omitempty"` |
| |
| // ScheduleTime: Output only. The time that this attempt was |
| // scheduled. |
| // |
| // `schedule_time` will be truncated to the nearest microsecond. |
| ScheduleTime string `json:"scheduleTime,omitempty"` |
| |
| // ForceSendFields is a list of field names (e.g. "DispatchTime") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "DispatchTime") to include |
| // in API requests with the JSON null value. By default, fields with |
| // empty values are omitted from API requests. However, any field with |
| // an empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *Attempt) MarshalJSON() ([]byte, error) { |
| type NoMethod Attempt |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // Binding: Associates `members` with a `role`. |
| 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 members in this binding. |
| // |
| // To learn which resources support conditions in their IAM policies, |
| // see |
| // the |
| // [IAM |
| // documentation](https://cloud.google.com/iam/help/conditions/r |
| // esource-policies). |
| Condition *Expr `json:"condition,omitempty"` |
| |
| // Members: Specifies the identities requesting access for a Cloud |
| // Platform resource. |
| // `members` can have the following values: |
| // |
| // * `allUsers`: A special identifier that represents anyone who is |
| // on the internet; with or without a Google account. |
| // |
| // * `allAuthenticatedUsers`: A special identifier that represents |
| // anyone |
| // who is authenticated with a Google account or a service |
| // account. |
| // |
| // * `user:{emailid}`: An email address that represents a specific |
| // Google |
| // account. For example, `alice@example.com` . |
| // |
| // |
| // * `serviceAccount:{emailid}`: An email address that represents a |
| // service |
| // account. For example, |
| // `my-other-app@appspot.gserviceaccount.com`. |
| // |
| // * `group:{emailid}`: An email address that represents a Google |
| // group. |
| // For example, `admins@example.com`. |
| // |
| // * `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. |
| // |
| // |
| // * `domain:{domain}`: The G Suite domain (primary) that represents all |
| // the |
| // users of that domain. For example, `google.com` or |
| // `example.com`. |
| // |
| // |
| Members []string `json:"members,omitempty"` |
| |
| // Role: Role that is assigned to `members`. |
| // For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| Role string `json:"role,omitempty"` |
| |
| // ForceSendFields is a list of field names (e.g. "Condition") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "Condition") to include in |
| // API requests with the JSON null value. By default, fields with empty |
| // values are omitted from API requests. However, any field with an |
| // empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *Binding) MarshalJSON() ([]byte, error) { |
| type NoMethod Binding |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // CreateTaskRequest: Request message for CreateTask. |
| 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 |
| // body in AppEngineHttpRequest. |
| // Bodies 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. |
| ResponseView string `json:"responseView,omitempty"` |
| |
| // Task: Required. The task to add. |
| // |
| // Task names have the following |
| // format: |
| // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tas |
| // ks/TASK_ID`. |
| // The user can optionally specify a 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 executed recently then the call will fail |
| // with ALREADY_EXISTS. |
| // If the task's queue was created using Cloud Tasks, then another task |
| // with |
| // the same name can't be created for ~1hour after the original task |
| // was |
| // deleted or executed. If the task's queue was created using queue.yaml |
| // or |
| // queue.xml, then another task with the same name can't be created |
| // for ~9days after the original task was deleted or executed. |
| // |
| // 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 values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "ResponseView") to include |
| // in API requests with the JSON null value. By default, fields with |
| // empty values are omitted from API requests. However, any field with |
| // an empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *CreateTaskRequest) MarshalJSON() ([]byte, error) { |
| type NoMethod CreateTaskRequest |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // Empty: A generic empty message that you can re-use to avoid defining |
| // duplicated |
| // empty messages in your APIs. A typical example is to use it as the |
| // request |
| // or the response type of an API method. For instance: |
| // |
| // service Foo { |
| // rpc Bar(google.protobuf.Empty) returns |
| // (google.protobuf.Empty); |
| // } |
| // |
| // The JSON representation for `Empty` is empty JSON object `{}`. |
| type Empty struct { |
| // ServerResponse contains the HTTP response code and headers from the |
| // server. |
| googleapi.ServerResponse `json:"-"` |
| } |
| |
| // Expr: Represents a textual expression in the Common Expression |
| // Language (CEL) |
| // syntax. CEL is a C-like expression language. The syntax and semantics |
| // of CEL |
| // are documented at https://github.com/google/cel-spec. |
| // |
| // Example (Comparison): |
| // |
| // title: "Summary size limit" |
| // description: "Determines if a summary is less than 100 chars" |
| // expression: "document.summary.size() < 100" |
| // |
| // Example (Equality): |
| // |
| // title: "Requestor is owner" |
| // description: "Determines if requestor is the document owner" |
| // expression: "document.owner == |
| // request.auth.claims.email" |
| // |
| // Example (Logic): |
| // |
| // title: "Public documents" |
| // description: "Determine whether the document should be publicly |
| // visible" |
| // expression: "document.type != 'private' && document.type != |
| // 'internal'" |
| // |
| // Example (Data Manipulation): |
| // |
| // title: "Notification string" |
| // description: "Create a notification string with a timestamp." |
| // expression: "'New message received at ' + |
| // string(document.create_time)" |
| // |
| // The exact variables and functions that may be referenced within an |
| // expression |
| // are determined by the service that evaluates it. See the |
| // service |
| // documentation for additional information. |
| 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. |
| Description string `json:"description,omitempty"` |
| |
| // Expression: Textual representation of an expression in Common |
| // Expression Language |
| // syntax. |
| Expression string `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. |
| Location string `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. |
| Title string `json:"title,omitempty"` |
| |
| // ForceSendFields is a list of field names (e.g. "Description") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "Description") to include |
| // in API requests with the JSON null value. By default, fields with |
| // empty values are omitted from API requests. However, any field with |
| // an empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *Expr) MarshalJSON() ([]byte, error) { |
| type NoMethod Expr |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // GetIamPolicyRequest: Request message for `GetIamPolicy` method. |
| 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 values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "Options") to include in |
| // API requests with the JSON null value. By default, fields with empty |
| // values are omitted from API requests. However, any field with an |
| // empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *GetIamPolicyRequest) MarshalJSON() ([]byte, error) { |
| type NoMethod GetIamPolicyRequest |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // GetPolicyOptions: Encapsulates settings provided to GetIamPolicy. |
| type GetPolicyOptions struct { |
| // RequestedPolicyVersion: Optional. The policy format version to be |
| // returned. |
| // |
| // Valid values are 0, 1, and 3. Requests specifying an invalid value |
| // will be |
| // rejected. |
| // |
| // Requests for policies with any conditional bindings must specify |
| // version 3. |
| // Policies without any conditional bindings may specify any valid value |
| // 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/r |
| // esource-policies). |
| RequestedPolicyVersion int64 `json:"requestedPolicyVersion,omitempty"` |
| |
| // ForceSendFields is a list of field names (e.g. |
| // "RequestedPolicyVersion") to unconditionally include in API requests. |
| // By default, fields with empty values are omitted from API requests. |
| // However, any non-pointer, non-interface field appearing in |
| // ForceSendFields will be sent to the server regardless of whether the |
| // field is empty or not. This may be used to include empty fields in |
| // Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "RequestedPolicyVersion") |
| // to include in API requests with the JSON null value. By default, |
| // fields with empty values are omitted from API requests. However, any |
| // field with an empty value appearing in NullFields will be sent to the |
| // server as null. It is an error if a field in this list has a |
| // non-empty value. This may be used to include null fields in Patch |
| // requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *GetPolicyOptions) MarshalJSON() ([]byte, error) { |
| type NoMethod GetPolicyOptions |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // HttpRequest: HTTP request. |
| // |
| // The task will be pushed to the worker as an HTTP request. If the |
| // worker |
| // or the redirected worker acknowledges the task by returning a |
| // successful HTTP |
| // response code ([`200` - `299`]), the task will be removed from the |
| // queue. If |
| // any other HTTP response code is returned or no response is received, |
| // the |
| // task will be retried according to the following: |
| // |
| // * User-specified throttling: retry configuration, |
| // rate limits, and the queue's state. |
| // |
| // * System throttling: To prevent the worker from overloading, Cloud |
| // Tasks may |
| // temporarily reduce the queue's effective rate. User-specified |
| // settings |
| // will not be changed. |
| // |
| // System throttling happens because: |
| // |
| // * Cloud Tasks backs off on all errors. Normally the backoff |
| // specified in |
| // rate limits will be used. But if the worker returns |
| // `429` (Too Many Requests), `503` (Service Unavailable), or the |
| // rate of |
| // errors is high, Cloud Tasks will use a higher backoff rate. The |
| // retry |
| // specified in the `Retry-After` HTTP response header is |
| // considered. |
| // |
| // * To prevent traffic spikes and to smooth sudden increases in |
| // traffic, |
| // dispatches ramp up slowly when the queue is newly created or idle |
| // and |
| // if large numbers of tasks suddenly become available to dispatch |
| // (due to |
| // spikes in create task rates, the queue being unpaused, or many |
| // tasks |
| // that are scheduled at the same time). |
| 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. |
| Body string `json:"body,omitempty"` |
| |
| // Headers: HTTP request headers. |
| // |
| // This map contains the header field names and values. |
| // Headers can be set when the |
| // 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: |
| // |
| // * 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 OPTIONS |
| HttpMethod string `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/OpenIDConne |
| // ct) |
| // 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. |
| Url string `json:"url,omitempty"` |
| |
| // ForceSendFields is a list of field names (e.g. "Body") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "Body") to include in API |
| // requests with the JSON null value. By default, fields with empty |
| // values are omitted from API requests. However, any field with an |
| // empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *HttpRequest) MarshalJSON() ([]byte, error) { |
| type NoMethod HttpRequest |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // ListLocationsResponse: The response message for |
| // Locations.ListLocations. |
| type ListLocationsResponse struct { |
| // Locations: A list of locations that matches the specified filter in |
| // the request. |
| Locations []*Location `json:"locations,omitempty"` |
| |
| // NextPageToken: The standard List next-page token. |
| NextPageToken string `json:"nextPageToken,omitempty"` |
| |
| // ServerResponse contains the HTTP response code and headers from the |
| // server. |
| googleapi.ServerResponse `json:"-"` |
| |
| // ForceSendFields is a list of field names (e.g. "Locations") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "Locations") to include in |
| // API requests with the JSON null value. By default, fields with empty |
| // values are omitted from API requests. However, any field with an |
| // empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *ListLocationsResponse) MarshalJSON() ([]byte, error) { |
| type NoMethod ListLocationsResponse |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // ListQueuesResponse: Response message for ListQueues. |
| 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. |
| NextPageToken string `json:"nextPageToken,omitempty"` |
| |
| // Queues: The list of queues. |
| Queues []*Queue `json:"queues,omitempty"` |
| |
| // ServerResponse contains the HTTP response code and headers from the |
| // server. |
| googleapi.ServerResponse `json:"-"` |
| |
| // ForceSendFields is a list of field names (e.g. "NextPageToken") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "NextPageToken") to include |
| // in API requests with the JSON null value. By default, fields with |
| // empty values are omitted from API requests. However, any field with |
| // an empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *ListQueuesResponse) MarshalJSON() ([]byte, error) { |
| type NoMethod ListQueuesResponse |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // ListTasksResponse: Response message for listing tasks using |
| // ListTasks. |
| 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. |
| NextPageToken string `json:"nextPageToken,omitempty"` |
| |
| // Tasks: The list of tasks. |
| Tasks []*Task `json:"tasks,omitempty"` |
| |
| // ServerResponse contains the HTTP response code and headers from the |
| // server. |
| googleapi.ServerResponse `json:"-"` |
| |
| // ForceSendFields is a list of field names (e.g. "NextPageToken") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "NextPageToken") to include |
| // in API requests with the JSON null value. By default, fields with |
| // empty values are omitted from API requests. However, any field with |
| // an empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *ListTasksResponse) MarshalJSON() ([]byte, error) { |
| type NoMethod ListTasksResponse |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // Location: A resource that represents Google Cloud Platform location. |
| type Location struct { |
| // DisplayName: The friendly name for this location, typically a nearby |
| // city name. |
| // For example, "Tokyo". |
| DisplayName string `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". |
| LocationId string `json:"locationId,omitempty"` |
| |
| // Metadata: Service-specific metadata. For example the available |
| // capacity at the given |
| // location. |
| Metadata googleapi.RawMessage `json:"metadata,omitempty"` |
| |
| // Name: Resource name for the location, which may vary between |
| // implementations. |
| // For example: "projects/example-project/locations/us-east1" |
| Name string `json:"name,omitempty"` |
| |
| // ServerResponse contains the HTTP response code and headers from the |
| // server. |
| googleapi.ServerResponse `json:"-"` |
| |
| // ForceSendFields is a list of field names (e.g. "DisplayName") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "DisplayName") to include |
| // in API requests with the JSON null value. By default, fields with |
| // empty values are omitted from API requests. However, any field with |
| // an empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *Location) MarshalJSON() ([]byte, error) { |
| type NoMethod Location |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // OAuthToken: Contains information needed for generating an |
| // [OAuth |
| // token](https://developers.google.com/identity/protocols/OAuth2). |
| // This type of authorization should generally only be used when calling |
| // Google |
| // APIs hosted on *.googleapis.com. |
| 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. |
| Scope string `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. |
| ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"` |
| |
| // ForceSendFields is a list of field names (e.g. "Scope") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "Scope") to include in API |
| // requests with the JSON null value. By default, fields with empty |
| // values are omitted from API requests. However, any field with an |
| // empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *OAuthToken) MarshalJSON() ([]byte, error) { |
| type NoMethod OAuthToken |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // OidcToken: Contains information needed for generating an |
| // [OpenID |
| // Connect |
| // token](https://developers.google.com/identity/protocols/OpenID |
| // Connect). |
| // This type of authorization can be used for many scenarios, |
| // including |
| // calling Cloud Run, or endpoints where you intend to validate the |
| // token |
| // yourself. |
| type OidcToken struct { |
| // Audience: Audience to be used when generating OIDC token. If not |
| // specified, the URI |
| // specified in target will be used. |
| Audience string `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. |
| ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"` |
| |
| // ForceSendFields is a list of field names (e.g. "Audience") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "Audience") to include in |
| // API requests with the JSON null value. By default, fields with empty |
| // values are omitted from API requests. However, any field with an |
| // empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *OidcToken) MarshalJSON() ([]byte, error) { |
| type NoMethod OidcToken |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // PauseQueueRequest: Request message for PauseQueue. |
| type PauseQueueRequest struct { |
| } |
| |
| // Policy: An Identity and Access Management (IAM) policy, which |
| // specifies access |
| // controls for Google Cloud resources. |
| // |
| // |
| // A `Policy` is a collection of `bindings`. A `binding` binds one or |
| // more |
| // `members` to a single `role`. Members can be user accounts, service |
| // accounts, |
| // Google groups, and domains (such as G Suite). A `role` is a named |
| // list of |
| // permissions; each `role` can be an IAM predefined role or a |
| // user-created |
| // custom role. |
| // |
| // For some types of Google Cloud resources, a `binding` can also |
| // specify a |
| // `condition`, which is a logical expression that allows access to a |
| // resource |
| // only if the expression evaluates to `true`. A condition can add |
| // constraints |
| // based on attributes of the request, the resource, or both. To learn |
| // which |
| // resources support conditions in their IAM policies, see the |
| // [IAM |
| // documentation](https://cloud.google.com/iam/help/conditions/resource-p |
| // olicies). |
| // |
| // **JSON example:** |
| // |
| // { |
| // "bindings": [ |
| // { |
| // "role": "roles/resourcemanager.organizationAdmin", |
| // "members": [ |
| // "user:mike@example.com", |
| // "group:admins@example.com", |
| // "domain:google.com", |
| // |
| // "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| // ] |
| // }, |
| // { |
| // "role": "roles/resourcemanager.organizationViewer", |
| // "members": [ |
| // "user:eve@example.com" |
| // ], |
| // "condition": { |
| // "title": "expirable access", |
| // "description": "Does not grant access after Sep 2020", |
| // "expression": "request.time < |
| // timestamp('2020-10-01T00:00:00.000Z')", |
| // } |
| // } |
| // ], |
| // "etag": "BwWWja0YfJA=", |
| // "version": 3 |
| // } |
| // |
| // **YAML example:** |
| // |
| // bindings: |
| // - members: |
| // - user:mike@example.com |
| // - group:admins@example.com |
| // - domain:google.com |
| // - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| // role: roles/resourcemanager.organizationAdmin |
| // - members: |
| // - user:eve@example.com |
| // role: roles/resourcemanager.organizationViewer |
| // condition: |
| // title: expirable access |
| // description: Does not grant access after Sep 2020 |
| // expression: request.time < |
| // timestamp('2020-10-01T00:00:00.000Z') |
| // - etag: BwWWja0YfJA= |
| // - version: 3 |
| // |
| // For a description of IAM and its features, see the |
| // [IAM documentation](https://cloud.google.com/iam/docs/). |
| type Policy struct { |
| // Bindings: Associates a list of `members` to 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 member. |
| 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. |
| Etag string `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-p |
| // olicies). |
| Version int64 `json:"version,omitempty"` |
| |
| // ServerResponse contains the HTTP response code and headers from the |
| // server. |
| googleapi.ServerResponse `json:"-"` |
| |
| // ForceSendFields is a list of field names (e.g. "Bindings") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "Bindings") to include in |
| // API requests with the JSON null value. By default, fields with empty |
| // values are omitted from API requests. However, any field with an |
| // empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *Policy) MarshalJSON() ([]byte, error) { |
| type NoMethod Policy |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // PurgeQueueRequest: Request message for PurgeQueue. |
| type PurgeQueueRequest struct { |
| } |
| |
| // Queue: A queue is a container of related tasks. Queues are configured |
| // to manage |
| // how those tasks are dispatched. Configurable properties include rate |
| // limits, |
| // retry options, queue types, and others. |
| type Queue struct { |
| // AppEngineRoutingOverride: Overrides for |
| // task-level app_engine_routing. |
| // These settings apply only to |
| // App Engine tasks in this queue. |
| // Http tasks are not affected. |
| // |
| // If set, `app_engine_routing_override` is used for all |
| // App Engine tasks in the queue, no matter what the |
| // setting is for the |
| // task-level app_engine_routing. |
| AppEngineRoutingOverride *AppEngineRouting `json:"appEngineRoutingOverride,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-mana |
| // ging-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, see |
| // https://cloud.google.com/about/locations/. |
| // * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or |
| // hyphens (-). The maximum length is 100 characters. |
| Name string `json:"name,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_que |
| // ue). |
| // |
| // Purge time will be truncated to the nearest microsecond. Purge |
| // time will be unset if the queue has never been purged. |
| PurgeTime string `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 |
| // task |
| // attempts 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). |
| // |
| // The queue's actual dispatch rate is the result of: |
| // |
| // * Number of tasks in the queue |
| // * User-specified throttling: rate_limits, |
| // retry_config, and the |
| // queue's state. |
| // * System throttling due to `429` (Too Many Requests) or `503` |
| // (Service |
| // Unavailable) responses from the worker, high error rates, or to |
| // smooth |
| // sudden large traffic spikes. |
| 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"` |
| |
| // StackdriverLoggingConfig: Configuration options for writing logs |
| // to |
| // [Stackdriver Logging](https://cloud.google.com/logging/docs/). If |
| // this |
| // field is unset, then no logs are written. |
| StackdriverLoggingConfig *StackdriverLoggingConfig `json:"stackdriverLoggingConfig,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/pyt |
| // hon/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. |
| // "DISABLED" - The queue is disabled. |
| // |
| // A queue becomes `DISABLED` |
| // when |
| // [queue.yaml](https://cloud.google.com/appengine/docs/python/confi |
| // g/queueref) |
| // or |
| // [queue.xml](https://cloud.google.com/appengine/docs/sta |
| // ndard/java/config/queueref) |
| // is uploaded which does not contain the queue. You cannot directly |
| // disable |
| // a queue. |
| // |
| // When a queue is disabled, tasks can still be added to a queue |
| // but the tasks are not dispatched. |
| // |
| // To permanently delete this queue and all of its tasks, |
| // call |
| // DeleteQueue. |
| State string `json:"state,omitempty"` |
| |
| // ServerResponse contains the HTTP response code and headers from the |
| // server. |
| googleapi.ServerResponse `json:"-"` |
| |
| // ForceSendFields is a list of field names (e.g. |
| // "AppEngineRoutingOverride") to unconditionally include in API |
| // requests. By default, fields with empty values are omitted from API |
| // requests. However, any non-pointer, non-interface field appearing in |
| // ForceSendFields will be sent to the server regardless of whether the |
| // field is empty or not. This may be used to include empty fields in |
| // Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "AppEngineRoutingOverride") |
| // to include in API requests with the JSON null value. By default, |
| // fields with empty values are omitted from API requests. However, any |
| // field with an empty value appearing in NullFields will be sent to the |
| // server as null. It is an error if a field in this list has a |
| // non-empty value. This may be used to include null fields in Patch |
| // requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *Queue) MarshalJSON() ([]byte, error) { |
| type NoMethod Queue |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // RateLimits: Rate limits. |
| // |
| // This message determines the maximum rate that tasks can be dispatched |
| // by a |
| // queue, regardless of whether the dispatch is a first task attempt or |
| // a retry. |
| // |
| // Note: The debugging command, RunTask, will run a task |
| // even if the queue has reached its RateLimits. |
| type RateLimits struct { |
| // MaxBurstSize: Output only. 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. |
| // |
| // Cloud Tasks will pick the value of `max_burst_size` based on |
| // the |
| // value of |
| // max_dispatches_per_second. |
| // |
| // For 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/pyth |
| // on/config/queueref#bucket_size). |
| // Since `max_burst_size` is output only, if |
| // UpdateQueue is called on a queue |
| // created by `queue.yaml/xml`, `max_burst_size` will be reset based |
| // on the value of |
| // max_dispatches_per_second, |
| // regardless of whether |
| // max_dispatches_per_second |
| // is updated. |
| // |
| MaxBurstSize int64 `json:"maxBurstSize,omitempty"` |
| |
| // MaxConcurrentDispatches: 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 has the same meaning as |
| // [max_concurrent_requests |
| // in |
| // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/py |
| // thon/config/queueref#max_concurrent_requests). |
| MaxConcurrentDispatches int64 `json:"maxConcurrentDispatches,omitempty"` |
| |
| // MaxDispatchesPerSecond: The maximum rate at which tasks are |
| // dispatched from this queue. |
| // |
| // If unspecified when the queue is created, Cloud Tasks will pick |
| // the |
| // default. |
| // |
| // * The maximum allowed value is 500. |
| // |
| // |
| // This field has the same meaning as |
| // [rate |
| // in |
| // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/py |
| // thon/config/queueref#rate). |
| MaxDispatchesPerSecond float64 `json:"maxDispatchesPerSecond,omitempty"` |
| |
| // ForceSendFields is a list of field names (e.g. "MaxBurstSize") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "MaxBurstSize") to include |
| // in API requests with the JSON null value. By default, fields with |
| // empty values are omitted from API requests. However, any field with |
| // an empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *RateLimits) MarshalJSON() ([]byte, error) { |
| type NoMethod RateLimits |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| func (s *RateLimits) UnmarshalJSON(data []byte) error { |
| type NoMethod RateLimits |
| var s1 struct { |
| MaxDispatchesPerSecond gensupport.JSONFloat64 `json:"maxDispatchesPerSecond"` |
| *NoMethod |
| } |
| s1.NoMethod = (*NoMethod)(s) |
| if err := json.Unmarshal(data, &s1); err != nil { |
| return err |
| } |
| s.MaxDispatchesPerSecond = float64(s1.MaxDispatchesPerSecond) |
| return nil |
| } |
| |
| // ResumeQueueRequest: Request message for ResumeQueue. |
| type ResumeQueueRequest struct { |
| } |
| |
| // RetryConfig: Retry config. |
| // |
| // These settings determine when a failed task attempt is retried. |
| type RetryConfig struct { |
| // MaxAttempts: Number of attempts per 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 >= -1. |
| // |
| // If unspecified when the queue is created, Cloud Tasks will pick |
| // the |
| // default. |
| // |
| // -1 indicates unlimited attempts. |
| // |
| // This field has the same meaning as |
| // [task_retry_limit |
| // in |
| // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/py |
| // thon/config/queueref#retry_parameters). |
| MaxAttempts int64 `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. |
| // |
| // |
| // `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/py |
| // thon/config/queueref#retry_parameters). |
| MaxBackoff string `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 has the same meaning as |
| // [max_doublings |
| // in |
| // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/py |
| // thon/config/queueref#retry_parameters). |
| MaxDoublings int64 `json:"maxDoublings,omitempty"` |
| |
| // MaxRetryDuration: If positive, `max_retry_duration` specifies the |
| // time limit for |
| // retrying a failed task, measured from when the task was |
| // first |
| // attempted. Once `max_retry_duration` time has passed *and* the |
| // task has been attempted 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. |
| // |
| // |
| // `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/py |
| // thon/config/queueref#retry_parameters). |
| MaxRetryDuration string `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. |
| // |
| // |
| // `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/py |
| // thon/config/queueref#retry_parameters). |
| MinBackoff string `json:"minBackoff,omitempty"` |
| |
| // ForceSendFields is a list of field names (e.g. "MaxAttempts") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "MaxAttempts") to include |
| // in API requests with the JSON null value. By default, fields with |
| // empty values are omitted from API requests. However, any field with |
| // an empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *RetryConfig) MarshalJSON() ([]byte, error) { |
| type NoMethod RetryConfig |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // RunTaskRequest: Request message for forcing a task to run now |
| // using |
| // RunTask. |
| 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 |
| // body in AppEngineHttpRequest. |
| // Bodies 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. |
| ResponseView string `json:"responseView,omitempty"` |
| |
| // ForceSendFields is a list of field names (e.g. "ResponseView") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "ResponseView") to include |
| // in API requests with the JSON null value. By default, fields with |
| // empty values are omitted from API requests. However, any field with |
| // an empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *RunTaskRequest) MarshalJSON() ([]byte, error) { |
| type NoMethod RunTaskRequest |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // SetIamPolicyRequest: Request message for `SetIamPolicy` method. |
| type SetIamPolicyRequest struct { |
| // Policy: REQUIRED: The complete policy to be applied to the |
| // `resource`. The size of |
| // the policy is limited to a few 10s of KB. An empty policy is a |
| // valid policy but certain Cloud Platform services (such as |
| // Projects) |
| // might reject them. |
| Policy *Policy `json:"policy,omitempty"` |
| |
| // ForceSendFields is a list of field names (e.g. "Policy") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "Policy") to include in API |
| // requests with the JSON null value. By default, fields with empty |
| // values are omitted from API requests. However, any field with an |
| // empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *SetIamPolicyRequest) MarshalJSON() ([]byte, error) { |
| type NoMethod SetIamPolicyRequest |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // StackdriverLoggingConfig: Configuration options for writing logs |
| // to |
| // [Stackdriver Logging](https://cloud.google.com/logging/docs/). |
| type StackdriverLoggingConfig struct { |
| // SamplingRatio: Specifies the fraction of operations to write |
| // to |
| // [Stackdriver Logging](https://cloud.google.com/logging/docs/). |
| // This field may contain any value between 0.0 and 1.0, inclusive. |
| // 0.0 is the default and means that no operations are logged. |
| SamplingRatio float64 `json:"samplingRatio,omitempty"` |
| |
| // ForceSendFields is a list of field names (e.g. "SamplingRatio") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "SamplingRatio") to include |
| // in API requests with the JSON null value. By default, fields with |
| // empty values are omitted from API requests. However, any field with |
| // an empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *StackdriverLoggingConfig) MarshalJSON() ([]byte, error) { |
| type NoMethod StackdriverLoggingConfig |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| func (s *StackdriverLoggingConfig) UnmarshalJSON(data []byte) error { |
| type NoMethod StackdriverLoggingConfig |
| var s1 struct { |
| SamplingRatio gensupport.JSONFloat64 `json:"samplingRatio"` |
| *NoMethod |
| } |
| s1.NoMethod = (*NoMethod)(s) |
| if err := json.Unmarshal(data, &s1); err != nil { |
| return err |
| } |
| s.SamplingRatio = float64(s1.SamplingRatio) |
| return nil |
| } |
| |
| // Status: The `Status` type defines a logical error model that is |
| // suitable for |
| // different programming environments, including REST APIs and RPC APIs. |
| // It is |
| // used by [gRPC](https://github.com/grpc). Each `Status` message |
| // contains |
| // three pieces of data: error code, error message, and error |
| // details. |
| // |
| // You can find out more about this error model and how to work with it |
| // in the |
| // [API Design Guide](https://cloud.google.com/apis/design/errors). |
| type Status struct { |
| // Code: The status code, which should be an enum value of |
| // google.rpc.Code. |
| Code int64 `json:"code,omitempty"` |
| |
| // Details: A list of messages that carry the error details. There is a |
| // common set of |
| // message types for APIs to use. |
| Details []googleapi.RawMessage `json:"details,omitempty"` |
| |
| // Message: A developer-facing error message, which should be in |
| // English. Any |
| // user-facing error message should be localized and sent in |
| // the |
| // google.rpc.Status.details field, or localized by the client. |
| Message string `json:"message,omitempty"` |
| |
| // ForceSendFields is a list of field names (e.g. "Code") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "Code") to include in API |
| // requests with the JSON null value. By default, fields with empty |
| // values are omitted from API requests. However, any field with an |
| // empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *Status) MarshalJSON() ([]byte, error) { |
| type NoMethod Status |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // Task: A unit of scheduled work. |
| type Task struct { |
| // AppEngineHttpRequest: HTTP request that is sent to the App Engine app |
| // handler. |
| // |
| // 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. |
| CreateTime string `json:"createTime,omitempty"` |
| |
| // DispatchCount: Output only. The number of attempts dispatched. |
| // |
| // This count includes attempts which have been dispatched but |
| // haven't |
| // received a response. |
| DispatchCount int64 `json:"dispatchCount,omitempty"` |
| |
| // DispatchDeadline: The deadline for requests sent to the worker. If |
| // the worker does not |
| // respond by this deadline then the request is cancelled and the |
| // attempt |
| // is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry |
| // the |
| // task according to the RetryConfig. |
| // |
| // Note that when the request is cancelled, Cloud Tasks will stop |
| // listening |
| // for the response, but whether the worker stops processing depends on |
| // the |
| // worker. For example, if the worker is stuck, it may not react to |
| // cancelled |
| // requests. |
| // |
| // The default and maximum values depend on the type of request: |
| // |
| // * For HTTP tasks, the default is 10 minutes. The deadline |
| // must be in the interval [15 seconds, 30 minutes]. |
| // |
| // * For App Engine tasks, 0 indicates that the |
| // request has the default deadline. The default deadline depends on |
| // the |
| // [scaling |
| // |
| // type](https://cloud.google.com/appengine/docs/standard/go/how-instance |
| // s-are-managed#instance_scaling) |
| // of the service: 10 minutes for standard apps with automatic |
| // scaling, 24 |
| // hours for standard apps with manual and basic scaling, and 60 |
| // minutes for |
| // flex apps. If the request deadline is set, it must be in the |
| // interval [15 |
| // seconds, 24 hours 15 seconds]. Regardless of the task's |
| // `dispatch_deadline`, the app handler will not run for longer than |
| // than |
| // the service's timeout. We recommend setting the `dispatch_deadline` |
| // to |
| // at most a few seconds more than the app handler's timeout. For |
| // more |
| // information see |
| // |
| // [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-hand |
| // lers#timeouts). |
| // |
| // `dispatch_deadline` will be truncated to the nearest millisecond. |
| // The |
| // deadline is an approximate deadline. |
| DispatchDeadline string `json:"dispatchDeadline,omitempty"` |
| |
| // FirstAttempt: Output only. The status of the task's first |
| // attempt. |
| // |
| // Only dispatch_time will be set. |
| // The other Attempt information is not retained by Cloud Tasks. |
| FirstAttempt *Attempt `json:"firstAttempt,omitempty"` |
| |
| // HttpRequest: HTTP request that is sent to the worker. |
| // |
| // An HTTP task is a task that has HttpRequest set. |
| HttpRequest *HttpRequest `json:"httpRequest,omitempty"` |
| |
| // LastAttempt: Output only. The status of the task's last attempt. |
| LastAttempt *Attempt `json:"lastAttempt,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/tas |
| // ks/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-mana |
| // ging-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, see |
| // https://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. |
| Name string `json:"name,omitempty"` |
| |
| // ResponseCount: Output only. The number of attempts which have |
| // received a response. |
| ResponseCount int64 `json:"responseCount,omitempty"` |
| |
| // ScheduleTime: The time when the task is scheduled to be attempted or |
| // retried. |
| // |
| // `schedule_time` will be truncated to the nearest microsecond. |
| ScheduleTime string `json:"scheduleTime,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 |
| // body in AppEngineHttpRequest. |
| // Bodies 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. |
| View string `json:"view,omitempty"` |
| |
| // ServerResponse contains the HTTP response code and headers from the |
| // server. |
| googleapi.ServerResponse `json:"-"` |
| |
| // ForceSendFields is a list of field names (e.g. |
| // "AppEngineHttpRequest") to unconditionally include in API requests. |
| // By default, fields with empty values are omitted from API requests. |
| // However, any non-pointer, non-interface field appearing in |
| // ForceSendFields will be sent to the server regardless of whether the |
| // field is empty or not. This may be used to include empty fields in |
| // Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "AppEngineHttpRequest") to |
| // include in API requests with the JSON null value. By default, fields |
| // with empty values are omitted from API requests. However, any field |
| // with an empty value appearing in NullFields will be sent to the |
| // server as null. It is an error if a field in this list has a |
| // non-empty value. This may be used to include null fields in Patch |
| // requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *Task) MarshalJSON() ([]byte, error) { |
| type NoMethod Task |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // TestIamPermissionsRequest: Request message for `TestIamPermissions` |
| // method. |
| type TestIamPermissionsRequest struct { |
| // Permissions: The set of permissions to check for the `resource`. |
| // Permissions with |
| // wildcards (such as '*' or 'storage.*') are not allowed. For |
| // more |
| // information see |
| // [IAM |
| // Overview](https://cloud.google.com/iam/docs/overview#permissions). |
| Permissions []string `json:"permissions,omitempty"` |
| |
| // ForceSendFields is a list of field names (e.g. "Permissions") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "Permissions") to include |
| // in API requests with the JSON null value. By default, fields with |
| // empty values are omitted from API requests. However, any field with |
| // an empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *TestIamPermissionsRequest) MarshalJSON() ([]byte, error) { |
| type NoMethod TestIamPermissionsRequest |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // TestIamPermissionsResponse: Response message for `TestIamPermissions` |
| // method. |
| type TestIamPermissionsResponse struct { |
| // Permissions: A subset of `TestPermissionsRequest.permissions` that |
| // the caller is |
| // allowed. |
| Permissions []string `json:"permissions,omitempty"` |
| |
| // ServerResponse contains the HTTP response code and headers from the |
| // server. |
| googleapi.ServerResponse `json:"-"` |
| |
| // ForceSendFields is a list of field names (e.g. "Permissions") to |
| // unconditionally include in API requests. By default, fields with |
| // empty values are omitted from API requests. However, any non-pointer, |
| // non-interface field appearing in ForceSendFields will be sent to the |
| // server regardless of whether the field is empty or not. This may be |
| // used to include empty fields in Patch requests. |
| ForceSendFields []string `json:"-"` |
| |
| // NullFields is a list of field names (e.g. "Permissions") to include |
| // in API requests with the JSON null value. By default, fields with |
| // empty values are omitted from API requests. However, any field with |
| // an empty value appearing in NullFields will be sent to the server as |
| // null. It is an error if a field in this list has a non-empty value. |
| // This may be used to include null fields in Patch requests. |
| NullFields []string `json:"-"` |
| } |
| |
| func (s *TestIamPermissionsResponse) MarshalJSON() ([]byte, error) { |
| type NoMethod TestIamPermissionsResponse |
| raw := NoMethod(*s) |
| return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) |
| } |
| |
| // method id "cloudtasks.projects.locations.get": |
| |
| type ProjectsLocationsGetCall struct { |
| s *Service |
| name string |
| urlParams_ gensupport.URLParams |
| ifNoneMatch_ string |
| ctx_ context.Context |
| header_ http.Header |
| } |
| |
| // Get: Gets information about a location. |
| func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall { |
| c := &ProjectsLocationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} |
| c.name = name |
| return c |
| } |
| |
| // Fields allows partial responses to be retrieved. See |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse |
| // for more information. |
| func (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall { |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) |
| return c |
| } |
| |
| // IfNoneMatch sets the optional parameter which makes the operation |
| // fail if the object's ETag matches the given value. This is useful for |
| // getting updates only after the object has changed since the last |
| // request. Use googleapi.IsNotModified to check whether the response |
| // error from Do is the result of In-None-Match. |
| func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall { |
| c.ifNoneMatch_ = entityTag |
| return c |
| } |
| |
| // Context sets the context to be used in this call's Do method. Any |
| // pending HTTP request will be aborted if the provided context is |
| // canceled. |
| func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall { |
| c.ctx_ = ctx |
| return c |
| } |
| |
| // Header returns an http.Header that can be modified by the caller to |
| // add HTTP headers to the request. |
| func (c *ProjectsLocationsGetCall) Header() http.Header { |
| if c.header_ == nil { |
| c.header_ = make(http.Header) |
| } |
| return c.header_ |
| } |
| |
| func (c *ProjectsLocationsGetCall) doRequest(alt string) (*http.Response, error) { |
| reqHeaders := make(http.Header) |
| reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/20200708") |
| for k, v := range c.header_ { |
| reqHeaders[k] = v |
| } |
| reqHeaders.Set("User-Agent", c.s.userAgent()) |
| if c.ifNoneMatch_ != "" { |
| reqHeaders.Set("If-None-Match", c.ifNoneMatch_) |
| } |
| var body io.Reader = nil |
| c.urlParams_.Set("alt", alt) |
| c.urlParams_.Set("prettyPrint", "false") |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+name}") |
| urls += "?" + c.urlParams_.Encode() |
| req, err := http.NewRequest("GET", urls, body) |
| if err != nil { |
| return nil, err |
| } |
| req.Header = reqHeaders |
| googleapi.Expand(req.URL, map[string]string{ |
| "name": c.name, |
| }) |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) |
| } |
| |
| // Do executes the "cloudtasks.projects.locations.get" call. |
| // Exactly one of *Location or error will be non-nil. Any non-2xx status |
| // code is an error. Response headers are in either |
| // *Location.ServerResponse.Header or (if a response was returned at |
| // all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified |
| // to check whether the returned error was because |
| // http.StatusNotModified was returned. |
| func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error) { |
| gensupport.SetOptions(c.urlParams_, opts...) |
| res, err := c.doRequest("json") |
| if res != nil && res.StatusCode == http.StatusNotModified { |
| if res.Body != nil { |
| res.Body.Close() |
| } |
| return nil, &googleapi.Error{ |
| Code: res.StatusCode, |
| Header: res.Header, |
| } |
| } |
| if err != nil { |
| return nil, err |
| } |
| defer googleapi.CloseBody(res) |
| if err := googleapi.CheckResponse(res); err != nil { |
| return nil, err |
| } |
| ret := &Location{ |
| ServerResponse: googleapi.ServerResponse{ |
| Header: res.Header, |
| HTTPStatusCode: res.StatusCode, |
| }, |
| } |
| target := &ret |
| if err := gensupport.DecodeResponse(target, res); err != nil { |
| return nil, err |
| } |
| return ret, nil |
| // { |
| // "description": "Gets information about a location.", |
| // "flatPath": "v2/projects/{projectsId}/locations/{locationsId}", |
| // "httpMethod": "GET", |
| // "id": "cloudtasks.projects.locations.get", |
| // "parameterOrder": [ |
| // "name" |
| // ], |
| // "parameters": { |
| // "name": { |
| // "description": "Resource name for the location.", |
| // "location": "path", |
| // "pattern": "^projects/[^/]+/locations/[^/]+$", |
| // "required": true, |
| // "type": "string" |
| // } |
| // }, |
| // "path": "v2/{+name}", |
| // "response": { |
| // "$ref": "Location" |
| // }, |
| // "scopes": [ |
| // "https://www.googleapis.com/auth/cloud-platform" |
| // ] |
| // } |
| |
| } |
| |
| // method id "cloudtasks.projects.locations.list": |
| |
| type ProjectsLocationsListCall struct { |
| s *Service |
| name string |
| urlParams_ gensupport.URLParams |
| ifNoneMatch_ string |
| ctx_ context.Context |
| header_ http.Header |
| } |
| |
| // List: Lists information about the supported locations for this |
| // service. |
| func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall { |
| c := &ProjectsLocationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} |
| c.name = name |
| return c |
| } |
| |
| // Filter sets the optional parameter "filter": The standard list |
| // filter. |
| func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall { |
| c.urlParams_.Set("filter", filter) |
| return c |
| } |
| |
| // PageSize sets the optional parameter "pageSize": The standard list |
| // page size. |
| func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall { |
| c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) |
| return c |
| } |
| |
| // PageToken sets the optional parameter "pageToken": The standard list |
| // page token. |
| func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall { |
| c.urlParams_.Set("pageToken", pageToken) |
| return c |
| } |
| |
| // Fields allows partial responses to be retrieved. See |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse |
| // for more information. |
| func (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall { |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) |
| return c |
| } |
| |
| // IfNoneMatch sets the optional parameter which makes the operation |
| // fail if the object's ETag matches the given value. This is useful for |
| // getting updates only after the object has changed since the last |
| // request. Use googleapi.IsNotModified to check whether the response |
| // error from Do is the result of In-None-Match. |
| func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall { |
| c.ifNoneMatch_ = entityTag |
| return c |
| } |
| |
| // Context sets the context to be used in this call's Do method. Any |
| // pending HTTP request will be aborted if the provided context is |
| // canceled. |
| func (c *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall { |
| c.ctx_ = ctx |
| return c |
| } |
| |
| // Header returns an http.Header that can be modified by the caller to |
| // add HTTP headers to the request. |
| func (c *ProjectsLocationsListCall) Header() http.Header { |
| if c.header_ == nil { |
| c.header_ = make(http.Header) |
| } |
| return c.header_ |
| } |
| |
| func (c *ProjectsLocationsListCall) doRequest(alt string) (*http.Response, error) { |
| reqHeaders := make(http.Header) |
| reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/20200708") |
| for k, v := range c.header_ { |
| reqHeaders[k] = v |
| } |
| reqHeaders.Set("User-Agent", c.s.userAgent()) |
| if c.ifNoneMatch_ != "" { |
| reqHeaders.Set("If-None-Match", c.ifNoneMatch_) |
| } |
| var body io.Reader = nil |
| c.urlParams_.Set("alt", alt) |
| c.urlParams_.Set("prettyPrint", "false") |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+name}/locations") |
| urls += "?" + c.urlParams_.Encode() |
| req, err := http.NewRequest("GET", urls, body) |
| if err != nil { |
| return nil, err |
| } |
| req.Header = reqHeaders |
| googleapi.Expand(req.URL, map[string]string{ |
| "name": c.name, |
| }) |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) |
| } |
| |
| // Do executes the "cloudtasks.projects.locations.list" call. |
| // Exactly one of *ListLocationsResponse or error will be non-nil. Any |
| // non-2xx status code is an error. Response headers are in either |
| // *ListLocationsResponse.ServerResponse.Header or (if a response was |
| // returned at all) in error.(*googleapi.Error).Header. Use |
| // googleapi.IsNotModified to check whether the returned error was |
| // because http.StatusNotModified was returned. |
| func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, error) { |
| gensupport.SetOptions(c.urlParams_, opts...) |
| res, err := c.doRequest("json") |
| if res != nil && res.StatusCode == http.StatusNotModified { |
| if res.Body != nil { |
| res.Body.Close() |
| } |
| return nil, &googleapi.Error{ |
| Code: res.StatusCode, |
| Header: res.Header, |
| } |
| } |
| if err != nil { |
| return nil, err |
| } |
| defer googleapi.CloseBody(res) |
| if err := googleapi.CheckResponse(res); err != nil { |
| return nil, err |
| } |
| ret := &ListLocationsResponse{ |
| ServerResponse: googleapi.ServerResponse{ |
| Header: res.Header, |
| HTTPStatusCode: res.StatusCode, |
| }, |
| } |
| target := &ret |
| if err := gensupport.DecodeResponse(target, res); err != nil { |
| return nil, err |
| } |
| return ret, nil |
| // { |
| // "description": "Lists information about the supported locations for this service.", |
| // "flatPath": "v2/projects/{projectsId}/locations", |
| // "httpMethod": "GET", |
| // "id": "cloudtasks.projects.locations.list", |
| // "parameterOrder": [ |
| // "name" |
| // ], |
| // "parameters": { |
| // "filter": { |
| // "description": "The standard list filter.", |
| // "location": "query", |
| // "type": "string" |
| // }, |
| // "name": { |
| // "description": "The resource that owns the locations collection, if applicable.", |
| // "location": "path", |
| // "pattern": "^projects/[^/]+$", |
| // "required": true, |
| // "type": "string" |
| // }, |
| // "pageSize": { |
| // "description": "The standard list page size.", |
| // "format": "int32", |
| // "location": "query", |
| // "type": "integer" |
| // }, |
| // "pageToken": { |
| // "description": "The standard list page token.", |
| // "location": "query", |
| // "type": "string" |
| // } |
| // }, |
| // "path": "v2/{+name}/locations", |
| // "response": { |
| // "$ref": "ListLocationsResponse" |
| // }, |
| // "scopes": [ |
| // "https://www.googleapis.com/auth/cloud-platform" |
| // ] |
| // } |
| |
| } |
| |
| // 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 (c *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) error) error { |
| c.ctx_ = ctx |
| defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point |
| for { |
| x, err := c.Do() |
| if err != nil { |
| return err |
| } |
| if err := f(x); err != nil { |
| return err |
| } |
| if x.NextPageToken == "" { |
| return nil |
| } |
| c.PageToken(x.NextPageToken) |
| } |
| } |
| |
| // method id "cloudtasks.projects.locations.queues.create": |
| |
| type ProjectsLocationsQueuesCreateCall struct { |
| s *Service |
| parent string |
| queue *Queue |
| urlParams_ gensupport.URLParams |
| ctx_ context.Context |
| header_ http.Header |
| } |
| |
| // Create: Creates a queue. |
| // |
| // Queues created with this method allow tasks to live for a maximum of |
| // 31 |
| // days. After a task is 31 days old, the task will be deleted |
| // regardless of whether |
| // it was dispatched or not. |
| // |
| // WARNING: Using this method may have unintended side effects if you |
| // are |
| // using an App Engine `queue.yaml` or `queue.xml` file to manage your |
| // queues. |
| // Read |
| // [Overview of Queue Management |
| // and |
| // queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before |
| // using |
| // this method. |
| func (r *ProjectsLocationsQueuesService) Create(parent string, queue *Queue) *ProjectsLocationsQueuesCreateCall { |
| c := &ProjectsLocationsQueuesCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} |
| c.parent = parent |
| c.queue = queue |
| return c |
| } |
| |
| // Fields allows partial responses to be retrieved. See |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse |
| // for more information. |
| func (c *ProjectsLocationsQueuesCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesCreateCall { |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) |
| return c |
| } |
| |
| // Context sets the context to be used in this call's Do method. Any |
| // pending HTTP request will be aborted if the provided context is |
| // canceled. |
| func (c *ProjectsLocationsQueuesCreateCall) Context(ctx context.Context) *ProjectsLocationsQueuesCreateCall { |
| c.ctx_ = ctx |
| return c |
| } |
| |
| // Header returns an http.Header that can be modified by the caller to |
| // add HTTP headers to the request. |
| func (c *ProjectsLocationsQueuesCreateCall) Header() http.Header { |
| if c.header_ == nil { |
| c.header_ = make(http.Header) |
| } |
| return c.header_ |
| } |
| |
| func (c *ProjectsLocationsQueuesCreateCall) doRequest(alt string) (*http.Response, error) { |
| reqHeaders := make(http.Header) |
| reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/20200708") |
| for k, v := range c.header_ { |
| reqHeaders[k] = v |
| } |
| reqHeaders.Set("User-Agent", c.s.userAgent()) |
| var body io.Reader = nil |
| body, err := googleapi.WithoutDataWrapper.JSONReader(c.queue) |
| if err != nil { |
| return nil, err |
| } |
| reqHeaders.Set("Content-Type", "application/json") |
| c.urlParams_.Set("alt", alt) |
| c.urlParams_.Set("prettyPrint", "false") |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+parent}/queues") |
| urls += "?" + c.urlParams_.Encode() |
| req, err := http.NewRequest("POST", urls, body) |
| if err != nil { |
| return nil, err |
| } |
| req.Header = reqHeaders |
| googleapi.Expand(req.URL, map[string]string{ |
| "parent": c.parent, |
| }) |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) |
| } |
| |
| // Do executes the "cloudtasks.projects.locations.queues.create" call. |
| // Exactly one of *Queue or error will be non-nil. Any non-2xx status |
| // code is an error. Response headers are in either |
| // *Queue.ServerResponse.Header or (if a response was returned at all) |
| // in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to |
| // check whether the returned error was because http.StatusNotModified |
| // was returned. |
| func (c *ProjectsLocationsQueuesCreateCall) Do(opts ...googleapi.CallOption) (*Queue, error) { |
| gensupport.SetOptions(c.urlParams_, opts...) |
| res, err := c.doRequest("json") |
| if res != nil && res.StatusCode == http.StatusNotModified { |
| if res.Body != nil { |
| res.Body.Close() |
| } |
| return nil, &googleapi.Error{ |
| Code: res.StatusCode, |
| Header: res.Header, |
| } |
| } |
| if err != nil { |
| return nil, err |
| } |
| defer googleapi.CloseBody(res) |
| if err := googleapi.CheckResponse(res); err != nil { |
| return nil, err |
| } |
| ret := &Queue{ |
| ServerResponse: googleapi.ServerResponse{ |
| Header: res.Header, |
| HTTPStatusCode: res.StatusCode, |
| }, |
| } |
| target := &ret |
| if err := gensupport.DecodeResponse(target, res); err != nil { |
| return nil, err |
| } |
| return ret, nil |
| // { |
| // "description": "Creates a queue.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and\nqueue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using\nthis method.", |
| // "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues", |
| // "httpMethod": "POST", |
| // "id": "cloudtasks.projects.locations.queues.create", |
| // "parameterOrder": [ |
| // "parent" |
| // ], |
| // "parameters": { |
| // "parent": { |
| // "description": "Required. The location name in which the queue will be created.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`\n\nThe list of allowed locations can be obtained by calling Cloud\nTasks' implementation of\nListLocations.", |
| // "location": "path", |
| // "pattern": "^projects/[^/]+/locations/[^/]+$", |
| // "required": true, |
| // "type": "string" |
| // } |
| // }, |
| // "path": "v2/{+parent}/queues", |
| // "request": { |
| // "$ref": "Queue" |
| // }, |
| // "response": { |
| // "$ref": "Queue" |
| // }, |
| // "scopes": [ |
| // "https://www.googleapis.com/auth/cloud-platform" |
| // ] |
| // } |
| |
| } |
| |
| // method id "cloudtasks.projects.locations.queues.delete": |
| |
| type ProjectsLocationsQueuesDeleteCall struct { |
| s *Service |
| name string |
| urlParams_ gensupport.URLParams |
| ctx_ context.Context |
| header_ http.Header |
| } |
| |
| // Delete: Deletes a queue. |
| // |
| // This command will delete the queue even if it has tasks in it. |
| // |
| // Note: If you delete a queue, a queue with the same name can't be |
| // created |
| // for 7 days. |
| // |
| // WARNING: Using this method may have unintended side effects if you |
| // are |
| // using an App Engine `queue.yaml` or `queue.xml` file to manage your |
| // queues. |
| // Read |
| // [Overview of Queue Management |
| // and |
| // queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before |
| // using |
| // this method. |
| func (r *ProjectsLocationsQueuesService) Delete(name string) *ProjectsLocationsQueuesDeleteCall { |
| c := &ProjectsLocationsQueuesDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} |
| c.name = name |
| return c |
| } |
| |
| // Fields allows partial responses to be retrieved. See |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse |
| // for more information. |
| func (c *ProjectsLocationsQueuesDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesDeleteCall { |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) |
| return c |
| } |
| |
| // Context sets the context to be used in this call's Do method. Any |
| // pending HTTP request will be aborted if the provided context is |
| // canceled. |
| func (c *ProjectsLocationsQueuesDeleteCall) Context(ctx context.Context) *ProjectsLocationsQueuesDeleteCall { |
| c.ctx_ = ctx |
| return c |
| } |
| |
| // Header returns an http.Header that can be modified by the caller to |
| // add HTTP headers to the request. |
| func (c *ProjectsLocationsQueuesDeleteCall) Header() http.Header { |
| if c.header_ == nil { |
| c.header_ = make(http.Header) |
| } |
| return c.header_ |
| } |
| |
| func (c *ProjectsLocationsQueuesDeleteCall) doRequest(alt string) (*http.Response, error) { |
| reqHeaders := make(http.Header) |
| reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/20200708") |
| for k, v := range c.header_ { |
| reqHeaders[k] = v |
| } |
| reqHeaders.Set("User-Agent", c.s.userAgent()) |
| var body io.Reader = nil |
| c.urlParams_.Set("alt", alt) |
| c.urlParams_.Set("prettyPrint", "false") |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+name}") |
| urls += "?" + c.urlParams_.Encode() |
| req, err := http.NewRequest("DELETE", urls, body) |
| if err != nil { |
| return nil, err |
| } |
| req.Header = reqHeaders |
| googleapi.Expand(req.URL, map[string]string{ |
| "name": c.name, |
| }) |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) |
| } |
| |
| // Do executes the "cloudtasks.projects.locations.queues.delete" call. |
| // Exactly one of *Empty or error will be non-nil. Any non-2xx status |
| // code is an error. Response headers are in either |
| // *Empty.ServerResponse.Header or (if a response was returned at all) |
| // in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to |
| // check whether the returned error was because http.StatusNotModified |
| // was returned. |
| func (c *ProjectsLocationsQueuesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error) { |
| gensupport.SetOptions(c.urlParams_, opts...) |
| res, err := c.doRequest("json") |
| if res != nil && res.StatusCode == http.StatusNotModified { |
| if res.Body != nil { |
| res.Body.Close() |
| } |
| return nil, &googleapi.Error{ |
| Code: res.StatusCode, |
| Header: res.Header, |
| } |
| } |
| if err != nil { |
| return nil, err |
| } |
| defer googleapi.CloseBody(res) |
| if err := googleapi.CheckResponse(res); err != nil { |
| return nil, err |
| } |
| ret := &Empty{ |
| ServerResponse: googleapi.ServerResponse{ |
| Header: res.Header, |
| HTTPStatusCode: res.StatusCode, |
| }, |
| } |
| target := &ret |
| if err := gensupport.DecodeResponse(target, res); err != nil { |
| return nil, err |
| } |
| return ret, nil |
| // { |
| // "description": "Deletes a queue.\n\nThis command will delete the queue even if it has tasks in it.\n\nNote: If you delete a queue, a queue with the same name can't be created\nfor 7 days.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and\nqueue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using\nthis method.", |
| // "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}", |
| // "httpMethod": "DELETE", |
| // "id": "cloudtasks.projects.locations.queues.delete", |
| // "parameterOrder": [ |
| // "name" |
| // ], |
| // "parameters": { |
| // "name": { |
| // "description": "Required. The queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`", |
| // "location": "path", |
| // "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", |
| // "required": true, |
| // "type": "string" |
| // } |
| // }, |
| // "path": "v2/{+name}", |
| // "response": { |
| // "$ref": "Empty" |
| // }, |
| // "scopes": [ |
| // "https://www.googleapis.com/auth/cloud-platform" |
| // ] |
| // } |
| |
| } |
| |
| // method id "cloudtasks.projects.locations.queues.get": |
| |
| type ProjectsLocationsQueuesGetCall struct { |
| s *Service |
| name string |
| urlParams_ gensupport.URLParams |
| ifNoneMatch_ string |
| ctx_ context.Context |
| header_ http.Header |
| } |
| |
| // Get: Gets a queue. |
| func (r *ProjectsLocationsQueuesService) Get(name string) *ProjectsLocationsQueuesGetCall { |
| c := &ProjectsLocationsQueuesGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} |
| c.name = name |
| return c |
| } |
| |
| // Fields allows partial responses to be retrieved. See |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse |
| // for more information. |
| func (c *ProjectsLocationsQueuesGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesGetCall { |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) |
| return c |
| } |
| |
| // IfNoneMatch sets the optional parameter which makes the operation |
| // fail if the object's ETag matches the given value. This is useful for |
| // getting updates only after the object has changed since the last |
| // request. Use googleapi.IsNotModified to check whether the response |
| // error from Do is the result of In-None-Match. |
| func (c *ProjectsLocationsQueuesGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsQueuesGetCall { |
| c.ifNoneMatch_ = entityTag |
| return c |
| } |
| |
| // Context sets the context to be used in this call's Do method. Any |
| // pending HTTP request will be aborted if the provided context is |
| // canceled. |
| func (c *ProjectsLocationsQueuesGetCall) Context(ctx context.Context) *ProjectsLocationsQueuesGetCall { |
| c.ctx_ = ctx |
| return c |
| } |
| |
| // Header returns an http.Header that can be modified by the caller to |
| // add HTTP headers to the request. |
| func (c *ProjectsLocationsQueuesGetCall) Header() http.Header { |
| if c.header_ == nil { |
| c.header_ = make(http.Header) |
| } |
| return c.header_ |
| } |
| |
| func (c *ProjectsLocationsQueuesGetCall) doRequest(alt string) (*http.Response, error) { |
| reqHeaders := make(http.Header) |
| reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/20200708") |
| for k, v := range c.header_ { |
| reqHeaders[k] = v |
| } |
| reqHeaders.Set("User-Agent", c.s.userAgent()) |
| if c.ifNoneMatch_ != "" { |
| reqHeaders.Set("If-None-Match", c.ifNoneMatch_) |
| } |
| var body io.Reader = nil |
| c.urlParams_.Set("alt", alt) |
| c.urlParams_.Set("prettyPrint", "false") |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+name}") |
| urls += "?" + c.urlParams_.Encode() |
| req, err := http.NewRequest("GET", urls, body) |
| if err != nil { |
| return nil, err |
| } |
| req.Header = reqHeaders |
| googleapi.Expand(req.URL, map[string]string{ |
| "name": c.name, |
| }) |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) |
| } |
| |
| // Do executes the "cloudtasks.projects.locations.queues.get" call. |
| // Exactly one of *Queue or error will be non-nil. Any non-2xx status |
| // code is an error. Response headers are in either |
| // *Queue.ServerResponse.Header or (if a response was returned at all) |
| // in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to |
| // check whether the returned error was because http.StatusNotModified |
| // was returned. |
| func (c *ProjectsLocationsQueuesGetCall) Do(opts ...googleapi.CallOption) (*Queue, error) { |
| gensupport.SetOptions(c.urlParams_, opts...) |
| res, err := c.doRequest("json") |
| if res != nil && res.StatusCode == http.StatusNotModified { |
| if res.Body != nil { |
| res.Body.Close() |
| } |
| return nil, &googleapi.Error{ |
| Code: res.StatusCode, |
| Header: res.Header, |
| } |
| } |
| if err != nil { |
| return nil, err |
| } |
| defer googleapi.CloseBody(res) |
| if err := googleapi.CheckResponse(res); err != nil { |
| return nil, err |
| } |
| ret := &Queue{ |
| ServerResponse: googleapi.ServerResponse{ |
| Header: res.Header, |
| HTTPStatusCode: res.StatusCode, |
| }, |
| } |
| target := &ret |
| if err := gensupport.DecodeResponse(target, res); err != nil { |
| return nil, err |
| } |
| return ret, nil |
| // { |
| // "description": "Gets a queue.", |
| // "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}", |
| // "httpMethod": "GET", |
| // "id": "cloudtasks.projects.locations.queues.get", |
| // "parameterOrder": [ |
| // "name" |
| // ], |
| // "parameters": { |
| // "name": { |
| // "description": "Required. The resource name of the queue. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`", |
| // "location": "path", |
| // "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", |
| // "required": true, |
| // "type": "string" |
| // } |
| // }, |
| // "path": "v2/{+name}", |
| // "response": { |
| // "$ref": "Queue" |
| // }, |
| // "scopes": [ |
| // "https://www.googleapis.com/auth/cloud-platform" |
| // ] |
| // } |
| |
| } |
| |
| // method id "cloudtasks.projects.locations.queues.getIamPolicy": |
| |
| type ProjectsLocationsQueuesGetIamPolicyCall struct { |
| s *Service |
| resource string |
| getiampolicyrequest *GetIamPolicyRequest |
| urlParams_ gensupport.URLParams |
| ctx_ context.Context |
| header_ http.Header |
| } |
| |
| // GetIamPolicy: Gets the access control policy for a Queue. |
| // Returns an empty policy if the resource exists and does not have a |
| // policy |
| // set. |
| // |
| // Authorization requires the following |
| // [Google IAM](https://cloud.google.com/iam) permission on the |
| // specified |
| // resource parent: |
| // |
| // * `cloudtasks.queues.getIamPolicy` |
| func (r *ProjectsLocationsQueuesService) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *ProjectsLocationsQueuesGetIamPolicyCall { |
| c := &ProjectsLocationsQueuesGetIamPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)} |
| c.resource = resource |
| c.getiampolicyrequest = getiampolicyrequest |
| return c |
| } |
| |
| // Fields allows partial responses to be retrieved. See |
| // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse |
| // for more information. |
| func (c *ProjectsLocationsQueuesGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueuesGetIamPolicyCall { |
| c.urlParams_.Set("fields", googleapi.CombineFields(s)) |
| return c |
| } |
| |
| // Context sets the context to be used in this call's Do method. Any |
| // pending HTTP request will be aborted if the provided context is |
| // canceled. |
| func (c *ProjectsLocationsQueuesGetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsQueuesGetIamPolicyCall { |
| c.ctx_ = ctx |
| return c |
| } |
| |
| // Header returns an http.Header that can be modified by the caller to |
| // add HTTP headers to the request. |
| func (c *ProjectsLocationsQueuesGetIamPolicyCall) Header() http.Header { |
| if c.header_ == nil { |
| c.header_ = make(http.Header) |
| } |
| return c.header_ |
| } |
| |
| func (c *ProjectsLocationsQueuesGetIamPolicyCall) doRequest(alt string) (*http.Response, error) { |
| reqHeaders := make(http.Header) |
| reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/20200708") |
| for k, v := range c.header_ { |
| reqHeaders[k] = v |
| } |
| reqHeaders.Set("User-Agent", c.s.userAgent()) |
| var body io.Reader = nil |
| body, err := googleapi.WithoutDataWrapper.JSONReader(c.getiampolicyrequest) |
| if err != nil { |
| return nil, err |
| } |
| reqHeaders.Set("Content-Type", "application/json") |
| c.urlParams_.Set("alt", alt) |
| c.urlParams_.Set("prettyPrint", "false") |
| urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+resource}:getIamPolicy") |
| urls += "?" + c.urlParams_.Encode() |
| req, err := http.NewRequest("POST", urls, body) |
| if err != nil { |
| return nil, err |
| } |
| req.Header = reqHeaders |
| googleapi.Expand(req.URL, map[string]string{ |
| "resource": c.resource, |
| }) |
| return gensupport.SendRequest(c.ctx_, c.s.client, req) |
| } |
| |
| // Do executes the "cloudtasks.projects.locations.queues.getIamPolicy" call. |
| // Exactly one of *Policy or error will be non-nil. Any non-2xx status |
| // code is an error. Response headers are in either |
| // *Policy.ServerResponse.Header or (if a response was returned at all) |
| // in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to |
| // check whether the returned error was because http.StatusNotModified |
| // was returned. |
| func (c *ProjectsLocationsQueuesGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error) { |
| gensupport.SetOptions(c.urlParams_, opts...) |
| res, err := c.doRequest("json") |
| if res != nil && res.StatusCode == http.StatusNotModified { |
| if res.Body != nil { |
| res.Body.Close() |
| } |
| return nil, &googleapi.Error{ |
| Code: res.StatusCode, |
| Header: res.Header, |
| } |
| } |
| if err != nil { |
| return nil, err |
| } |
| defer googleapi.CloseBody(res) |
| if err := googleapi.CheckResponse(res); err != nil { |
| return nil, err |
| } |
| ret := &Policy{ |
| ServerResponse: googleapi.ServerResponse{ |
| Header: res.Header, |
| HTTPStatusCode: res.StatusCode, |
| }, |
| } |
| target := &ret |
| if err := gensupport.DecodeResponse(target, res); err != nil { |
| return nil, err |
| } |
| return ret, nil |
| // { |
| // "description": "Gets the access control policy for a Queue.\nReturns an empty policy if the resource exists and does not have a policy\nset.\n\nAuthorization requires the following\n[Google IAM](https://cloud.google.com/iam) permission on the specified\nresource parent:\n\n* `cloudtasks.queues.getIamPolicy`", |
| // "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:getIamPolicy", |
| // "httpMethod": "POST", |
| // "id": "cloudtasks.projects.locations.queues.getIamPolicy", |
| // "parameterOrder": [ |
| // "resource" |
| // ], |
| // "parameters": { |
| // "resource": { |
| // "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", |
| // "location": "path", |
| // "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", |
| // "required": true, |
| // "type": "string" |
| // } |
| // }, |
| // "path": "v2/{+resource}:getIamPolicy", |
| // "request": { |
| // "$ref": "GetIamPolicyRequest" |
| // }, |
| // "response": { |
| // "$ref": "Policy" |
| // }, |
| // "scopes": [ |
| // "https://www.googleapis.com/auth/cloud-platform" |
| // ] |
| // } |
| |
| } |
| |
| // method id "cloudtasks.projects.locations.queues.list": |
| |
| type ProjectsLocationsQueuesListCall struct { |
| s *Service |
| parent string |
| urlParams_ gensupport.URLParams |
| ifNoneMatch_ string |
| ctx_ context.Context |
| header_ http.Header |
| } |
| |
| // List: Lists queues. |
| // |
| // Queues are returned in lexicographical order. |
| func (r *ProjectsLocationsQueuesService) List(parent string) *ProjectsLocationsQueuesListCall { |
| c := &ProjectsLocationsQueuesListCall{s: r.s, urlParams_: make(gensupport.URLParams)} |
| c.parent = parent |
| return c |
| } |
| |
| // Filter sets the optional parameter "filter": `filter` can be used to |
| // specify a subset of queues. Any Queue |
| // field can be used as a filter and several operators as supported. |
| // For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same |
| // as |
| // described in |
| // [Stackdriver's Advanced |
| // Logs |
| // Filters](https://cloud.google.com/logging/docs/view/advanced_filt |
| // ers). |
| // |
| // Sample filter "state: PAUSED". |
| // |
| // Note that using filters might cause fewer queues than the |
| // requested page_size to be returned. |
| <
|