google-cloud-tasks-v2 0.8.1 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/tasks/v2/bindings_override.rb +102 -0
  3. data/lib/google/cloud/tasks/v2/cloud_tasks/client.rb +118 -88
  4. data/lib/google/cloud/tasks/v2/cloud_tasks/rest/client.rb +380 -87
  5. data/lib/google/cloud/tasks/v2/cloud_tasks/rest.rb +1 -0
  6. data/lib/google/cloud/tasks/v2/cloudtasks_services_pb.rb +33 -29
  7. data/lib/google/cloud/tasks/v2/rest.rb +1 -0
  8. data/lib/google/cloud/tasks/v2/version.rb +1 -1
  9. data/proto_docs/google/api/field_behavior.rb +14 -0
  10. data/proto_docs/google/cloud/tasks/v2/cloudtasks.rb +74 -60
  11. data/proto_docs/google/cloud/tasks/v2/queue.rb +3 -3
  12. data/proto_docs/google/cloud/tasks/v2/target.rb +12 -13
  13. data/proto_docs/google/cloud/tasks/v2/task.rb +3 -3
  14. data/proto_docs/google/iam/v1/policy.rb +8 -4
  15. metadata +26 -5
data/lib/google/cloud/tasks/v2/cloud_tasks/rest.rb CHANGED
@@ -21,6 +21,7 @@ require "gapic/config"
21
21
  require "gapic/config/method"
22
22
 
23
23
  require "google/cloud/tasks/v2/version"
24
+ require "google/cloud/tasks/v2/bindings_override"
24
25
 
25
26
  require "google/cloud/tasks/v2/cloud_tasks/credentials"
26
27
  require "google/cloud/tasks/v2/cloud_tasks/paths"
data/lib/google/cloud/tasks/v2/cloudtasks_services_pb.rb CHANGED
@@ -1,7 +1,7 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # Source: google/cloud/tasks/v2/cloudtasks.proto for package 'google.cloud.tasks.v2'
3
3
  # Original file comments:
4
- # Copyright 2019 Google LLC.
4
+ # Copyright 2023 Google LLC
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
15
15
  # See the License for the specific language governing permissions and
16
16
  # limitations under the License.
17
17
  #
18
- #
19
18
 
20
19
  require 'grpc'
21
20
  require 'google/cloud/tasks/v2/cloudtasks_pb'
@@ -44,8 +43,8 @@ module Google
44
43
  # Creates a queue.
45
44
  #
46
45
  # Queues created with this method allow tasks to live for a maximum of 31
47
- # days. After a task is 31 days old, the task will be deleted regardless of whether
48
- # it was dispatched or not.
46
+ # days. After a task is 31 days old, the task will be deleted regardless of
47
+ # whether it was dispatched or not.
49
48
  #
50
49
  # WARNING: Using this method may have unintended side effects if you are
51
50
  # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
@@ -60,8 +59,8 @@ module Google
60
59
  # the queue if it does exist.
61
60
  #
62
61
  # Queues created with this method allow tasks to live for a maximum of 31
63
- # days. After a task is 31 days old, the task will be deleted regardless of whether
64
- # it was dispatched or not.
62
+ # days. After a task is 31 days old, the task will be deleted regardless of
63
+ # whether it was dispatched or not.
65
64
  #
66
65
  # WARNING: Using this method may have unintended side effects if you are
67
66
  # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
@@ -95,17 +94,19 @@ module Google
95
94
  #
96
95
  # If a queue is paused then the system will stop dispatching tasks
97
96
  # until the queue is resumed via
98
- # [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue]. Tasks can still be added
99
- # when the queue is paused. A queue is paused if its
100
- # [state][google.cloud.tasks.v2.Queue.state] is [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
97
+ # [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue]. Tasks can
98
+ # still be added when the queue is paused. A queue is paused if its
99
+ # [state][google.cloud.tasks.v2.Queue.state] is
100
+ # [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
101
101
  rpc :PauseQueue, ::Google::Cloud::Tasks::V2::PauseQueueRequest, ::Google::Cloud::Tasks::V2::Queue
102
102
  # Resume a queue.
103
103
  #
104
104
  # This method resumes a queue after it has been
105
105
  # [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED] or
106
- # [DISABLED][google.cloud.tasks.v2.Queue.State.DISABLED]. The state of a queue is stored
107
- # in the queue's [state][google.cloud.tasks.v2.Queue.state]; after calling this method it
108
- # will be set to [RUNNING][google.cloud.tasks.v2.Queue.State.RUNNING].
106
+ # [DISABLED][google.cloud.tasks.v2.Queue.State.DISABLED]. The state of a
107
+ # queue is stored in the queue's [state][google.cloud.tasks.v2.Queue.state];
108
+ # after calling this method it will be set to
109
+ # [RUNNING][google.cloud.tasks.v2.Queue.State.RUNNING].
109
110
  #
110
111
  # WARNING: Resuming many high-QPS queues at the same time can
111
112
  # lead to target overloading. If you are resuming high-QPS
@@ -123,8 +124,8 @@ module Google
123
124
  #
124
125
  # * `cloudtasks.queues.getIamPolicy`
125
126
  rpc :GetIamPolicy, ::Google::Iam::V1::GetIamPolicyRequest, ::Google::Iam::V1::Policy
126
- # Sets the access control policy for a [Queue][google.cloud.tasks.v2.Queue]. Replaces any existing
127
- # policy.
127
+ # Sets the access control policy for a [Queue][google.cloud.tasks.v2.Queue].
128
+ # Replaces any existing policy.
128
129
  #
129
130
  # Note: The Cloud Console does not check queue-level IAM permissions yet.
130
131
  # Project-level permissions are required to use the Cloud Console.
@@ -135,9 +136,10 @@ module Google
135
136
  #
136
137
  # * `cloudtasks.queues.setIamPolicy`
137
138
  rpc :SetIamPolicy, ::Google::Iam::V1::SetIamPolicyRequest, ::Google::Iam::V1::Policy
138
- # Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2.Queue].
139
- # If the resource does not exist, this will return an empty set of
140
- # permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
139
+ # Returns permissions that a caller has on a
140
+ # [Queue][google.cloud.tasks.v2.Queue]. If the resource does not exist, this
141
+ # will return an empty set of permissions, not a
142
+ # [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
141
143
  #
142
144
  # Note: This operation is designed to be used for building permission-aware
143
145
  # UIs and command-line tools, not for authorization checking. This operation
@@ -145,10 +147,10 @@ module Google
145
147
  rpc :TestIamPermissions, ::Google::Iam::V1::TestIamPermissionsRequest, ::Google::Iam::V1::TestIamPermissionsResponse
146
148
  # Lists the tasks in a queue.
147
149
  #
148
- # By default, only the [BASIC][google.cloud.tasks.v2.Task.View.BASIC] view is retrieved
149
- # due to performance considerations;
150
- # [response_view][google.cloud.tasks.v2.ListTasksRequest.response_view] controls the
151
- # subset of information which is returned.
150
+ # By default, only the [BASIC][google.cloud.tasks.v2.Task.View.BASIC] view is
151
+ # retrieved due to performance considerations;
152
+ # [response_view][google.cloud.tasks.v2.ListTasksRequest.response_view]
153
+ # controls the subset of information which is returned.
152
154
  #
153
155
  # The tasks may be returned in any order. The ordering may change at any
154
156
  # time.
@@ -170,13 +172,14 @@ module Google
170
172
  # Forces a task to run now.
171
173
  #
172
174
  # When this method is called, Cloud Tasks will dispatch the task, even if
173
- # the task is already running, the queue has reached its [RateLimits][google.cloud.tasks.v2.RateLimits] or
174
- # is [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
175
+ # the task is already running, the queue has reached its
176
+ # [RateLimits][google.cloud.tasks.v2.RateLimits] or is
177
+ # [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
175
178
  #
176
179
  # This command is meant to be used for manual debugging. For
177
- # example, [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] can be used to retry a failed
178
- # task after a fix has been made or to manually force a task to be
179
- # dispatched now.
180
+ # example, [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] can be used to
181
+ # retry a failed task after a fix has been made or to manually force a task
182
+ # to be dispatched now.
180
183
  #
181
184
  # The dispatched task is returned. That is, the task that is returned
182
185
  # contains the [status][Task.status] after the task is dispatched but
@@ -184,9 +187,10 @@ module Google
184
187
  #
185
188
  # If Cloud Tasks receives a successful response from the task's
186
189
  # target, then the task will be deleted; otherwise the task's
187
- # [schedule_time][google.cloud.tasks.v2.Task.schedule_time] will be reset to the time that
188
- # [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] was called plus the retry delay specified
189
- # in the queue's [RetryConfig][google.cloud.tasks.v2.RetryConfig].
190
+ # [schedule_time][google.cloud.tasks.v2.Task.schedule_time] will be reset to
191
+ # the time that [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] was
192
+ # called plus the retry delay specified in the queue's
193
+ # [RetryConfig][google.cloud.tasks.v2.RetryConfig].
190
194
  #
191
195
  # [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] returns
192
196
  # [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
data/lib/google/cloud/tasks/v2/rest.rb CHANGED
@@ -17,6 +17,7 @@
17
17
  # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
18
 
19
19
  require "google/cloud/tasks/v2/cloud_tasks/rest"
20
+ require "google/cloud/tasks/v2/bindings_override"
20
21
  require "google/cloud/tasks/v2/version"
21
22
 
22
23
  module Google
data/lib/google/cloud/tasks/v2/version.rb CHANGED
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Tasks
23
23
  module V2
24
- VERSION = "0.8.1"
24
+ VERSION = "0.9.0"
25
25
  end
26
26
  end
27
27
  end
data/proto_docs/google/api/field_behavior.rb CHANGED
@@ -66,6 +66,20 @@ module Google
66
66
  # a non-empty value will be returned. The user will not be aware of what
67
67
  # non-empty value to expect.
68
68
  NON_EMPTY_DEFAULT = 7
69
+
70
+ # Denotes that the field in a resource (a message annotated with
71
+ # google.api.resource) is used in the resource name to uniquely identify the
72
+ # resource. For AIP-compliant APIs, this should only be applied to the
73
+ # `name` field on the resource.
74
+ #
75
+ # This behavior should not be applied to references to other resources within
76
+ # the message.
77
+ #
78
+ # The identifier field of resources often have different field behavior
79
+ # depending on the request it is embedded in (e.g. for Create methods name
80
+ # is optional and unused, while for Update methods it is required). Instead
81
+ # of method-specific annotations, only `IDENTIFIER` is required.
82
+ IDENTIFIER = 8
69
83
  end
70
84
  end
71
85
  end
data/proto_docs/google/cloud/tasks/v2/cloudtasks.rb CHANGED
@@ -21,18 +21,18 @@ module Google
21
21
  module Cloud
22
22
  module Tasks
23
23
  module V2
24
- # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues}.
24
+ # Request message for
25
+ # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues}.
25
26
  # @!attribute [rw] parent
26
27
  # @return [::String]
27
28
  # Required. The location name.
28
29
  # For example: `projects/PROJECT_ID/locations/LOCATION_ID`
29
30
  # @!attribute [rw] filter
30
31
  # @return [::String]
31
- # `filter` can be used to specify a subset of queues. Any {::Google::Cloud::Tasks::V2::Queue Queue}
32
- # field can be used as a filter and several operators as supported.
33
- # For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
34
- # described in
35
- # [Stackdriver's Advanced Logs
32
+ # `filter` can be used to specify a subset of queues. Any
33
+ # {::Google::Cloud::Tasks::V2::Queue Queue} field can be used as a filter and
34
+ # several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The
35
+ # filter syntax is the same as described in [Stackdriver's Advanced Logs
36
36
  # Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
37
37
  #
38
38
  # Sample filter "state: PAUSED".
@@ -46,24 +46,27 @@ module Google
46
46
  # The maximum page size is 9800. If unspecified, the page size will
47
47
  # be the maximum. Fewer queues than requested might be returned,
48
48
  # even if more queues exist; use the
49
- # {::Google::Cloud::Tasks::V2::ListQueuesResponse#next_page_token next_page_token} in the
50
- # response to determine if more queues exist.
49
+ # {::Google::Cloud::Tasks::V2::ListQueuesResponse#next_page_token next_page_token}
50
+ # in the response to determine if more queues exist.
51
51
  # @!attribute [rw] page_token
52
52
  # @return [::String]
53
53
  # A token identifying the page of results to return.
54
54
  #
55
55
  # To request the first page results, page_token must be empty. To
56
56
  # request the next page of results, page_token must be the value of
57
- # {::Google::Cloud::Tasks::V2::ListQueuesResponse#next_page_token next_page_token} returned
58
- # from the previous call to {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues}
59
- # method. It is an error to switch the value of the
60
- # {::Google::Cloud::Tasks::V2::ListQueuesRequest#filter filter} while iterating through pages.
57
+ # {::Google::Cloud::Tasks::V2::ListQueuesResponse#next_page_token next_page_token}
58
+ # returned from the previous call to
59
+ # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues} method. It is an
60
+ # error to switch the value of the
61
+ # {::Google::Cloud::Tasks::V2::ListQueuesRequest#filter filter} while iterating
62
+ # through pages.
61
63
  class ListQueuesRequest
62
64
  include ::Google::Protobuf::MessageExts
63
65
  extend ::Google::Protobuf::MessageExts::ClassMethods
64
66
  end
65
67
 
66
- # Response message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues}.
68
+ # Response message for
69
+ # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues}.
67
70
  # @!attribute [rw] queues
68
71
  # @return [::Array<::Google::Cloud::Tasks::V2::Queue>]
69
72
  # The list of queues.
@@ -72,8 +75,8 @@ module Google
72
75
  # A token to retrieve next page of results.
73
76
  #
74
77
  # To return the next page of results, call
75
- # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues} with this value as the
76
- # {::Google::Cloud::Tasks::V2::ListQueuesRequest#page_token page_token}.
78
+ # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues} with this value
79
+ # as the {::Google::Cloud::Tasks::V2::ListQueuesRequest#page_token page_token}.
77
80
  #
78
81
  # If the next_page_token is empty, there are no more results.
79
82
  #
@@ -93,7 +96,8 @@ module Google
93
96
  extend ::Google::Protobuf::MessageExts::ClassMethods
94
97
  end
95
98
 
96
- # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_queue CreateQueue}.
99
+ # Request message for
100
+ # {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_queue CreateQueue}.
97
101
  # @!attribute [rw] parent
98
102
  # @return [::String]
99
103
  # Required. The location name in which the queue will be created.
@@ -101,18 +105,20 @@ module Google
101
105
  #
102
106
  # The list of allowed locations can be obtained by calling Cloud
103
107
  # Tasks' implementation of
104
- # [ListLocations][google.cloud.location.Locations.ListLocations].
108
+ # `::Google::Cloud::Location::Locations::Client#list_locations`.
105
109
  # @!attribute [rw] queue
106
110
  # @return [::Google::Cloud::Tasks::V2::Queue]
107
111
  # Required. The queue to create.
108
112
  #
109
- # [Queue's name][google.cloud.tasks.v2.Queue.name] cannot be the same as an existing queue.
113
+ # [Queue's name][google.cloud.tasks.v2.Queue.name] cannot be the same as an
114
+ # existing queue.
110
115
  class CreateQueueRequest
111
116
  include ::Google::Protobuf::MessageExts
112
117
  extend ::Google::Protobuf::MessageExts::ClassMethods
113
118
  end
114
119
 
115
- # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#update_queue UpdateQueue}.
120
+ # Request message for
121
+ # {::Google::Cloud::Tasks::V2::CloudTasks::Client#update_queue UpdateQueue}.
116
122
  # @!attribute [rw] queue
117
123
  # @return [::Google::Cloud::Tasks::V2::Queue]
118
124
  # Required. The queue to create or update.
@@ -132,7 +138,8 @@ module Google
132
138
  extend ::Google::Protobuf::MessageExts::ClassMethods
133
139
  end
134
140
 
135
- # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#delete_queue DeleteQueue}.
141
+ # Request message for
142
+ # {::Google::Cloud::Tasks::V2::CloudTasks::Client#delete_queue DeleteQueue}.
136
143
  # @!attribute [rw] name
137
144
  # @return [::String]
138
145
  # Required. The queue name. For example:
@@ -142,7 +149,8 @@ module Google
142
149
  extend ::Google::Protobuf::MessageExts::ClassMethods
143
150
  end
144
151
 
145
- # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#purge_queue PurgeQueue}.
152
+ # Request message for
153
+ # {::Google::Cloud::Tasks::V2::CloudTasks::Client#purge_queue PurgeQueue}.
146
154
  # @!attribute [rw] name
147
155
  # @return [::String]
148
156
  # Required. The queue name. For example:
@@ -152,7 +160,8 @@ module Google
152
160
  extend ::Google::Protobuf::MessageExts::ClassMethods
153
161
  end
154
162
 
155
- # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#pause_queue PauseQueue}.
163
+ # Request message for
164
+ # {::Google::Cloud::Tasks::V2::CloudTasks::Client#pause_queue PauseQueue}.
156
165
  # @!attribute [rw] name
157
166
  # @return [::String]
158
167
  # Required. The queue name. For example:
@@ -162,7 +171,8 @@ module Google
162
171
  extend ::Google::Protobuf::MessageExts::ClassMethods
163
172
  end
164
173
 
165
- # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#resume_queue ResumeQueue}.
174
+ # Request message for
175
+ # {::Google::Cloud::Tasks::V2::CloudTasks::Client#resume_queue ResumeQueue}.
166
176
  # @!attribute [rw] name
167
177
  # @return [::String]
168
178
  # Required. The queue name. For example:
@@ -172,18 +182,19 @@ module Google
172
182
  extend ::Google::Protobuf::MessageExts::ClassMethods
173
183
  end
174
184
 
175
- # Request message for listing tasks using {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks}.
185
+ # Request message for listing tasks using
186
+ # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks}.
176
187
  # @!attribute [rw] parent
177
188
  # @return [::String]
178
189
  # Required. The queue name. For example:
179
190
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
180
191
  # @!attribute [rw] response_view
181
192
  # @return [::Google::Cloud::Tasks::V2::Task::View]
182
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2::Task Task} will be
183
- # returned.
193
+ # The response_view specifies which subset of the
194
+ # {::Google::Cloud::Tasks::V2::Task Task} will be returned.
184
195
  #
185
- # By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC}; not all
186
- # information is retrieved by default because some data, such as
196
+ # By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC};
197
+ # not all information is retrieved by default because some data, such as
187
198
  # payloads, might be desirable to return only when needed because
188
199
  # of its large size or because of the sensitivity of data that it
189
200
  # contains.
@@ -196,8 +207,8 @@ module Google
196
207
  # Maximum page size.
197
208
  #
198
209
  # Fewer tasks than requested might be returned, even if more tasks exist; use
199
- # {::Google::Cloud::Tasks::V2::ListTasksResponse#next_page_token next_page_token} in the response to
200
- # determine if more tasks exist.
210
+ # {::Google::Cloud::Tasks::V2::ListTasksResponse#next_page_token next_page_token}
211
+ # in the response to determine if more tasks exist.
201
212
  #
202
213
  # The maximum page size is 1000. If unspecified, the page size will be the
203
214
  # maximum.
@@ -207,9 +218,9 @@ module Google
207
218
  #
208
219
  # To request the first page results, page_token must be empty. To
209
220
  # request the next page of results, page_token must be the value of
210
- # {::Google::Cloud::Tasks::V2::ListTasksResponse#next_page_token next_page_token} returned
211
- # from the previous call to {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks}
212
- # method.
221
+ # {::Google::Cloud::Tasks::V2::ListTasksResponse#next_page_token next_page_token}
222
+ # returned from the previous call to
223
+ # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks} method.
213
224
  #
214
225
  # The page token is valid for only 2 hours.
215
226
  class ListTasksRequest
@@ -217,7 +228,8 @@ module Google
217
228
  extend ::Google::Protobuf::MessageExts::ClassMethods
218
229
  end
219
230
 
220
- # Response message for listing tasks using {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks}.
231
+ # Response message for listing tasks using
232
+ # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks}.
221
233
  # @!attribute [rw] tasks
222
234
  # @return [::Array<::Google::Cloud::Tasks::V2::Task>]
223
235
  # The list of tasks.
@@ -226,8 +238,8 @@ module Google
226
238
  # A token to retrieve next page of results.
227
239
  #
228
240
  # To return the next page of results, call
229
- # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks} with this value as the
230
- # {::Google::Cloud::Tasks::V2::ListTasksRequest#page_token page_token}.
241
+ # {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks} with this value as
242
+ # the {::Google::Cloud::Tasks::V2::ListTasksRequest#page_token page_token}.
231
243
  #
232
244
  # If the next_page_token is empty, there are no more results.
233
245
  class ListTasksResponse
@@ -235,18 +247,19 @@ module Google
235
247
  extend ::Google::Protobuf::MessageExts::ClassMethods
236
248
  end
237
249
 
238
- # Request message for getting a task using {::Google::Cloud::Tasks::V2::CloudTasks::Client#get_task GetTask}.
250
+ # Request message for getting a task using
251
+ # {::Google::Cloud::Tasks::V2::CloudTasks::Client#get_task GetTask}.
239
252
  # @!attribute [rw] name
240
253
  # @return [::String]
241
254
  # Required. The task name. For example:
242
255
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
243
256
  # @!attribute [rw] response_view
244
257
  # @return [::Google::Cloud::Tasks::V2::Task::View]
245
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2::Task Task} will be
246
- # returned.
258
+ # The response_view specifies which subset of the
259
+ # {::Google::Cloud::Tasks::V2::Task Task} will be returned.
247
260
  #
248
- # By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC}; not all
249
- # information is retrieved by default because some data, such as
261
+ # By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC};
262
+ # not all information is retrieved by default because some data, such as
250
263
  # payloads, might be desirable to return only when needed because
251
264
  # of its large size or because of the sensitivity of data that it
252
265
  # contains.
@@ -259,7 +272,8 @@ module Google
259
272
  extend ::Google::Protobuf::MessageExts::ClassMethods
260
273
  end
261
274
 
262
- # Request message for {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_task CreateTask}.
275
+ # Request message for
276
+ # {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_task CreateTask}.
263
277
  # @!attribute [rw] parent
264
278
  # @return [::String]
265
279
  # Required. The queue name. For example:
@@ -272,13 +286,13 @@ module Google
272
286
  #
273
287
  # Task names have the following format:
274
288
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
275
- # The user can optionally specify a task {::Google::Cloud::Tasks::V2::Task#name name}. If a
276
- # name is not specified then the system will generate a random
277
- # unique task id, which will be set in the task returned in the
278
- # {::Google::Cloud::Tasks::V2::Task#name response}.
289
+ # The user can optionally specify a task
290
+ # {::Google::Cloud::Tasks::V2::Task#name name}. If a name is not specified then
291
+ # the system will generate a random unique task id, which will be set in the
292
+ # task returned in the {::Google::Cloud::Tasks::V2::Task#name response}.
279
293
  #
280
- # If {::Google::Cloud::Tasks::V2::Task#schedule_time schedule_time} is not set or is in the
281
- # past then Cloud Tasks will set it to the current time.
294
+ # If {::Google::Cloud::Tasks::V2::Task#schedule_time schedule_time} is not set or
295
+ # is in the past then Cloud Tasks will set it to the current time.
282
296
  #
283
297
  # Task De-duplication:
284
298
  #
@@ -293,21 +307,21 @@ module Google
293
307
  # for ~9days after the original task was deleted or executed.
294
308
  #
295
309
  # Because there is an extra lookup cost to identify duplicate task
296
- # names, these {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_task CreateTask} calls have significantly
297
- # increased latency. Using hashed strings for the task id or for
298
- # the prefix of the task id is recommended. Choosing task ids that
299
- # are sequential or have sequential prefixes, for example using a
310
+ # names, these {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_task CreateTask}
311
+ # calls have significantly increased latency. Using hashed strings for the
312
+ # task id or for the prefix of the task id is recommended. Choosing task ids
313
+ # that are sequential or have sequential prefixes, for example using a
300
314
  # timestamp, causes an increase in latency and error rates in all
301
315
  # task commands. The infrastructure relies on an approximately
302
316
  # uniform distribution of task ids to store and serve tasks
303
317
  # efficiently.
304
318
  # @!attribute [rw] response_view
305
319
  # @return [::Google::Cloud::Tasks::V2::Task::View]
306
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2::Task Task} will be
307
- # returned.
320
+ # The response_view specifies which subset of the
321
+ # {::Google::Cloud::Tasks::V2::Task Task} will be returned.
308
322
  #
309
- # By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC}; not all
310
- # information is retrieved by default because some data, such as
323
+ # By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC};
324
+ # not all information is retrieved by default because some data, such as
311
325
  # payloads, might be desirable to return only when needed because
312
326
  # of its large size or because of the sensitivity of data that it
313
327
  # contains.
@@ -339,11 +353,11 @@ module Google
339
353
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
340
354
  # @!attribute [rw] response_view
341
355
  # @return [::Google::Cloud::Tasks::V2::Task::View]
342
- # The response_view specifies which subset of the {::Google::Cloud::Tasks::V2::Task Task} will be
343
- # returned.
356
+ # The response_view specifies which subset of the
357
+ # {::Google::Cloud::Tasks::V2::Task Task} will be returned.
344
358
  #
345
- # By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC}; not all
346
- # information is retrieved by default because some data, such as
359
+ # By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC};
360
+ # not all information is retrieved by default because some data, such as
347
361
  # payloads, might be desirable to return only when needed because
348
362
  # of its large size or because of the sensitivity of data that it
349
363
  # contains.
data/proto_docs/google/cloud/tasks/v2/queue.rb CHANGED
@@ -42,7 +42,7 @@ module Google
42
42
  # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
43
43
  # * `LOCATION_ID` is the canonical ID for the queue's location.
44
44
  # The list of available locations can be obtained by calling
45
- # [ListLocations][google.cloud.location.Locations.ListLocations].
45
+ # `::Google::Cloud::Location::Locations::Client#list_locations`.
46
46
  # For more information, see https://cloud.google.com/about/locations/.
47
47
  # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
48
48
  # hyphens (-). The maximum length is 100 characters.
@@ -105,7 +105,7 @@ module Google
105
105
  # @return [::Google::Cloud::Tasks::V2::Queue::State]
106
106
  # Output only. The state of the queue.
107
107
  #
108
- # `state` can only be changed by called
108
+ # `state` can only be changed by calling
109
109
  # {::Google::Cloud::Tasks::V2::CloudTasks::Client#pause_queue PauseQueue},
110
110
  # {::Google::Cloud::Tasks::V2::CloudTasks::Client#resume_queue ResumeQueue}, or uploading
111
111
  # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
@@ -331,7 +331,7 @@ module Google
331
331
  # A task's retry interval starts at
332
332
  # {::Google::Cloud::Tasks::V2::RetryConfig#min_backoff min_backoff}, then doubles
333
333
  # `max_doublings` times, then increases linearly, and finally
334
- # retries retries at intervals of
334
+ # retries at intervals of
335
335
  # {::Google::Cloud::Tasks::V2::RetryConfig#max_backoff max_backoff} up to
336
336
  # {::Google::Cloud::Tasks::V2::RetryConfig#max_attempts max_attempts} times.
337
337
  #
data/proto_docs/google/cloud/tasks/v2/target.rb CHANGED
@@ -168,9 +168,10 @@ module Google
168
168
  # or task-level:
169
169
  #
170
170
  # * If [app_engine_routing_override is set on the
171
- # queue][Queue.app_engine_routing_override], this value is used for all
172
- # tasks in the queue, no matter what the setting is for the [task-level
173
- # app_engine_routing][AppEngineHttpRequest.app_engine_routing].
171
+ # queue][google.cloud.tasks.v2.Queue.app_engine_routing_override], this value
172
+ # is used for all tasks in the queue, no matter what the setting is for the
173
+ # [task-level
174
+ # app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
174
175
  #
175
176
  #
176
177
  # The `url` that the task will be sent to is:
@@ -205,22 +206,20 @@ module Google
205
206
  # The HTTP method to use for the request. The default is POST.
206
207
  #
207
208
  # The app's request handler for the task's target URL must be able to handle
208
- # HTTP requests with this http_method, otherwise the task attempt will fail
209
- # with error code 405 (Method Not Allowed). See
210
- # [Writing a push task request
209
+ # HTTP requests with this http_method, otherwise the task attempt fails with
210
+ # error code 405 (Method Not Allowed). See [Writing a push task request
211
211
  # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
212
- # and the documentation for the request handlers in the language your app is
213
- # written in e.g.
214
- # [Python Request
215
- # Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
212
+ # and the App Engine documentation for your runtime on [How Requests are
213
+ # Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
216
214
  # @!attribute [rw] app_engine_routing
217
215
  # @return [::Google::Cloud::Tasks::V2::AppEngineRouting]
218
216
  # Task-level setting for App Engine routing.
219
217
  #
220
218
  # * If [app_engine_routing_override is set on the
221
- # queue][Queue.app_engine_routing_override], this value is used for all
222
- # tasks in the queue, no matter what the setting is for the [task-level
223
- # app_engine_routing][AppEngineHttpRequest.app_engine_routing].
219
+ # queue][google.cloud.tasks.v2.Queue.app_engine_routing_override], this
220
+ # value is used for all tasks in the queue, no matter what the setting is
221
+ # for the [task-level
222
+ # app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
224
223
  # @!attribute [rw] relative_uri
225
224
  # @return [::String]
226
225
  # The relative URI.
data/proto_docs/google/cloud/tasks/v2/task.rb CHANGED
@@ -39,7 +39,7 @@ module Google
39
39
  # projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
40
40
  # * `LOCATION_ID` is the canonical ID for the task's location.
41
41
  # The list of available locations can be obtained by calling
42
- # [ListLocations][google.cloud.location.Locations.ListLocations].
42
+ # `::Google::Cloud::Location::Locations::Client#list_locations`.
43
43
  # For more information, see https://cloud.google.com/about/locations/.
44
44
  # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
45
45
  # hyphens (-). The maximum length is 100 characters.
@@ -74,8 +74,8 @@ module Google
74
74
  # is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
75
75
  # task according to the {::Google::Cloud::Tasks::V2::RetryConfig RetryConfig}.
76
76
  #
77
- # Note that when the request is cancelled, Cloud Tasks will stop listing for
78
- # the response, but whether the worker stops processing depends on the
77
+ # Note that when the request is cancelled, Cloud Tasks will stop listening
78
+ # for the response, but whether the worker stops processing depends on the
79
79
  # worker. For example, if the worker is stuck, it may not react to cancelled
80
80
  # requests.
81
81
  #
data/proto_docs/google/iam/v1/policy.rb CHANGED
@@ -40,6 +40,7 @@ module Google
40
40
  #
41
41
  # **JSON example:**
42
42
  #
43
+ # ```
43
44
  # {
44
45
  # "bindings": [
45
46
  # {
@@ -67,9 +68,11 @@ module Google
67
68
  # "etag": "BwWWja0YfJA=",
68
69
  # "version": 3
69
70
  # }
71
+ # ```
70
72
  #
71
73
  # **YAML example:**
72
74
  #
75
+ # ```
73
76
  # bindings:
74
77
  # - members:
75
78
  # - user:mike@example.com
@@ -86,6 +89,7 @@ module Google
86
89
  # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
87
90
  # etag: BwWWja0YfJA=
88
91
  # version: 3
92
+ # ```
89
93
  #
90
94
  # For a description of IAM and its features, see the
91
95
  # [IAM documentation](https://cloud.google.com/iam/docs/).
@@ -157,7 +161,7 @@ module Google
157
161
  # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
158
162
  # @!attribute [rw] members
159
163
  # @return [::Array<::String>]
160
- # Specifies the principals requesting access for a Cloud Platform resource.
164
+ # Specifies the principals requesting access for a Google Cloud resource.
161
165
  # `members` can have the following values:
162
166
  #
163
167
  # * `allUsers`: A special identifier that represents anyone who is
@@ -267,8 +271,8 @@ module Google
267
271
  # }
268
272
  #
269
273
  # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
270
- # logging. It also exempts jose@example.com from DATA_READ logging, and
271
- # aliya@example.com from DATA_WRITE logging.
274
+ # logging. It also exempts `jose@example.com` from DATA_READ logging, and
275
+ # `aliya@example.com` from DATA_WRITE logging.
272
276
  # @!attribute [rw] service
273
277
  # @return [::String]
274
278
  # Specifies a service that will be enabled for audit logging.
@@ -356,7 +360,7 @@ module Google
356
360
  # Required
357
361
  # @!attribute [rw] member
358
362
  # @return [::String]
359
- # A single identity requesting access for a Cloud Platform resource.
363
+ # A single identity requesting access for a Google Cloud resource.
360
364
  # Follows the same format of Binding.members.
361
365
  # Required
362
366
  # @!attribute [rw] condition