...

Source file src/google.golang.org/genproto/googleapis/cloud/tasks/v2beta2/alias.go

Documentation: google.golang.org/genproto/googleapis/cloud/tasks/v2beta2

     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/apiv2beta2/cloudtaskspb".
    19  //
    20  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/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/apiv2beta2/cloudtaskspb"
    27  	grpc "google.golang.org/grpc"
    28  )
    29  
    30  // Deprecated: Please use consts in: cloud.google.com/go/cloudtasks/apiv2beta2/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_POST                    = src.HttpMethod_POST
    37  	HttpMethod_PUT                     = src.HttpMethod_PUT
    38  	Queue_DISABLED                     = src.Queue_DISABLED
    39  	Queue_PAUSED                       = src.Queue_PAUSED
    40  	Queue_RUNNING                      = src.Queue_RUNNING
    41  	Queue_STATE_UNSPECIFIED            = src.Queue_STATE_UNSPECIFIED
    42  	Task_BASIC                         = src.Task_BASIC
    43  	Task_FULL                          = src.Task_FULL
    44  	Task_VIEW_UNSPECIFIED              = src.Task_VIEW_UNSPECIFIED
    45  )
    46  
    47  // Deprecated: Please use vars in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
    48  var (
    49  	File_google_cloud_tasks_v2beta2_cloudtasks_proto = src.File_google_cloud_tasks_v2beta2_cloudtasks_proto
    50  	File_google_cloud_tasks_v2beta2_queue_proto      = src.File_google_cloud_tasks_v2beta2_queue_proto
    51  	File_google_cloud_tasks_v2beta2_target_proto     = src.File_google_cloud_tasks_v2beta2_target_proto
    52  	File_google_cloud_tasks_v2beta2_task_proto       = src.File_google_cloud_tasks_v2beta2_task_proto
    53  	HttpMethod_name                                  = src.HttpMethod_name
    54  	HttpMethod_value                                 = src.HttpMethod_value
    55  	Queue_State_name                                 = src.Queue_State_name
    56  	Queue_State_value                                = src.Queue_State_value
    57  	Task_View_name                                   = src.Task_View_name
    58  	Task_View_value                                  = src.Task_View_value
    59  )
    60  
    61  // Request message for acknowledging a task using
    62  // [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask].
    63  //
    64  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
    65  type AcknowledgeTaskRequest = src.AcknowledgeTaskRequest
    66  
    67  // App Engine HTTP request. The message defines the HTTP request that is sent
    68  // to an App Engine app when the task is dispatched. This proto can only be
    69  // used for tasks in a queue which has
    70  // [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target]
    71  // set. Using
    72  // [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest]
    73  // requires
    74  // [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
    75  // Google IAM permission for the project and the following scope:
    76  // `https://www.googleapis.com/auth/cloud-platform` The task will be delivered
    77  // to the App Engine app which belongs to the same project as the queue. For
    78  // more information, see [How Requests are
    79  // Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
    80  // and how routing is affected by [dispatch
    81  // files](https://cloud.google.com/appengine/docs/python/config/dispatchref).
    82  // Traffic is encrypted during transport and never leaves Google datacenters.
    83  // Because this traffic is carried over a communication mechanism internal to
    84  // Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS).
    85  // The request to the handler, however, will appear to have used the HTTP
    86  // protocol. The
    87  // [AppEngineRouting][google.cloud.tasks.v2beta2.AppEngineRouting] used to
    88  // construct the URL that the task is delivered to can be set at the
    89  // queue-level or task-level: - If set,
    90  // [app_engine_routing_override][google.cloud.tasks.v2beta2.AppEngineHttpTarget.app_engine_routing_override]
    91  // is used for all tasks in the queue, no matter what the setting is for the
    92  // [task-level
    93  // app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
    94  // The `url` that the task will be sent to is: - `url =`
    95  // [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] `+`
    96  // [relative_url][google.cloud.tasks.v2beta2.AppEngineHttpRequest.relative_url]
    97  // Tasks can be dispatched to secure app handlers, unsecure app handlers, and
    98  // URIs restricted with [`login:
    99  // admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref).
   100  // Because tasks are not run as any user, they cannot be dispatched to URIs
   101  // restricted with [`login:
   102  // required`](https://cloud.google.com/appengine/docs/standard/python/config/appref)
   103  // Task dispatches also do not follow redirects. The task attempt has succeeded
   104  // if the app's request handler returns an HTTP response code in the range
   105  // [`200` - `299`]. The task attempt has failed if the app's handler returns a
   106  // non-2xx response code or Cloud Tasks does not receive response before the
   107  // [deadline][Task.dispatch_deadline]. Failed tasks will be retried according
   108  // to the [retry configuration][google.cloud.tasks.v2beta2.Queue.retry_config].
   109  // `503` (Service Unavailable) is considered an App Engine system error instead
   110  // of an application error and will cause Cloud Tasks' traffic congestion
   111  // control to temporarily throttle the queue's dispatches. Unlike other types
   112  // of task targets, a `429` (Too Many Requests) response from an app handler
   113  // does not cause traffic congestion control to throttle the queue.
   114  //
   115  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   116  type AppEngineHttpRequest = src.AppEngineHttpRequest
   117  
   118  // App Engine HTTP target. The task will be delivered to the App Engine
   119  // application hostname specified by its
   120  // [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget] and
   121  // [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest]. The
   122  // documentation for
   123  // [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest]
   124  // explains how the task's host URL is constructed. Using
   125  // [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget]
   126  // requires
   127  // [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
   128  // Google IAM permission for the project and the following scope:
   129  // `https://www.googleapis.com/auth/cloud-platform`
   130  //
   131  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   132  type AppEngineHttpTarget = src.AppEngineHttpTarget
   133  
   134  // App Engine Routing. Defines routing characteristics specific to App Engine
   135  // - service, version, and instance. For more information about services,
   136  // versions, and instances see [An Overview of App
   137  // Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
   138  // [Microservices Architecture on Google App
   139  // Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
   140  // [App Engine Standard request
   141  // routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
   142  // and [App Engine Flex request
   143  // routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
   144  //
   145  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   146  type AppEngineRouting = src.AppEngineRouting
   147  
   148  // The status of a task attempt.
   149  //
   150  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   151  type AttemptStatus = src.AttemptStatus
   152  
   153  // Request message for canceling a lease using
   154  // [CancelLease][google.cloud.tasks.v2beta2.CloudTasks.CancelLease].
   155  //
   156  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   157  type CancelLeaseRequest = src.CancelLeaseRequest
   158  
   159  // CloudTasksClient is the client API for CloudTasks service. For semantics
   160  // around ctx use and closing/ending streaming RPCs, please refer to
   161  // https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
   162  //
   163  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   164  type CloudTasksClient = src.CloudTasksClient
   165  
   166  // CloudTasksServer is the server API for CloudTasks service.
   167  //
   168  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   169  type CloudTasksServer = src.CloudTasksServer
   170  
   171  // Request message for
   172  // [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue].
   173  //
   174  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   175  type CreateQueueRequest = src.CreateQueueRequest
   176  
   177  // Request message for
   178  // [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].
   179  //
   180  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   181  type CreateTaskRequest = src.CreateTaskRequest
   182  
   183  // Request message for
   184  // [DeleteQueue][google.cloud.tasks.v2beta2.CloudTasks.DeleteQueue].
   185  //
   186  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   187  type DeleteQueueRequest = src.DeleteQueueRequest
   188  
   189  // Request message for deleting a task using
   190  // [DeleteTask][google.cloud.tasks.v2beta2.CloudTasks.DeleteTask].
   191  //
   192  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   193  type DeleteTaskRequest = src.DeleteTaskRequest
   194  
   195  // Request message for
   196  // [GetQueue][google.cloud.tasks.v2beta2.CloudTasks.GetQueue].
   197  //
   198  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   199  type GetQueueRequest = src.GetQueueRequest
   200  
   201  // Request message for getting a task using
   202  // [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask].
   203  //
   204  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   205  type GetTaskRequest = src.GetTaskRequest
   206  
   207  // The HTTP method used to execute the task.
   208  //
   209  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   210  type HttpMethod = src.HttpMethod
   211  
   212  // Request message for leasing tasks using
   213  // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
   214  //
   215  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   216  type LeaseTasksRequest = src.LeaseTasksRequest
   217  
   218  // Response message for leasing tasks using
   219  // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
   220  //
   221  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   222  type LeaseTasksResponse = src.LeaseTasksResponse
   223  
   224  // Request message for
   225  // [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues].
   226  //
   227  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   228  type ListQueuesRequest = src.ListQueuesRequest
   229  
   230  // Response message for
   231  // [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues].
   232  //
   233  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   234  type ListQueuesResponse = src.ListQueuesResponse
   235  
   236  // Request message for listing tasks using
   237  // [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].
   238  //
   239  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   240  type ListTasksRequest = src.ListTasksRequest
   241  
   242  // Response message for listing tasks using
   243  // [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].
   244  //
   245  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   246  type ListTasksResponse = src.ListTasksResponse
   247  
   248  // Request message for
   249  // [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue].
   250  //
   251  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   252  type PauseQueueRequest = src.PauseQueueRequest
   253  
   254  // The pull message contains data that can be used by the caller of
   255  // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process
   256  // the task. This proto can only be used for tasks in a queue which has
   257  // [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] set.
   258  //
   259  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   260  type PullMessage = src.PullMessage
   261  
   262  // Pull target.
   263  //
   264  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   265  type PullTarget = src.PullTarget
   266  
   267  // Request message for
   268  // [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue].
   269  //
   270  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   271  type PurgeQueueRequest = src.PurgeQueueRequest
   272  
   273  // A queue is a container of related tasks. Queues are configured to manage
   274  // how those tasks are dispatched. Configurable properties include rate limits,
   275  // retry options, target types, and others.
   276  //
   277  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   278  type Queue = src.Queue
   279  
   280  // Statistics for a queue.
   281  //
   282  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   283  type QueueStats = src.QueueStats
   284  type Queue_AppEngineHttpTarget = src.Queue_AppEngineHttpTarget
   285  type Queue_PullTarget = src.Queue_PullTarget
   286  
   287  // State of the queue.
   288  //
   289  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   290  type Queue_State = src.Queue_State
   291  
   292  // Rate limits. This message determines the maximum rate that tasks can be
   293  // dispatched by a queue, regardless of whether the dispatch is a first task
   294  // attempt or a retry. Note: The debugging command,
   295  // [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask], will run a task
   296  // even if the queue has reached its
   297  // [RateLimits][google.cloud.tasks.v2beta2.RateLimits].
   298  //
   299  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   300  type RateLimits = src.RateLimits
   301  
   302  // Request message for renewing a lease using
   303  // [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease].
   304  //
   305  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   306  type RenewLeaseRequest = src.RenewLeaseRequest
   307  
   308  // Request message for
   309  // [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue].
   310  //
   311  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   312  type ResumeQueueRequest = src.ResumeQueueRequest
   313  
   314  // Retry config. These settings determine how a failed task attempt is
   315  // retried.
   316  //
   317  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   318  type RetryConfig = src.RetryConfig
   319  type RetryConfig_MaxAttempts = src.RetryConfig_MaxAttempts
   320  type RetryConfig_UnlimitedAttempts = src.RetryConfig_UnlimitedAttempts
   321  
   322  // Request message for forcing a task to run now using
   323  // [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask].
   324  //
   325  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   326  type RunTaskRequest = src.RunTaskRequest
   327  
   328  // A unit of scheduled work.
   329  //
   330  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   331  type Task = src.Task
   332  
   333  // Status of the task.
   334  //
   335  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   336  type TaskStatus = src.TaskStatus
   337  type Task_AppEngineHttpRequest = src.Task_AppEngineHttpRequest
   338  type Task_PullMessage = src.Task_PullMessage
   339  
   340  // The view specifies a subset of [Task][google.cloud.tasks.v2beta2.Task]
   341  // data. When a task is returned in a response, not all information is
   342  // retrieved by default because some data, such as payloads, might be desirable
   343  // to return only when needed because of its large size or because of the
   344  // sensitivity of data that it contains.
   345  //
   346  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   347  type Task_View = src.Task_View
   348  
   349  // UnimplementedCloudTasksServer can be embedded to have forward compatible
   350  // implementations.
   351  //
   352  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   353  type UnimplementedCloudTasksServer = src.UnimplementedCloudTasksServer
   354  
   355  // Request message for
   356  // [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue].
   357  //
   358  // Deprecated: Please use types in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   359  type UpdateQueueRequest = src.UpdateQueueRequest
   360  
   361  // Deprecated: Please use funcs in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   362  func NewCloudTasksClient(cc grpc.ClientConnInterface) CloudTasksClient {
   363  	return src.NewCloudTasksClient(cc)
   364  }
   365  
   366  // Deprecated: Please use funcs in: cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb
   367  func RegisterCloudTasksServer(s *grpc.Server, srv CloudTasksServer) {
   368  	src.RegisterCloudTasksServer(s, srv)
   369  }
   370  

View as plain text