google-cloud-tasks-v2beta2 0.1.0

data/proto_docs/google/cloud/tasks/v2beta2/queue.rb

@@ -0,0 +1,349 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Tasks
+      module V2beta2
+        # 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, target types, and others.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Caller-specified and required in {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#create_queue CreateQueue},
+        #     after which it becomes output only.
+        #
+        #     The queue name.
+        #
+        #     The queue name must have the following format:
+        #     `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+        #
+        #     * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
+        #        hyphens (-), colons (:), or periods (.).
+        #        For more information, see
+        #        [Identifying
+        #        projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
+        #     * `LOCATION_ID` is the canonical ID for the queue's location.
+        #        The list of available locations can be obtained by calling
+        #        [ListLocations][google.cloud.location.Locations.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.
+        # @!attribute [rw] app_engine_http_target
+        #   @return [::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget]
+        #     App Engine HTTP target.
+        #
+        #     An App Engine queue is a queue that has an {::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget AppEngineHttpTarget}.
+        # @!attribute [rw] pull_target
+        #   @return [::Google::Cloud::Tasks::V2beta2::PullTarget]
+        #     Pull target.
+        #
+        #     A pull queue is a queue that has a {::Google::Cloud::Tasks::V2beta2::PullTarget PullTarget}.
+        # @!attribute [rw] rate_limits
+        #   @return [::Google::Cloud::Tasks::V2beta2::RateLimits]
+        #     Rate limits for task dispatches.
+        #
+        #     {::Google::Cloud::Tasks::V2beta2::Queue#rate_limits rate_limits} and
+        #     {::Google::Cloud::Tasks::V2beta2::Queue#retry_config retry_config} are related because they both
+        #     control task attempts however they control how tasks are
+        #     attempted in different ways:
+        #
+        #     * {::Google::Cloud::Tasks::V2beta2::Queue#rate_limits 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).
+        #     * {::Google::Cloud::Tasks::V2beta2::Queue#retry_config retry_config} controls what happens to
+        #       particular a task after its first attempt fails. That is,
+        #       {::Google::Cloud::Tasks::V2beta2::Queue#retry_config retry_config} controls task retries (the
+        #       second attempt, third attempt, etc).
+        # @!attribute [rw] retry_config
+        #   @return [::Google::Cloud::Tasks::V2beta2::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).
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::Tasks::V2beta2::Queue::State]
+        #     Output only. The state of the queue.
+        #
+        #     `state` can only be changed by called
+        #     {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#pause_queue PauseQueue},
+        #     {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#resume_queue ResumeQueue}, or uploading
+        #     [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+        #     {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#update_queue UpdateQueue} cannot be used to change `state`.
+        # @!attribute [rw] purge_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The last time this queue was purged.
+        #
+        #     All tasks that were {::Google::Cloud::Tasks::V2beta2::Task#create_time created} before this time
+        #     were purged.
+        #
+        #     A queue can be purged using {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#purge_queue PurgeQueue}, the
+        #     [App Engine Task Queue SDK, or the Cloud
+        #     Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
+        #
+        #     Purge time will be truncated to the nearest microsecond. Purge
+        #     time will be unset if the queue has never been purged.
+        class Queue
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # State of the queue.
+          module State
+            # Unspecified state.
+            STATE_UNSPECIFIED = 0
+
+            # 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][google.rpc.Code.NOT_FOUND] and
+            # tasks may not be dispatched for a few minutes until the queue
+            # has been re-activated.
+            RUNNING = 1
+
+            # Tasks are paused by the user. If the queue is paused then Cloud
+            # Tasks will stop delivering tasks from it, but more tasks can
+            # still be added to it by the user. When a pull queue is paused,
+            # all {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls will return a
+            # [FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION].
+            PAUSED = 2
+
+            # The queue is disabled.
+            #
+            # A queue becomes `DISABLED` when
+            # [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref)
+            # or
+            # [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/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 and
+            # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} calls return a
+            # `FAILED_PRECONDITION` error.
+            #
+            # To permanently delete this queue and all of its tasks, call
+            # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#delete_queue DeleteQueue}.
+            DISABLED = 3
+          end
+        end
+
+        # 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, {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#run_task RunTask}, will run a task
+        # even if the queue has reached its {::Google::Cloud::Tasks::V2beta2::RateLimits RateLimits}.
+        # @!attribute [rw] max_tasks_dispatched_per_second
+        #   @return [::Float]
+        #     The maximum rate at which tasks are dispatched from this queue.
+        #
+        #     If unspecified when the queue is created, Cloud Tasks will pick the
+        #     default.
+        #
+        #     * For {::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget App Engine queues}, the maximum allowed value
+        #       is 500.
+        #     * This field is output only   for {::Google::Cloud::Tasks::V2beta2::PullTarget pull queues}. In addition to the
+        #       `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
+        #       {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} requests are allowed per pull queue.
+        #
+        #
+        #     This field has the same meaning as
+        #     [rate in
+        #     queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
+        # @!attribute [rw] max_burst_size
+        #   @return [::Integer]
+        #     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
+        #     {::Google::Cloud::Tasks::V2beta2::RateLimits#max_tasks_dispatched_per_second max_tasks_dispatched_per_second}.
+        #
+        #     Cloud Tasks will pick the value of `max_burst_size` based on the
+        #     value of
+        #     {::Google::Cloud::Tasks::V2beta2::RateLimits#max_tasks_dispatched_per_second max_tasks_dispatched_per_second}.
+        #
+        #     For App Engine queues that were created or updated using
+        #     `queue.yaml/xml`, `max_burst_size` is equal to
+        #     [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+        #     Since `max_burst_size` is output only, if
+        #     {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#update_queue UpdateQueue} is called on a queue
+        #     created by `queue.yaml/xml`, `max_burst_size` will be reset based
+        #     on the value of
+        #     {::Google::Cloud::Tasks::V2beta2::RateLimits#max_tasks_dispatched_per_second max_tasks_dispatched_per_second},
+        #     regardless of whether
+        #     {::Google::Cloud::Tasks::V2beta2::RateLimits#max_tasks_dispatched_per_second max_tasks_dispatched_per_second}
+        #     is updated.
+        # @!attribute [rw] max_concurrent_tasks
+        #   @return [::Integer]
+        #     The maximum number of concurrent tasks that Cloud Tasks allows
+        #     to be dispatched for this queue. After this threshold has been
+        #     reached, Cloud Tasks stops dispatching tasks until the number of
+        #     concurrent requests decreases.
+        #
+        #     If unspecified when the queue is created, Cloud Tasks will pick the
+        #     default.
+        #
+        #
+        #     The maximum allowed value is 5,000.
+        #
+        #     This field is output only for
+        #     {::Google::Cloud::Tasks::V2beta2::PullTarget pull queues} and always -1, which indicates no limit. No other
+        #     queue types can have `max_concurrent_tasks` set to -1.
+        #
+        #
+        #     This field has the same meaning as
+        #     [max_concurrent_requests in
+        #     queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
+        class RateLimits
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Retry config.
+        #
+        # These settings determine how a failed task attempt is retried.
+        # @!attribute [rw] max_attempts
+        #   @return [::Integer]
+        #     The maximum number of attempts for a task.
+        #
+        #     Cloud Tasks will attempt the task `max_attempts` times (that
+        #     is, if the first attempt fails, then there will be
+        #     `max_attempts - 1` retries).  Must be > 0.
+        # @!attribute [rw] unlimited_attempts
+        #   @return [::Boolean]
+        #     If true, then the number of attempts is unlimited.
+        # @!attribute [rw] max_retry_duration
+        #   @return [::Google::Protobuf::Duration]
+        #     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 {::Google::Cloud::Tasks::V2beta2::RetryConfig#max_attempts max_attempts}
+        #     times, no further attempts will be made and the task will be
+        #     deleted.
+        #
+        #     If zero, then the task age is unlimited.
+        #
+        #     If unspecified when the queue is created, Cloud Tasks will pick the
+        #     default.
+        #
+        #     This field is output only for {::Google::Cloud::Tasks::V2beta2::PullTarget pull queues}.
+        #
+        #
+        #     `max_retry_duration` will be truncated to the nearest second.
+        #
+        #     This field has the same meaning as
+        #     [task_age_limit in
+        #     queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+        # @!attribute [rw] min_backoff
+        #   @return [::Google::Protobuf::Duration]
+        #     A task will be {::Google::Cloud::Tasks::V2beta2::Task#schedule_time scheduled} for retry between
+        #     {::Google::Cloud::Tasks::V2beta2::RetryConfig#min_backoff min_backoff} and
+        #     {::Google::Cloud::Tasks::V2beta2::RetryConfig#max_backoff max_backoff} duration after it fails,
+        #     if the queue's {::Google::Cloud::Tasks::V2beta2::RetryConfig RetryConfig} specifies that the task should be
+        #     retried.
+        #
+        #     If unspecified when the queue is created, Cloud Tasks will pick the
+        #     default.
+        #
+        #     This field is output only for {::Google::Cloud::Tasks::V2beta2::PullTarget pull queues}.
+        #
+        #
+        #     `min_backoff` will be truncated to the nearest second.
+        #
+        #     This field has the same meaning as
+        #     [min_backoff_seconds in
+        #     queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+        # @!attribute [rw] max_backoff
+        #   @return [::Google::Protobuf::Duration]
+        #     A task will be {::Google::Cloud::Tasks::V2beta2::Task#schedule_time scheduled} for retry between
+        #     {::Google::Cloud::Tasks::V2beta2::RetryConfig#min_backoff min_backoff} and
+        #     {::Google::Cloud::Tasks::V2beta2::RetryConfig#max_backoff max_backoff} duration after it fails,
+        #     if the queue's {::Google::Cloud::Tasks::V2beta2::RetryConfig RetryConfig} specifies that the task should be
+        #     retried.
+        #
+        #     If unspecified when the queue is created, Cloud Tasks will pick the
+        #     default.
+        #
+        #     This field is output only for {::Google::Cloud::Tasks::V2beta2::PullTarget pull queues}.
+        #
+        #
+        #     `max_backoff` will be truncated to the nearest second.
+        #
+        #     This field has the same meaning as
+        #     [max_backoff_seconds in
+        #     queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+        # @!attribute [rw] max_doublings
+        #   @return [::Integer]
+        #     The time between retries will double `max_doublings` times.
+        #
+        #     A task's retry interval starts at
+        #     {::Google::Cloud::Tasks::V2beta2::RetryConfig#min_backoff min_backoff}, then doubles
+        #     `max_doublings` times, then increases linearly, and finally
+        #     retries retries at intervals of
+        #     {::Google::Cloud::Tasks::V2beta2::RetryConfig#max_backoff max_backoff} up to
+        #     {::Google::Cloud::Tasks::V2beta2::RetryConfig#max_attempts max_attempts} times.
+        #
+        #     For example, if {::Google::Cloud::Tasks::V2beta2::RetryConfig#min_backoff min_backoff} is 10s,
+        #     {::Google::Cloud::Tasks::V2beta2::RetryConfig#max_backoff 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 {::Google::Cloud::Tasks::V2beta2::RetryConfig#max_backoff max_backoff} until the
+        #     task has been attempted {::Google::Cloud::Tasks::V2beta2::RetryConfig#max_attempts max_attempts}
+        #     times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
+        #     240s, 300s, 300s, ....
+        #
+        #     If unspecified when the queue is created, Cloud Tasks will pick the
+        #     default.
+        #
+        #     This field is output only for {::Google::Cloud::Tasks::V2beta2::PullTarget pull queues}.
+        #
+        #
+        #     This field has the same meaning as
+        #     [max_doublings in
+        #     queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+        class RetryConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/tasks/v2beta2/target.rb

@@ -0,0 +1,405 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Tasks
+      module V2beta2
+        # Pull target.
+        class PullTarget
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The pull message contains data that can be used by the caller of
+        # {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks LeaseTasks} to process the task.
+        #
+        # This proto can only be used for tasks in a queue which has
+        # {::Google::Cloud::Tasks::V2beta2::Queue#pull_target pull_target} set.
+        # @!attribute [rw] payload
+        #   @return [::String]
+        #     A data payload consumed by the worker to execute the task.
+        # @!attribute [rw] tag
+        #   @return [::String]
+        #     The task's tag.
+        #
+        #     Tags allow similar tasks to be processed in a batch. If you label
+        #     tasks with a tag, your worker can
+        #     {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#lease_tasks lease tasks} with the same tag using
+        #     {::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest#filter filter}. For example, if you want to
+        #     aggregate the events associated with a specific user once a day,
+        #     you could tag tasks with the user ID.
+        #
+        #     The task's tag can only be set when the
+        #     {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#create_task task is created}.
+        #
+        #     The tag must be less than 500 characters.
+        #
+        #     SDK compatibility: Although the SDK allows tags to be either
+        #     string or
+        #     [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
+        #     only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
+        #     encoded, the tag will be empty when the task is returned by Cloud Tasks.
+        class PullMessage
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # App Engine HTTP target.
+        #
+        # The task will be delivered to the App Engine application hostname
+        # specified by its {::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget AppEngineHttpTarget} and {::Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest AppEngineHttpRequest}.
+        # The documentation for {::Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest AppEngineHttpRequest} explains how the
+        # task's host URL is constructed.
+        #
+        # Using {::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget AppEngineHttpTarget} requires
+        # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
+        # Google IAM permission for the project
+        # and the following scope:
+        #
+        # `https://www.googleapis.com/auth/cloud-platform`
+        # @!attribute [rw] app_engine_routing_override
+        #   @return [::Google::Cloud::Tasks::V2beta2::AppEngineRouting]
+        #     Overrides for the
+        #     {::Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest#app_engine_routing task-level app_engine_routing}.
+        #
+        #     If set, `app_engine_routing_override` is used for all tasks in
+        #     the queue, no matter what the setting is for the
+        #     {::Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest#app_engine_routing task-level app_engine_routing}.
+        class AppEngineHttpTarget
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # App Engine HTTP request.
+        #
+        # The message defines the HTTP request that is sent to an App Engine app when
+        # the task is dispatched.
+        #
+        # This proto can only be used for tasks in a queue which has
+        # {::Google::Cloud::Tasks::V2beta2::Queue#app_engine_http_target app_engine_http_target} set.
+        #
+        # Using {::Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest AppEngineHttpRequest} requires
+        # [`appengine.applications.get`](https://cloud.google.com/appengine/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/how-requests-are-routed)
+        # and how routing is affected by
+        # [dispatch
+        # files](https://cloud.google.com/appengine/docs/python/config/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 {::Google::Cloud::Tasks::V2beta2::AppEngineRouting AppEngineRouting} used to construct the URL that the task is
+        # delivered to can be set at the queue-level or task-level:
+        #
+        # * If set,
+        #    {::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget#app_engine_routing_override app_engine_routing_override}
+        #    is used for all tasks in the queue, no matter what the setting
+        #    is for the
+        #    {::Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest#app_engine_routing task-level app_engine_routing}.
+        #
+        #
+        # The `url` that the task will be sent to is:
+        #
+        # * `url =` {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#host host} `+`
+        #   {::Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest#relative_url relative_url}
+        #
+        # 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/standard/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][Task.dispatch_deadline]. Failed
+        # tasks will be retried according to the
+        # {::Google::Cloud::Tasks::V2beta2::Queue#retry_config 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.
+        # @!attribute [rw] http_method
+        #   @return [::Google::Cloud::Tasks::V2beta2::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 will fail
+        #     with error code 405 (Method Not Allowed). See
+        #     [Writing a push task request
+        #     handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
+        #     and the documentation for the request handlers in the language your app is
+        #     written in e.g.
+        #     [Python Request
+        #     Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
+        # @!attribute [rw] app_engine_routing
+        #   @return [::Google::Cloud::Tasks::V2beta2::AppEngineRouting]
+        #     Task-level setting for App Engine routing.
+        #
+        #     If set,
+        #     {::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget#app_engine_routing_override app_engine_routing_override}
+        #     is used for all tasks in the queue, no matter what the setting is for the
+        #     {::Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest#app_engine_routing task-level app_engine_routing}.
+        # @!attribute [rw] relative_url
+        #   @return [::String]
+        #     The relative URL.
+        #
+        #     The relative URL must begin with "/" and must be a valid HTTP relative URL.
+        #     It can contain a path and query string arguments.
+        #     If the relative URL is empty, then the root path "/" will be used.
+        #     No spaces are allowed, and the maximum length allowed is 2083 characters.
+        # @!attribute [rw] headers
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     HTTP request headers.
+        #
+        #     This map contains the header field names and values.
+        #     Headers can be set when the
+        #     {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#create_task 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 {::Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest#payload payload}, Cloud
+        #     Tasks sets the following headers:
+        #
+        #     * `Content-Type`: By default, the `Content-Type` header is set to
+        #       `"application/octet-stream"`. The default can be overridden by explicitly
+        #       setting `Content-Type` to a particular media type when the
+        #       {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#create_task task is created}.
+        #       For example, `Content-Type` can be set to `"application/json"`.
+        #     * `Content-Length`: This is computed by Cloud Tasks. This value is
+        #       output only.   It cannot be changed.
+        #
+        #     The headers below cannot be set or overridden:
+        #
+        #     * `Host`
+        #     * `X-Google-*`
+        #     * `X-AppEngine-*`
+        #
+        #     In addition, Cloud Tasks sets some headers when the task is dispatched,
+        #     such as headers containing information about the task; see
+        #     [request
+        #     headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
+        #     These headers are set only when the task is dispatched, so they are not
+        #     visible when the task is returned in a Cloud Tasks response.
+        #
+        #     Although there is no specific limit for the maximum number of headers or
+        #     the size, there is a limit on the maximum size of the {::Google::Cloud::Tasks::V2beta2::Task Task}. For more
+        #     information, see the {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#create_task CreateTask} documentation.
+        # @!attribute [rw] payload
+        #   @return [::String]
+        #     Payload.
+        #
+        #     The payload will be sent as the HTTP message body. A message
+        #     body, and thus a payload, is allowed only if the HTTP method is
+        #     POST or PUT. It is an error to set a data payload on a task with
+        #     an incompatible {::Google::Cloud::Tasks::V2beta2::HttpMethod HttpMethod}.
+        class AppEngineHttpRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class HeadersEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # 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/microservices-on-app-engine),
+        # [App Engine Standard request
+        # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
+        # and [App Engine Flex request
+        # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
+        # @!attribute [rw] service
+        #   @return [::String]
+        #     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, {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#host host} is not parsable
+        #     into {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service},
+        #     {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}, and
+        #     {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance 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
+        #     {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#host host} is not parsable, then
+        #     {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service},
+        #     {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}, and
+        #     {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} are the empty string.
+        # @!attribute [rw] version
+        #   @return [::String]
+        #     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, {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#host host} is not parsable
+        #     into {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service},
+        #     {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}, and
+        #     {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance 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
+        #     {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#host host} is not parsable, then
+        #     {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service},
+        #     {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}, and
+        #     {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} are the empty string.
+        # @!attribute [rw] instance
+        #   @return [::String]
+        #     App instance.
+        #
+        #     By default, the task is sent to an instance which is available when
+        #     the task is attempted.
+        #
+        #     Requests can only be sent to a specific instance if
+        #     [manual scaling is used in App Engine
+        #     Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
+        #     App Engine Flex does not support instances. For more information, see
+        #     [App Engine Standard request
+        #     routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
+        #     and [App Engine Flex request
+        #     routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
+        # @!attribute [rw] host
+        #   @return [::String]
+        #     Output only. The host that the task is sent to.
+        #
+        #     For more information, see
+        #     [How Requests are
+        #     Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
+        #
+        #     The host is constructed as:
+        #
+        #
+        #     * `host = [application_domain_name]`</br>
+        #       `| [service] + '.' + [application_domain_name]`</br>
+        #       `| [version] + '.' + [application_domain_name]`</br>
+        #       `| [version_dot_service]+ '.' + [application_domain_name]`</br>
+        #       `| [instance] + '.' + [application_domain_name]`</br>
+        #       `| [instance_dot_service] + '.' + [application_domain_name]`</br>
+        #       `| [instance_dot_version] + '.' + [application_domain_name]`</br>
+        #       `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
+        #
+        #     * `application_domain_name` = The domain name of the app, for
+        #       example <app-id>.appspot.com, which is associated with the
+        #       queue's project ID. Some tasks which were created using the App Engine
+        #       SDK use a custom domain name.
+        #
+        #     * `service =` {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service}
+        #
+        #     * `version =` {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}
+        #
+        #     * `version_dot_service =`
+        #       {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version} `+ '.' +`
+        #       {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service}
+        #
+        #     * `instance =` {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance}
+        #
+        #     * `instance_dot_service =`
+        #       {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} `+ '.' +`
+        #       {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service}
+        #
+        #     * `instance_dot_version =`
+        #       {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} `+ '.' +`
+        #       {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}
+        #
+        #     * `instance_dot_version_dot_service =`
+        #       {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} `+ '.' +`
+        #       {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version} `+ '.' +`
+        #       {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service}
+        #
+        #     If {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service} is empty, then the task will be sent
+        #     to the service which is the default service when the task is attempted.
+        #
+        #     If {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version} is empty, then the task will be sent
+        #     to the version which is the default version when the task is attempted.
+        #
+        #     If {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} is empty, then the task
+        #     will be sent to an instance which is available when the task is
+        #     attempted.
+        #
+        #     If {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service},
+        #     {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}, or
+        #     {::Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} is invalid, then the task
+        #     will be sent to the default version of the default service when
+        #     the task is attempted.
+        class AppEngineRouting
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The HTTP method used to execute the task.
+        module HttpMethod
+          # HTTP method unspecified
+          HTTP_METHOD_UNSPECIFIED = 0
+
+          # HTTP POST
+          POST = 1
+
+          # HTTP GET
+          GET = 2
+
+          # HTTP HEAD
+          HEAD = 3
+
+          # HTTP PUT
+          PUT = 4
+
+          # HTTP DELETE
+          DELETE = 5
+        end
+      end
+    end
+  end
+end