lib/google/cloud/tasks/v2/cloudtasks_services_pb.rb in google-cloud-tasks-v2-0.8.1 vs lib/google/cloud/tasks/v2/cloudtasks_services_pb.rb in google-cloud-tasks-v2-0.8.2
- old
+ new
@@ -1,9 +1,9 @@
# Generated by the protocol buffer compiler. DO NOT EDIT!
# Source: google/cloud/tasks/v2/cloudtasks.proto for package 'google.cloud.tasks.v2'
# Original file comments:
-# Copyright 2019 Google LLC.
+# Copyright 2023 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
#
@@ -13,11 +13,10 @@
# 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.
#
-#
require 'grpc'
require 'google/cloud/tasks/v2/cloudtasks_pb'
module Google
@@ -42,12 +41,12 @@
# Gets a queue.
rpc :GetQueue, ::Google::Cloud::Tasks::V2::GetQueueRequest, ::Google::Cloud::Tasks::V2::Queue
# Creates a queue.
#
# Queues created with this method allow tasks to live for a maximum of 31
- # days. After a task is 31 days old, the task will be deleted regardless of whether
- # it was dispatched or not.
+ # days. After a task is 31 days old, the task will be deleted regardless of
+ # whether it was dispatched or not.
#
# WARNING: Using this method may have unintended side effects if you are
# using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
# Read
# [Overview of Queue Management and
@@ -58,12 +57,12 @@
#
# This method creates the queue if it does not exist and updates
# the queue if it does exist.
#
# Queues created with this method allow tasks to live for a maximum of 31
- # days. After a task is 31 days old, the task will be deleted regardless of whether
- # it was dispatched or not.
+ # days. After a task is 31 days old, the task will be deleted regardless of
+ # whether it was dispatched or not.
#
# WARNING: Using this method may have unintended side effects if you are
# using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
# Read
# [Overview of Queue Management and
@@ -93,21 +92,23 @@
rpc :PurgeQueue, ::Google::Cloud::Tasks::V2::PurgeQueueRequest, ::Google::Cloud::Tasks::V2::Queue
# Pauses the queue.
#
# If a queue is paused then the system will stop dispatching tasks
# until the queue is resumed via
- # [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue]. Tasks can still be added
- # when the queue is paused. A queue is paused if its
- # [state][google.cloud.tasks.v2.Queue.state] is [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
+ # [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue]. Tasks can
+ # still be added when the queue is paused. A queue is paused if its
+ # [state][google.cloud.tasks.v2.Queue.state] is
+ # [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
rpc :PauseQueue, ::Google::Cloud::Tasks::V2::PauseQueueRequest, ::Google::Cloud::Tasks::V2::Queue
# Resume a queue.
#
# This method resumes a queue after it has been
# [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED] or
- # [DISABLED][google.cloud.tasks.v2.Queue.State.DISABLED]. The state of a queue is stored
- # in the queue's [state][google.cloud.tasks.v2.Queue.state]; after calling this method it
- # will be set to [RUNNING][google.cloud.tasks.v2.Queue.State.RUNNING].
+ # [DISABLED][google.cloud.tasks.v2.Queue.State.DISABLED]. The state of a
+ # queue is stored in the queue's [state][google.cloud.tasks.v2.Queue.state];
+ # after calling this method it will be set to
+ # [RUNNING][google.cloud.tasks.v2.Queue.State.RUNNING].
#
# WARNING: Resuming many high-QPS queues at the same time can
# lead to target overloading. If you are resuming high-QPS
# queues, follow the 500/50/5 pattern described in
# [Managing Cloud Tasks Scaling
@@ -121,36 +122,37 @@
# [Google IAM](https://cloud.google.com/iam) permission on the specified
# resource parent:
#
# * `cloudtasks.queues.getIamPolicy`
rpc :GetIamPolicy, ::Google::Iam::V1::GetIamPolicyRequest, ::Google::Iam::V1::Policy
- # Sets the access control policy for a [Queue][google.cloud.tasks.v2.Queue]. Replaces any existing
- # policy.
+ # Sets the access control policy for a [Queue][google.cloud.tasks.v2.Queue].
+ # Replaces any existing policy.
#
# Note: The Cloud Console does not check queue-level IAM permissions yet.
# Project-level permissions are required to use the Cloud Console.
#
# Authorization requires the following
# [Google IAM](https://cloud.google.com/iam) permission on the specified
# resource parent:
#
# * `cloudtasks.queues.setIamPolicy`
rpc :SetIamPolicy, ::Google::Iam::V1::SetIamPolicyRequest, ::Google::Iam::V1::Policy
- # Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2.Queue].
- # If the resource does not exist, this will return an empty set of
- # permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
+ # Returns permissions that a caller has on a
+ # [Queue][google.cloud.tasks.v2.Queue]. If the resource does not exist, this
+ # will return an empty set of permissions, not a
+ # [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
#
# Note: This operation is designed to be used for building permission-aware
# UIs and command-line tools, not for authorization checking. This operation
# may "fail open" without warning.
rpc :TestIamPermissions, ::Google::Iam::V1::TestIamPermissionsRequest, ::Google::Iam::V1::TestIamPermissionsResponse
# Lists the tasks in a queue.
#
- # By default, only the [BASIC][google.cloud.tasks.v2.Task.View.BASIC] view is retrieved
- # due to performance considerations;
- # [response_view][google.cloud.tasks.v2.ListTasksRequest.response_view] controls the
- # subset of information which is returned.
+ # By default, only the [BASIC][google.cloud.tasks.v2.Task.View.BASIC] view is
+ # retrieved due to performance considerations;
+ # [response_view][google.cloud.tasks.v2.ListTasksRequest.response_view]
+ # controls the subset of information which is returned.
#
# The tasks may be returned in any order. The ordering may change at any
# time.
rpc :ListTasks, ::Google::Cloud::Tasks::V2::ListTasksRequest, ::Google::Cloud::Tasks::V2::ListTasksResponse
# Gets a task.
@@ -168,26 +170,28 @@
# failed.
rpc :DeleteTask, ::Google::Cloud::Tasks::V2::DeleteTaskRequest, ::Google::Protobuf::Empty
# Forces a task to run now.
#
# When this method is called, Cloud Tasks will dispatch the task, even if
- # the task is already running, the queue has reached its [RateLimits][google.cloud.tasks.v2.RateLimits] or
- # is [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
+ # the task is already running, the queue has reached its
+ # [RateLimits][google.cloud.tasks.v2.RateLimits] or is
+ # [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
#
# This command is meant to be used for manual debugging. For
- # example, [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] can be used to retry a failed
- # task after a fix has been made or to manually force a task to be
- # dispatched now.
+ # example, [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] can be used to
+ # retry a failed task after a fix has been made or to manually force a task
+ # to be dispatched now.
#
# The dispatched task is returned. That is, the task that is returned
# contains the [status][Task.status] after the task is dispatched but
# before the task is received by its target.
#
# If Cloud Tasks receives a successful response from the task's
# target, then the task will be deleted; otherwise the task's
- # [schedule_time][google.cloud.tasks.v2.Task.schedule_time] will be reset to the time that
- # [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] was called plus the retry delay specified
- # in the queue's [RetryConfig][google.cloud.tasks.v2.RetryConfig].
+ # [schedule_time][google.cloud.tasks.v2.Task.schedule_time] will be reset to
+ # the time that [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] was
+ # called plus the retry delay specified in the queue's
+ # [RetryConfig][google.cloud.tasks.v2.RetryConfig].
#
# [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] returns
# [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
# task that has already succeeded or permanently failed.
rpc :RunTask, ::Google::Cloud::Tasks::V2::RunTaskRequest, ::Google::Cloud::Tasks::V2::Task