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/apiv2beta3/cloudtaskspb". 19 // 20 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/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/apiv2beta3/cloudtaskspb" 27 grpc "google.golang.org/grpc" 28 ) 29 30 // Deprecated: Please use consts in: cloud.google.com/go/cloudtasks/apiv2beta3/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_PULL = src.Queue_PULL 43 Queue_PUSH = src.Queue_PUSH 44 Queue_RUNNING = src.Queue_RUNNING 45 Queue_STATE_UNSPECIFIED = src.Queue_STATE_UNSPECIFIED 46 Queue_TYPE_UNSPECIFIED = src.Queue_TYPE_UNSPECIFIED 47 Task_BASIC = src.Task_BASIC 48 Task_FULL = src.Task_FULL 49 Task_VIEW_UNSPECIFIED = src.Task_VIEW_UNSPECIFIED 50 ) 51 52 // Deprecated: Please use vars in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 53 var ( 54 File_google_cloud_tasks_v2beta3_cloudtasks_proto = src.File_google_cloud_tasks_v2beta3_cloudtasks_proto 55 File_google_cloud_tasks_v2beta3_queue_proto = src.File_google_cloud_tasks_v2beta3_queue_proto 56 File_google_cloud_tasks_v2beta3_target_proto = src.File_google_cloud_tasks_v2beta3_target_proto 57 File_google_cloud_tasks_v2beta3_task_proto = src.File_google_cloud_tasks_v2beta3_task_proto 58 HttpMethod_name = src.HttpMethod_name 59 HttpMethod_value = src.HttpMethod_value 60 Queue_State_name = src.Queue_State_name 61 Queue_State_value = src.Queue_State_value 62 Queue_Type_name = src.Queue_Type_name 63 Queue_Type_value = src.Queue_Type_value 64 Task_View_name = src.Task_View_name 65 Task_View_value = src.Task_View_value 66 ) 67 68 // App Engine HTTP queue. The task will be delivered to the App Engine 69 // application hostname specified by its 70 // [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] and 71 // [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest]. The 72 // documentation for 73 // [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest] 74 // explains how the task's host URL is constructed. Using 75 // [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] requires 76 // [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) 77 // Google IAM permission for the project and the following scope: 78 // `https://www.googleapis.com/auth/cloud-platform` 79 // 80 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 81 type AppEngineHttpQueue = src.AppEngineHttpQueue 82 83 // App Engine HTTP request. The message defines the HTTP request that is sent 84 // to an App Engine app when the task is dispatched. Using 85 // [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest] 86 // requires 87 // [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) 88 // Google IAM permission for the project and the following scope: 89 // `https://www.googleapis.com/auth/cloud-platform` The task will be delivered 90 // to the App Engine app which belongs to the same project as the queue. For 91 // more information, see [How Requests are 92 // Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) 93 // and how routing is affected by [dispatch 94 // files](https://cloud.google.com/appengine/docs/python/config/dispatchref). 95 // Traffic is encrypted during transport and never leaves Google datacenters. 96 // Because this traffic is carried over a communication mechanism internal to 97 // Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). 98 // The request to the handler, however, will appear to have used the HTTP 99 // protocol. The 100 // [AppEngineRouting][google.cloud.tasks.v2beta3.AppEngineRouting] used to 101 // construct the URL that the task is delivered to can be set at the 102 // queue-level or task-level: - If set, 103 // [app_engine_routing_override][google.cloud.tasks.v2beta3.AppEngineHttpQueue.app_engine_routing_override] 104 // is used for all tasks in the queue, no matter what the setting is for the 105 // [task-level 106 // app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing]. 107 // The `url` that the task will be sent to is: - `url =` 108 // [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] `+` 109 // [relative_uri][google.cloud.tasks.v2beta3.AppEngineHttpRequest.relative_uri] 110 // Tasks can be dispatched to secure app handlers, unsecure app handlers, and 111 // URIs restricted with [`login: 112 // admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). 113 // Because tasks are not run as any user, they cannot be dispatched to URIs 114 // restricted with [`login: 115 // required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) 116 // Task dispatches also do not follow redirects. The task attempt has succeeded 117 // if the app's request handler returns an HTTP response code in the range 118 // [`200` - `299`]. The task attempt has failed if the app's handler returns a 119 // non-2xx response code or Cloud Tasks does not receive response before the 120 // [deadline][google.cloud.tasks.v2beta3.Task.dispatch_deadline]. Failed tasks 121 // will be retried according to the [retry 122 // configuration][google.cloud.tasks.v2beta3.Queue.retry_config]. `503` 123 // (Service Unavailable) is considered an App Engine system error instead of an 124 // application error and will cause Cloud Tasks' traffic congestion control to 125 // temporarily throttle the queue's dispatches. Unlike other types of task 126 // targets, a `429` (Too Many Requests) response from an app handler does not 127 // cause traffic congestion control to throttle the queue. 128 // 129 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 130 type AppEngineHttpRequest = src.AppEngineHttpRequest 131 132 // App Engine Routing. Defines routing characteristics specific to App Engine 133 // - service, version, and instance. For more information about services, 134 // versions, and instances see [An Overview of App 135 // Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), 136 // [Microservices Architecture on Google App 137 // Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), 138 // [App Engine Standard request 139 // routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), 140 // and [App Engine Flex request 141 // routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). 142 // 143 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 144 type AppEngineRouting = src.AppEngineRouting 145 146 // The status of a task attempt. 147 // 148 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 149 type Attempt = src.Attempt 150 151 // CloudTasksClient is the client API for CloudTasks service. For semantics 152 // around ctx use and closing/ending streaming RPCs, please refer to 153 // https://godoc.org/google.golang.org/grpc#ClientConn.NewStream. 154 // 155 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 156 type CloudTasksClient = src.CloudTasksClient 157 158 // CloudTasksServer is the server API for CloudTasks service. 159 // 160 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 161 type CloudTasksServer = src.CloudTasksServer 162 163 // Request message for 164 // [CreateQueue][google.cloud.tasks.v2beta3.CloudTasks.CreateQueue]. 165 // 166 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 167 type CreateQueueRequest = src.CreateQueueRequest 168 169 // Request message for 170 // [CreateTask][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. 171 // 172 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 173 type CreateTaskRequest = src.CreateTaskRequest 174 175 // Request message for 176 // [DeleteQueue][google.cloud.tasks.v2beta3.CloudTasks.DeleteQueue]. 177 // 178 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 179 type DeleteQueueRequest = src.DeleteQueueRequest 180 181 // Request message for deleting a task using 182 // [DeleteTask][google.cloud.tasks.v2beta3.CloudTasks.DeleteTask]. 183 // 184 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 185 type DeleteTaskRequest = src.DeleteTaskRequest 186 187 // Request message for 188 // [GetQueue][google.cloud.tasks.v2beta3.CloudTasks.GetQueue]. 189 // 190 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 191 type GetQueueRequest = src.GetQueueRequest 192 193 // Request message for getting a task using 194 // [GetTask][google.cloud.tasks.v2beta3.CloudTasks.GetTask]. 195 // 196 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 197 type GetTaskRequest = src.GetTaskRequest 198 199 // The HTTP method used to execute the task. 200 // 201 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 202 type HttpMethod = src.HttpMethod 203 204 // HTTP request. The task will be pushed to the worker as an HTTP request. If 205 // the worker or the redirected worker acknowledges the task by returning a 206 // successful HTTP response code ([`200` - `299`]), the task will be removed 207 // from the queue. If any other HTTP response code is returned or no response 208 // is received, the task will be retried according to the following: - 209 // User-specified throttling: [retry 210 // configuration][google.cloud.tasks.v2beta3.Queue.retry_config], [rate 211 // limits][google.cloud.tasks.v2beta3.Queue.rate_limits], and the [queue's 212 // state][google.cloud.tasks.v2beta3.Queue.state]. - System throttling: To 213 // prevent the worker from overloading, Cloud Tasks may temporarily reduce the 214 // queue's effective rate. User-specified settings will not be changed. System 215 // throttling happens because: - Cloud Tasks backs off on all errors. Normally 216 // the backoff specified in [rate 217 // limits][google.cloud.tasks.v2beta3.Queue.rate_limits] will be used. But if 218 // the worker returns `429` (Too Many Requests), `503` (Service Unavailable), 219 // or the rate of errors is high, Cloud Tasks will use a higher backoff rate. 220 // The retry specified in the `Retry-After` HTTP response header is considered. 221 // - To prevent traffic spikes and to smooth sudden increases in traffic, 222 // dispatches ramp up slowly when the queue is newly created or idle and if 223 // large numbers of tasks suddenly become available to dispatch (due to spikes 224 // in create task rates, the queue being unpaused, or many tasks that are 225 // scheduled at the same time). 226 // 227 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 228 type HttpRequest = src.HttpRequest 229 type HttpRequest_OauthToken = src.HttpRequest_OauthToken 230 type HttpRequest_OidcToken = src.HttpRequest_OidcToken 231 232 // Request message for 233 // [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues]. 234 // 235 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 236 type ListQueuesRequest = src.ListQueuesRequest 237 238 // Response message for 239 // [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues]. 240 // 241 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 242 type ListQueuesResponse = src.ListQueuesResponse 243 244 // Request message for listing tasks using 245 // [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks]. 246 // 247 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 248 type ListTasksRequest = src.ListTasksRequest 249 250 // Response message for listing tasks using 251 // [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks]. 252 // 253 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 254 type ListTasksResponse = src.ListTasksResponse 255 256 // Contains information needed for generating an [OAuth 257 // token](https://developers.google.com/identity/protocols/OAuth2). This type 258 // of authorization should generally only be used when calling Google APIs 259 // hosted on *.googleapis.com. 260 // 261 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 262 type OAuthToken = src.OAuthToken 263 264 // Contains information needed for generating an [OpenID Connect 265 // token](https://developers.google.com/identity/protocols/OpenIDConnect). This 266 // type of authorization can be used for many scenarios, including calling 267 // Cloud Run, or endpoints where you intend to validate the token yourself. 268 // 269 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 270 type OidcToken = src.OidcToken 271 272 // Request message for 273 // [PauseQueue][google.cloud.tasks.v2beta3.CloudTasks.PauseQueue]. 274 // 275 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 276 type PauseQueueRequest = src.PauseQueueRequest 277 278 // Pull Message. This proto can only be used for tasks in a queue which has 279 // [PULL][google.cloud.tasks.v2beta3.Queue.type] type. It currently exists for 280 // backwards compatibility with the App Engine Task Queue SDK. This message 281 // type maybe returned with methods 282 // [list][google.cloud.tasks.v2beta3.CloudTask.ListTasks] and 283 // [get][google.cloud.tasks.v2beta3.CloudTask.ListTasks], when the response 284 // view is [FULL][google.cloud.tasks.v2beta3.Task.View.Full]. 285 // 286 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 287 type PullMessage = src.PullMessage 288 289 // Request message for 290 // [PurgeQueue][google.cloud.tasks.v2beta3.CloudTasks.PurgeQueue]. 291 // 292 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 293 type PurgeQueueRequest = src.PurgeQueueRequest 294 295 // A queue is a container of related tasks. Queues are configured to manage 296 // how those tasks are dispatched. Configurable properties include rate limits, 297 // retry options, queue types, and others. 298 // 299 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 300 type Queue = src.Queue 301 302 // Statistics for a queue. 303 // 304 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 305 type QueueStats = src.QueueStats 306 type Queue_AppEngineHttpQueue = src.Queue_AppEngineHttpQueue 307 308 // State of the queue. 309 // 310 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 311 type Queue_State = src.Queue_State 312 313 // The type of the queue. 314 // 315 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 316 type Queue_Type = src.Queue_Type 317 318 // Rate limits. This message determines the maximum rate that tasks can be 319 // dispatched by a queue, regardless of whether the dispatch is a first task 320 // attempt or a retry. Note: The debugging command, 321 // [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask], will run a task 322 // even if the queue has reached its 323 // [RateLimits][google.cloud.tasks.v2beta3.RateLimits]. 324 // 325 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 326 type RateLimits = src.RateLimits 327 328 // Request message for 329 // [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue]. 330 // 331 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 332 type ResumeQueueRequest = src.ResumeQueueRequest 333 334 // Retry config. These settings determine when a failed task attempt is 335 // retried. 336 // 337 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 338 type RetryConfig = src.RetryConfig 339 340 // Request message for forcing a task to run now using 341 // [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask]. 342 // 343 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 344 type RunTaskRequest = src.RunTaskRequest 345 346 // Configuration options for writing logs to [Stackdriver 347 // Logging](https://cloud.google.com/logging/docs/). 348 // 349 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 350 type StackdriverLoggingConfig = src.StackdriverLoggingConfig 351 352 // A unit of scheduled work. 353 // 354 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 355 type Task = src.Task 356 type Task_AppEngineHttpRequest = src.Task_AppEngineHttpRequest 357 type Task_HttpRequest = src.Task_HttpRequest 358 type Task_PullMessage = src.Task_PullMessage 359 360 // The view specifies a subset of [Task][google.cloud.tasks.v2beta3.Task] 361 // data. When a task is returned in a response, not all information is 362 // retrieved by default because some data, such as payloads, might be desirable 363 // to return only when needed because of its large size or because of the 364 // sensitivity of data that it contains. 365 // 366 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 367 type Task_View = src.Task_View 368 369 // UnimplementedCloudTasksServer can be embedded to have forward compatible 370 // implementations. 371 // 372 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 373 type UnimplementedCloudTasksServer = src.UnimplementedCloudTasksServer 374 375 // Request message for 376 // [UpdateQueue][google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue]. 377 // 378 // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 379 type UpdateQueueRequest = src.UpdateQueueRequest 380 381 // Deprecated: Please use funcs in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 382 func NewCloudTasksClient(cc grpc.ClientConnInterface) CloudTasksClient { 383 return src.NewCloudTasksClient(cc) 384 } 385 386 // Deprecated: Please use funcs in: cloud.google.com/go/cloudtasks/apiv2beta3/cloudtaskspb 387 func RegisterCloudTasksServer(s *grpc.Server, srv CloudTasksServer) { 388 src.RegisterCloudTasksServer(s, srv) 389 } 390