google-cloud-tasks-v2 0.1.0

data/proto_docs/google/cloud/tasks/v2/cloudtasks.rb

@@ -0,0 +1,361 @@
+# 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 V2
+        # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The location name.
+        #     For example: `projects/PROJECT_ID/locations/LOCATION_ID`
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     `filter` can be used to specify a subset of queues. Any {::Google::Cloud::Tasks::V2::Queue Queue}
+        #     field can be used as a filter and several operators as supported.
+        #     For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
+        #     described in
+        #     [Stackdriver's Advanced Logs
+        #     Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
+        #
+        #     Sample filter "state: PAUSED".
+        #
+        #     Note that using filters might cause fewer queues than the
+        #     requested page_size to be returned.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Requested page size.
+        #
+        #     The maximum page size is 9800. If unspecified, the page size will
+        #     be the maximum. Fewer queues than requested might be returned,
+        #     even if more queues exist; use the
+        #     {::Google::Cloud::Tasks::V2::ListQueuesResponse#next_page_token next_page_token} in the
+        #     response to determine if more queues exist.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A token identifying the page of results to return.
+        #
+        #     To request the first page results, page_token must be empty. To
+        #     request the next page of results, page_token must be the value of
+        #     {::Google::Cloud::Tasks::V2::ListQueuesResponse#next_page_token next_page_token} returned
+        #     from the previous call to {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues}
+        #     method. It is an error to switch the value of the
+        #     {::Google::Cloud::Tasks::V2::ListQueuesRequest#filter filter} while iterating through pages.
+        class ListQueuesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues}.
+        # @!attribute [rw] queues
+        #   @return [::Array<::Google::Cloud::Tasks::V2::Queue>]
+        #     The list of queues.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve next page of results.
+        #
+        #     To return the next page of results, call
+        #     {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues} with this value as the
+        #     {::Google::Cloud::Tasks::V2::ListQueuesRequest#page_token page_token}.
+        #
+        #     If the next_page_token is empty, there are no more results.
+        #
+        #     The page token is valid for only 2 hours.
+        class ListQueuesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#get_queue GetQueue}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the queue. For example:
+        #     `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+        class GetQueueRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_queue CreateQueue}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The location name in which the queue will be created.
+        #     For example: `projects/PROJECT_ID/locations/LOCATION_ID`
+        #
+        #     The list of allowed locations can be obtained by calling Cloud
+        #     Tasks' implementation of
+        #     [ListLocations][google.cloud.location.Locations.ListLocations].
+        # @!attribute [rw] queue
+        #   @return [::Google::Cloud::Tasks::V2::Queue]
+        #     Required. The queue to create.
+        #
+        #     [Queue's name][google.cloud.tasks.v2.Queue.name] cannot be the same as an existing queue.
+        class CreateQueueRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#update_queue UpdateQueue}.
+        # @!attribute [rw] queue
+        #   @return [::Google::Cloud::Tasks::V2::Queue]
+        #     Required. The queue to create or update.
+        #
+        #     The queue's {::Google::Cloud::Tasks::V2::Queue#name name} must be specified.
+        #
+        #     Output only fields cannot be modified using UpdateQueue.
+        #     Any value specified for an output only field will be ignored.
+        #     The queue's {::Google::Cloud::Tasks::V2::Queue#name name} cannot be changed.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     A mask used to specify which fields of the queue are being updated.
+        #
+        #     If empty, then all fields will be updated.
+        class UpdateQueueRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#delete_queue DeleteQueue}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The queue name. For example:
+        #     `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+        class DeleteQueueRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#purge_queue PurgeQueue}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The queue name. For example:
+        #     `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
+        class PurgeQueueRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#pause_queue PauseQueue}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The queue name. For example:
+        #     `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
+        class PauseQueueRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#resume_queue ResumeQueue}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The queue name. For example:
+        #     `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
+        class ResumeQueueRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for listing tasks using {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The queue name. For example:
+        #     `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+        # @!attribute [rw] response_view
+        #   @return [::Google::Cloud::Tasks::V2::Task::View]
+        #     The response_view specifies which subset of the {::Google::Cloud::Tasks::V2::Task Task} will be
+        #     returned.
+        #
+        #     By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC}; not all
+        #     information is retrieved by default because some data, such as
+        #     payloads, might be desirable to return only when needed because
+        #     of its large size or because of the sensitivity of data that it
+        #     contains.
+        #
+        #     Authorization for {::Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires
+        #     `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
+        #     permission on the {::Google::Cloud::Tasks::V2::Task Task} resource.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Maximum page size.
+        #
+        #     Fewer tasks than requested might be returned, even if more tasks exist; use
+        #     {::Google::Cloud::Tasks::V2::ListTasksResponse#next_page_token next_page_token} in the response to
+        #     determine if more tasks exist.
+        #
+        #     The maximum page size is 1000. If unspecified, the page size will be the
+        #     maximum.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A token identifying the page of results to return.
+        #
+        #     To request the first page results, page_token must be empty. To
+        #     request the next page of results, page_token must be the value of
+        #     {::Google::Cloud::Tasks::V2::ListTasksResponse#next_page_token next_page_token} returned
+        #     from the previous call to {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks}
+        #     method.
+        #
+        #     The page token is valid for only 2 hours.
+        class ListTasksRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for listing tasks using {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks}.
+        # @!attribute [rw] tasks
+        #   @return [::Array<::Google::Cloud::Tasks::V2::Task>]
+        #     The list of tasks.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve next page of results.
+        #
+        #     To return the next page of results, call
+        #     {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks} with this value as the
+        #     {::Google::Cloud::Tasks::V2::ListTasksRequest#page_token page_token}.
+        #
+        #     If the next_page_token is empty, there are no more results.
+        class ListTasksResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for getting a task using {::Google::Cloud::Tasks::V2::CloudTasks::Client#get_task GetTask}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The task name. For example:
+        #     `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
+        # @!attribute [rw] response_view
+        #   @return [::Google::Cloud::Tasks::V2::Task::View]
+        #     The response_view specifies which subset of the {::Google::Cloud::Tasks::V2::Task Task} will be
+        #     returned.
+        #
+        #     By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC}; not all
+        #     information is retrieved by default because some data, such as
+        #     payloads, might be desirable to return only when needed because
+        #     of its large size or because of the sensitivity of data that it
+        #     contains.
+        #
+        #     Authorization for {::Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires
+        #     `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
+        #     permission on the {::Google::Cloud::Tasks::V2::Task Task} resource.
+        class GetTaskRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_task CreateTask}.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The queue name. For example:
+        #     `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+        #
+        #     The queue must already exist.
+        # @!attribute [rw] task
+        #   @return [::Google::Cloud::Tasks::V2::Task]
+        #     Required. The task to add.
+        #
+        #     Task names have the following format:
+        #     `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
+        #     The user can optionally specify a task {::Google::Cloud::Tasks::V2::Task#name name}. If a
+        #     name is not specified then the system will generate a random
+        #     unique task id, which will be set in the task returned in the
+        #     {::Google::Cloud::Tasks::V2::Task#name response}.
+        #
+        #     If {::Google::Cloud::Tasks::V2::Task#schedule_time schedule_time} is not set or is in the
+        #     past then Cloud Tasks will set it to the current time.
+        #
+        #     Task De-duplication:
+        #
+        #     Explicitly specifying a task ID enables task de-duplication.  If
+        #     a task's ID is identical to that of an existing task or a task
+        #     that was deleted or executed recently then the call will fail
+        #     with [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS].
+        #     If the task's queue was created using Cloud Tasks, then another task with
+        #     the same name can't be created for ~1hour after the original task was
+        #     deleted or executed. If the task's queue was created using queue.yaml or
+        #     queue.xml, then another task with the same name can't be created
+        #     for ~9days after the original task was deleted or executed.
+        #
+        #     Because there is an extra lookup cost to identify duplicate task
+        #     names, these {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_task CreateTask} calls have significantly
+        #     increased latency. Using hashed strings for the task id or for
+        #     the prefix of the task id is recommended. Choosing task ids that
+        #     are sequential or have sequential prefixes, for example using a
+        #     timestamp, causes an increase in latency and error rates in all
+        #     task commands. The infrastructure relies on an approximately
+        #     uniform distribution of task ids to store and serve tasks
+        #     efficiently.
+        # @!attribute [rw] response_view
+        #   @return [::Google::Cloud::Tasks::V2::Task::View]
+        #     The response_view specifies which subset of the {::Google::Cloud::Tasks::V2::Task Task} will be
+        #     returned.
+        #
+        #     By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC}; not all
+        #     information is retrieved by default because some data, such as
+        #     payloads, might be desirable to return only when needed because
+        #     of its large size or because of the sensitivity of data that it
+        #     contains.
+        #
+        #     Authorization for {::Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires
+        #     `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
+        #     permission on the {::Google::Cloud::Tasks::V2::Task Task} resource.
+        class CreateTaskRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for deleting a task using
+        # {::Google::Cloud::Tasks::V2::CloudTasks::Client#delete_task DeleteTask}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The task name. For example:
+        #     `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
+        class DeleteTaskRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for forcing a task to run now using
+        # {::Google::Cloud::Tasks::V2::CloudTasks::Client#run_task RunTask}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The task name. For example:
+        #     `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
+        # @!attribute [rw] response_view
+        #   @return [::Google::Cloud::Tasks::V2::Task::View]
+        #     The response_view specifies which subset of the {::Google::Cloud::Tasks::V2::Task Task} will be
+        #     returned.
+        #
+        #     By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC}; not all
+        #     information is retrieved by default because some data, such as
+        #     payloads, might be desirable to return only when needed because
+        #     of its large size or because of the sensitivity of data that it
+        #     contains.
+        #
+        #     Authorization for {::Google::Cloud::Tasks::V2::Task::View::FULL FULL} requires
+        #     `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
+        #     permission on the {::Google::Cloud::Tasks::V2::Task Task} resource.
+        class RunTaskRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,364 @@
+# 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 V2
+        # A queue is a container of related tasks. Queues are configured to manage
+        # how those tasks are dispatched. Configurable properties include rate limits,
+        # retry options, queue types, and others.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Caller-specified and required in {::Google::Cloud::Tasks::V2::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_routing_override
+        #   @return [::Google::Cloud::Tasks::V2::AppEngineRouting]
+        #     Overrides for
+        #     {::Google::Cloud::Tasks::V2::AppEngineHttpRequest#app_engine_routing task-level app_engine_routing}.
+        #     These settings apply only to
+        #     {::Google::Cloud::Tasks::V2::AppEngineHttpRequest App Engine tasks} in this queue.
+        #     {::Google::Cloud::Tasks::V2::HttpRequest Http tasks} are not affected.
+        #
+        #     If set, `app_engine_routing_override` is used for all
+        #     {::Google::Cloud::Tasks::V2::AppEngineHttpRequest App Engine tasks} in the queue, no matter what the
+        #     setting is for the
+        #     {::Google::Cloud::Tasks::V2::AppEngineHttpRequest#app_engine_routing task-level app_engine_routing}.
+        # @!attribute [rw] rate_limits
+        #   @return [::Google::Cloud::Tasks::V2::RateLimits]
+        #     Rate limits for task dispatches.
+        #
+        #     {::Google::Cloud::Tasks::V2::Queue#rate_limits rate_limits} and {::Google::Cloud::Tasks::V2::Queue#retry_config retry_config} are
+        #     related because they both control task attempts. However they control task
+        #     attempts in different ways:
+        #
+        #     * {::Google::Cloud::Tasks::V2::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::V2::Queue#retry_config retry_config} controls what happens to
+        #       particular a task after its first attempt fails. That is,
+        #       {::Google::Cloud::Tasks::V2::Queue#retry_config retry_config} controls task retries (the
+        #       second attempt, third attempt, etc).
+        #
+        #     The queue's actual dispatch rate is the result of:
+        #
+        #     * Number of tasks in the queue
+        #     * User-specified throttling: {::Google::Cloud::Tasks::V2::Queue#rate_limits rate_limits},
+        #       {::Google::Cloud::Tasks::V2::Queue#retry_config retry_config}, and the
+        #       [queue's state][google.cloud.tasks.v2.Queue.state].
+        #     * System throttling due to `429` (Too Many Requests) or `503` (Service
+        #       Unavailable) responses from the worker, high error rates, or to smooth
+        #       sudden large traffic spikes.
+        # @!attribute [rw] retry_config
+        #   @return [::Google::Cloud::Tasks::V2::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::V2::Queue::State]
+        #     Output only. The state of the queue.
+        #
+        #     `state` can only be changed by called
+        #     {::Google::Cloud::Tasks::V2::CloudTasks::Client#pause_queue PauseQueue},
+        #     {::Google::Cloud::Tasks::V2::CloudTasks::Client#resume_queue ResumeQueue}, or uploading
+        #     [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
+        #     {::Google::Cloud::Tasks::V2::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::V2::Task#create_time created} before this time
+        #     were purged.
+        #
+        #     A queue can be purged using {::Google::Cloud::Tasks::V2::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.
+        # @!attribute [rw] stackdriver_logging_config
+        #   @return [::Google::Cloud::Tasks::V2::StackdriverLoggingConfig]
+        #     Configuration options for writing logs to
+        #     [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
+        #     field is unset, then no logs are written.
+        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.
+            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.
+            #
+            # To permanently delete this queue and all of its tasks, call
+            # {::Google::Cloud::Tasks::V2::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::V2::CloudTasks::Client#run_task RunTask}, will run a task
+        # even if the queue has reached its {::Google::Cloud::Tasks::V2::RateLimits RateLimits}.
+        # @!attribute [rw] max_dispatches_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.
+        #
+        #     * The maximum allowed value is 500.
+        #
+        #
+        #     This field has the same meaning as
+        #     [rate in
+        #     queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/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::V2::RateLimits#max_dispatches_per_second max_dispatches_per_second}.
+        #
+        #     Cloud Tasks will pick the value of `max_burst_size` based on the
+        #     value of
+        #     {::Google::Cloud::Tasks::V2::RateLimits#max_dispatches_per_second max_dispatches_per_second}.
+        #
+        #     For queues that were created or updated using
+        #     `queue.yaml/xml`, `max_burst_size` is equal to
+        #     [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
+        #     Since `max_burst_size` is output only, if
+        #     {::Google::Cloud::Tasks::V2::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::V2::RateLimits#max_dispatches_per_second max_dispatches_per_second},
+        #     regardless of whether
+        #     {::Google::Cloud::Tasks::V2::RateLimits#max_dispatches_per_second max_dispatches_per_second}
+        #     is updated.
+        # @!attribute [rw] max_concurrent_dispatches
+        #   @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 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 when a failed task attempt is retried.
+        # @!attribute [rw] max_attempts
+        #   @return [::Integer]
+        #     Number of attempts per task.
+        #
+        #     Cloud Tasks will attempt the task `max_attempts` times (that is, if the
+        #     first attempt fails, then there will be `max_attempts - 1` retries). Must
+        #     be >= -1.
+        #
+        #     If unspecified when the queue is created, Cloud Tasks will pick the
+        #     default.
+        #
+        #     -1 indicates unlimited attempts.
+        #
+        #     This field has the same meaning as
+        #     [task_retry_limit in
+        #     queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+        # @!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::V2::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.
+        #
+        #
+        #     `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::V2::Task#schedule_time scheduled} for retry between
+        #     {::Google::Cloud::Tasks::V2::RetryConfig#min_backoff min_backoff} and
+        #     {::Google::Cloud::Tasks::V2::RetryConfig#max_backoff max_backoff} duration after it fails,
+        #     if the queue's {::Google::Cloud::Tasks::V2::RetryConfig RetryConfig} specifies that the task should be
+        #     retried.
+        #
+        #     If unspecified when the queue is created, Cloud Tasks will pick the
+        #     default.
+        #
+        #
+        #     `min_backoff` will be truncated to the nearest second.
+        #
+        #     This field has the same meaning as
+        #     [min_backoff_seconds in
+        #     queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
+        # @!attribute [rw] max_backoff
+        #   @return [::Google::Protobuf::Duration]
+        #     A task will be {::Google::Cloud::Tasks::V2::Task#schedule_time scheduled} for retry between
+        #     {::Google::Cloud::Tasks::V2::RetryConfig#min_backoff min_backoff} and
+        #     {::Google::Cloud::Tasks::V2::RetryConfig#max_backoff max_backoff} duration after it fails,
+        #     if the queue's {::Google::Cloud::Tasks::V2::RetryConfig RetryConfig} specifies that the task should be
+        #     retried.
+        #
+        #     If unspecified when the queue is created, Cloud Tasks will pick the
+        #     default.
+        #
+        #
+        #     `max_backoff` will be truncated to the nearest second.
+        #
+        #     This field has the same meaning as
+        #     [max_backoff_seconds in
+        #     queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/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::V2::RetryConfig#min_backoff min_backoff}, then doubles
+        #     `max_doublings` times, then increases linearly, and finally
+        #     retries retries at intervals of
+        #     {::Google::Cloud::Tasks::V2::RetryConfig#max_backoff max_backoff} up to
+        #     {::Google::Cloud::Tasks::V2::RetryConfig#max_attempts max_attempts} times.
+        #
+        #     For example, if {::Google::Cloud::Tasks::V2::RetryConfig#min_backoff min_backoff} is 10s,
+        #     {::Google::Cloud::Tasks::V2::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::V2::RetryConfig#max_backoff max_backoff} until the
+        #     task has been attempted {::Google::Cloud::Tasks::V2::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 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
+
+        # Configuration options for writing logs to
+        # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+        # @!attribute [rw] sampling_ratio
+        #   @return [::Float]
+        #     Specifies the fraction of operations to write to
+        #     [Stackdriver Logging](https://cloud.google.com/logging/docs/).
+        #     This field may contain any value between 0.0 and 1.0, inclusive.
+        #     0.0 is the default and means that no operations are logged.
+        class StackdriverLoggingConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end