1 // Copyright 2022 Google LLC 2 // 3 // Licensed under the Apache License, Version 2.0 (the "License"); 4 // you may not use this file except in compliance with the License. 5 // You may obtain a copy of the License at 6 // 7 // http://www.apache.org/licenses/LICENSE-2.0 8 // 9 // Unless required by applicable law or agreed to in writing, software 10 // distributed under the License is distributed on an "AS IS" BASIS, 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 // See the License for the specific language governing permissions and 13 // limitations under the License. 14 15 // Code generated by aliasgen. DO NOT EDIT. 16 17 // Package cloudtasks aliases all exported identifiers in package 18 // "cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb". 19 // 20 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb. 21 // Please read https://github.com/googleapis/google-cloud-go/blob/main/migration.md 22 // for more details. 23 package cloudtasks 24 25 import ( 26 src "cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb" 27 grpc "google.golang.org/grpc" 28 ) 29 30 // Deprecated: Please use consts in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 31 const ( 32 HttpMethod_DELETE = src.HttpMethod_DELETE 33 HttpMethod_GET = src.HttpMethod_GET 34 HttpMethod_HEAD = src.HttpMethod_HEAD 35 HttpMethod_HTTP_METHOD_UNSPECIFIED = src.HttpMethod_HTTP_METHOD_UNSPECIFIED 36 HttpMethod_OPTIONS = src.HttpMethod_OPTIONS 37 HttpMethod_PATCH = src.HttpMethod_PATCH 38 HttpMethod_POST = src.HttpMethod_POST 39 HttpMethod_PUT = src.HttpMethod_PUT 40 Queue_DISABLED = src.Queue_DISABLED 41 Queue_PAUSED = src.Queue_PAUSED 42 Queue_RUNNING = src.Queue_RUNNING 43 Queue_STATE_UNSPECIFIED = src.Queue_STATE_UNSPECIFIED 44 Task_BASIC = src.Task_BASIC 45 Task_FULL = src.Task_FULL 46 Task_VIEW_UNSPECIFIED = src.Task_VIEW_UNSPECIFIED 47 ) 48 49 // Deprecated: Please use vars in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 50 var ( 51 File_google_cloud_tasks_v2_cloudtasks_proto = src.File_google_cloud_tasks_v2_cloudtasks_proto 52 File_google_cloud_tasks_v2_queue_proto = src.File_google_cloud_tasks_v2_queue_proto 53 File_google_cloud_tasks_v2_target_proto = src.File_google_cloud_tasks_v2_target_proto 54 File_google_cloud_tasks_v2_task_proto = src.File_google_cloud_tasks_v2_task_proto 55 HttpMethod_name = src.HttpMethod_name 56 HttpMethod_value = src.HttpMethod_value 57 Queue_State_name = src.Queue_State_name 58 Queue_State_value = src.Queue_State_value 59 Task_View_name = src.Task_View_name 60 Task_View_value = src.Task_View_value 61 ) 62 63 // App Engine HTTP request. The message defines the HTTP request that is sent 64 // to an App Engine app when the task is dispatched. Using 65 // [AppEngineHttpRequest][google.cloud.tasks.v2.AppEngineHttpRequest] requires 66 // [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) 67 // Google IAM permission for the project and the following scope: 68 // `https://www.googleapis.com/auth/cloud-platform` The task will be delivered 69 // to the App Engine app which belongs to the same project as the queue. For 70 // more information, see [How Requests are 71 // Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) 72 // and how routing is affected by [dispatch 73 // files](https://cloud.google.com/appengine/docs/python/config/dispatchref). 74 // Traffic is encrypted during transport and never leaves Google datacenters. 75 // Because this traffic is carried over a communication mechanism internal to 76 // Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). 77 // The request to the handler, however, will appear to have used the HTTP 78 // protocol. The [AppEngineRouting][google.cloud.tasks.v2.AppEngineRouting] 79 // used to construct the URL that the task is delivered to can be set at the 80 // queue-level or task-level: - If [app_engine_routing_override is set on the 81 // queue][Queue.app_engine_routing_override], this value is used for all tasks 82 // in the queue, no matter what the setting is for the [task-level 83 // app_engine_routing][AppEngineHttpRequest.app_engine_routing]. The `url` that 84 // the task will be sent to is: - `url =` 85 // [host][google.cloud.tasks.v2.AppEngineRouting.host] `+` 86 // [relative_uri][google.cloud.tasks.v2.AppEngineHttpRequest.relative_uri] 87 // Tasks can be dispatched to secure app handlers, unsecure app handlers, and 88 // URIs restricted with [`login: 89 // admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). 90 // Because tasks are not run as any user, they cannot be dispatched to URIs 91 // restricted with [`login: 92 // required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) 93 // Task dispatches also do not follow redirects. The task attempt has succeeded 94 // if the app's request handler returns an HTTP response code in the range 95 // [`200` - `299`]. The task attempt has failed if the app's handler returns a 96 // non-2xx response code or Cloud Tasks does not receive response before the 97 // [deadline][google.cloud.tasks.v2.Task.dispatch_deadline]. Failed tasks will 98 // be retried according to the [retry 99 // configuration][google.cloud.tasks.v2.Queue.retry_config]. `503` (Service 100 // Unavailable) is considered an App Engine system error instead of an 101 // application error and will cause Cloud Tasks' traffic congestion control to 102 // temporarily throttle the queue's dispatches. Unlike other types of task 103 // targets, a `429` (Too Many Requests) response from an app handler does not 104 // cause traffic congestion control to throttle the queue. 105 // 106 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 107 type AppEngineHttpRequest = src.AppEngineHttpRequest 108 109 // App Engine Routing. Defines routing characteristics specific to App Engine 110 // - service, version, and instance. For more information about services, 111 // versions, and instances see [An Overview of App 112 // Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), 113 // [Microservices Architecture on Google App 114 // Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), 115 // [App Engine Standard request 116 // routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), 117 // and [App Engine Flex request 118 // routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 119 // Using [AppEngineRouting][google.cloud.tasks.v2.AppEngineRouting] requires 120 // [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) 121 // Google IAM permission for the project and the following scope: 122 // `https://www.googleapis.com/auth/cloud-platform` 123 // 124 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 125 type AppEngineRouting = src.AppEngineRouting 126 127 // The status of a task attempt. 128 // 129 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 130 type Attempt = src.Attempt 131 132 // CloudTasksClient is the client API for CloudTasks service. For semantics 133 // around ctx use and closing/ending streaming RPCs, please refer to 134 // https://godoc.org/google.golang.org/grpc#ClientConn.NewStream. 135 // 136 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 137 type CloudTasksClient = src.CloudTasksClient 138 139 // CloudTasksServer is the server API for CloudTasks service. 140 // 141 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 142 type CloudTasksServer = src.CloudTasksServer 143 144 // Request message for 145 // [CreateQueue][google.cloud.tasks.v2.CloudTasks.CreateQueue]. 146 // 147 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 148 type CreateQueueRequest = src.CreateQueueRequest 149 150 // Request message for 151 // [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask]. 152 // 153 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 154 type CreateTaskRequest = src.CreateTaskRequest 155 156 // Request message for 157 // [DeleteQueue][google.cloud.tasks.v2.CloudTasks.DeleteQueue]. 158 // 159 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 160 type DeleteQueueRequest = src.DeleteQueueRequest 161 162 // Request message for deleting a task using 163 // [DeleteTask][google.cloud.tasks.v2.CloudTasks.DeleteTask]. 164 // 165 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 166 type DeleteTaskRequest = src.DeleteTaskRequest 167 168 // Request message for [GetQueue][google.cloud.tasks.v2.CloudTasks.GetQueue]. 169 // 170 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 171 type GetQueueRequest = src.GetQueueRequest 172 173 // Request message for getting a task using 174 // [GetTask][google.cloud.tasks.v2.CloudTasks.GetTask]. 175 // 176 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 177 type GetTaskRequest = src.GetTaskRequest 178 179 // The HTTP method used to deliver the task. 180 // 181 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 182 type HttpMethod = src.HttpMethod 183 184 // HTTP request. The task will be pushed to the worker as an HTTP request. If 185 // the worker or the redirected worker acknowledges the task by returning a 186 // successful HTTP response code ([`200` - `299`]), the task will be removed 187 // from the queue. If any other HTTP response code is returned or no response 188 // is received, the task will be retried according to the following: - 189 // User-specified throttling: [retry 190 // configuration][google.cloud.tasks.v2.Queue.retry_config], [rate 191 // limits][google.cloud.tasks.v2.Queue.rate_limits], and the [queue's 192 // state][google.cloud.tasks.v2.Queue.state]. - System throttling: To prevent 193 // the worker from overloading, Cloud Tasks may temporarily reduce the queue's 194 // effective rate. User-specified settings will not be changed. System 195 // throttling happens because: - Cloud Tasks backs off on all errors. Normally 196 // the backoff specified in [rate 197 // limits][google.cloud.tasks.v2.Queue.rate_limits] will be used. But if the 198 // worker returns `429` (Too Many Requests), `503` (Service Unavailable), or 199 // the rate of errors is high, Cloud Tasks will use a higher backoff rate. The 200 // retry specified in the `Retry-After` HTTP response header is considered. - 201 // To prevent traffic spikes and to smooth sudden increases in traffic, 202 // dispatches ramp up slowly when the queue is newly created or idle and if 203 // large numbers of tasks suddenly become available to dispatch (due to spikes 204 // in create task rates, the queue being unpaused, or many tasks that are 205 // scheduled at the same time). 206 // 207 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 208 type HttpRequest = src.HttpRequest 209 type HttpRequest_OauthToken = src.HttpRequest_OauthToken 210 type HttpRequest_OidcToken = src.HttpRequest_OidcToken 211 212 // Request message for 213 // [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues]. 214 // 215 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 216 type ListQueuesRequest = src.ListQueuesRequest 217 218 // Response message for 219 // [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues]. 220 // 221 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 222 type ListQueuesResponse = src.ListQueuesResponse 223 224 // Request message for listing tasks using 225 // [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks]. 226 // 227 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 228 type ListTasksRequest = src.ListTasksRequest 229 230 // Response message for listing tasks using 231 // [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks]. 232 // 233 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 234 type ListTasksResponse = src.ListTasksResponse 235 236 // Contains information needed for generating an [OAuth 237 // token](https://developers.google.com/identity/protocols/OAuth2). This type 238 // of authorization should generally only be used when calling Google APIs 239 // hosted on *.googleapis.com. 240 // 241 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 242 type OAuthToken = src.OAuthToken 243 244 // Contains information needed for generating an [OpenID Connect 245 // token](https://developers.google.com/identity/protocols/OpenIDConnect). This 246 // type of authorization can be used for many scenarios, including calling 247 // Cloud Run, or endpoints where you intend to validate the token yourself. 248 // 249 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 250 type OidcToken = src.OidcToken 251 252 // Request message for 253 // [PauseQueue][google.cloud.tasks.v2.CloudTasks.PauseQueue]. 254 // 255 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 256 type PauseQueueRequest = src.PauseQueueRequest 257 258 // Request message for 259 // [PurgeQueue][google.cloud.tasks.v2.CloudTasks.PurgeQueue]. 260 // 261 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 262 type PurgeQueueRequest = src.PurgeQueueRequest 263 264 // A queue is a container of related tasks. Queues are configured to manage 265 // how those tasks are dispatched. Configurable properties include rate limits, 266 // retry options, queue types, and others. 267 // 268 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 269 type Queue = src.Queue 270 271 // State of the queue. 272 // 273 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 274 type Queue_State = src.Queue_State 275 276 // Rate limits. This message determines the maximum rate that tasks can be 277 // dispatched by a queue, regardless of whether the dispatch is a first task 278 // attempt or a retry. Note: The debugging command, 279 // [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask], will run a task even if 280 // the queue has reached its [RateLimits][google.cloud.tasks.v2.RateLimits]. 281 // 282 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 283 type RateLimits = src.RateLimits 284 285 // Request message for 286 // [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue]. 287 // 288 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 289 type ResumeQueueRequest = src.ResumeQueueRequest 290 291 // Retry config. These settings determine when a failed task attempt is 292 // retried. 293 // 294 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 295 type RetryConfig = src.RetryConfig 296 297 // Request message for forcing a task to run now using 298 // [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask]. 299 // 300 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 301 type RunTaskRequest = src.RunTaskRequest 302 303 // Configuration options for writing logs to [Stackdriver 304 // Logging](https://cloud.google.com/logging/docs/). 305 // 306 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 307 type StackdriverLoggingConfig = src.StackdriverLoggingConfig 308 309 // A unit of scheduled work. 310 // 311 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 312 type Task = src.Task 313 type Task_AppEngineHttpRequest = src.Task_AppEngineHttpRequest 314 type Task_HttpRequest = src.Task_HttpRequest 315 316 // The view specifies a subset of [Task][google.cloud.tasks.v2.Task] data. 317 // When a task is returned in a response, not all information is retrieved by 318 // default because some data, such as payloads, might be desirable to return 319 // only when needed because of its large size or because of the sensitivity of 320 // data that it contains. 321 // 322 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 323 type Task_View = src.Task_View 324 325 // UnimplementedCloudTasksServer can be embedded to have forward compatible 326 // implementations. 327 // 328 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 329 type UnimplementedCloudTasksServer = src.UnimplementedCloudTasksServer 330 331 // Request message for 332 // [UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue]. 333 // 334 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 335 type UpdateQueueRequest = src.UpdateQueueRequest 336 337 // Deprecated: Please use funcs in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 338 func NewCloudTasksClient(cc grpc.ClientConnInterface) CloudTasksClient { 339 return src.NewCloudTasksClient(cc) 340 } 341 342 // Deprecated: Please use funcs in: cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb 343 func RegisterCloudTasksServer(s *grpc.Server, srv CloudTasksServer) { 344 src.RegisterCloudTasksServer(s, srv) 345 } 346