google-cloud-tasks 0.3.0 → 0.4.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 (18) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/tasks/v2beta2/cloud_tasks_client.rb +210 -181
  3. data/lib/google/cloud/tasks/v2beta2/cloudtasks_services_pb.rb +79 -63
  4. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb +178 -146
  5. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/queue.rb +103 -68
  6. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/target.rb +110 -71
  7. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/task.rb +43 -25
  8. data/lib/google/cloud/tasks/v2beta2/doc/google/rpc/status.rb +17 -14
  9. data/lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb +123 -104
  10. data/lib/google/cloud/tasks/v2beta3/cloudtasks_services_pb.rb +51 -39
  11. data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/cloudtasks.rb +116 -92
  12. data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/queue.rb +84 -55
  13. data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/target.rb +175 -52
  14. data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/task.rb +40 -16
  15. data/lib/google/cloud/tasks/v2beta3/doc/google/rpc/status.rb +17 -14
  16. data/lib/google/cloud/tasks/v2beta3/target_pb.rb +7 -0
  17. data/lib/google/cloud/tasks/v2beta3/task_pb.rb +1 -0
  18. metadata +4 -4
data/lib/google/cloud/tasks/v2beta3/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/v2beta3/cloudtasks.proto for package 'google.cloud.tasks.v2beta3'
3
3
  # Original file comments:
4
- # Copyright 2018 Google LLC.
4
+ # Copyright 2019 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.
@@ -45,14 +45,15 @@ module Google
45
45
  # Creates a queue.
46
46
  #
47
47
  # Queues created with this method allow tasks to live for a maximum of 31
48
- # days. After a task is 31 days old, the task will be deleted regardless of whether
49
- # it was dispatched or not.
48
+ # days. After a task is 31 days old, the task will be deleted regardless of
49
+ # whether it was dispatched or not.
50
50
  #
51
51
  # WARNING: Using this method may have unintended side effects if you are
52
52
  # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
53
53
  # Read
54
- # [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
55
- # before using this method.
54
+ # [Overview of Queue Management and
55
+ # queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
56
+ # this method.
56
57
  rpc :CreateQueue, CreateQueueRequest, Queue
57
58
  # Updates a queue.
58
59
  #
@@ -60,14 +61,15 @@ module Google
60
61
  # the queue if it does exist.
61
62
  #
62
63
  # 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.
64
+ # days. After a task is 31 days old, the task will be deleted regardless of
65
+ # whether it was dispatched or not.
65
66
  #
66
67
  # WARNING: Using this method may have unintended side effects if you are
67
68
  # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
68
69
  # Read
69
- # [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
70
- # before using this method.
70
+ # [Overview of Queue Management and
71
+ # queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
72
+ # this method.
71
73
  rpc :UpdateQueue, UpdateQueueRequest, Queue
72
74
  # Deletes a queue.
73
75
  #
@@ -79,8 +81,9 @@ module Google
79
81
  # WARNING: Using this method may have unintended side effects if you are
80
82
  # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
81
83
  # Read
82
- # [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
83
- # before using this method.
84
+ # [Overview of Queue Management and
85
+ # queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
86
+ # this method.
84
87
  rpc :DeleteQueue, DeleteQueueRequest, Google::Protobuf::Empty
85
88
  # Purges a queue by deleting all of its tasks.
86
89
  #
@@ -93,26 +96,30 @@ module Google
93
96
  #
94
97
  # If a queue is paused then the system will stop dispatching tasks
95
98
  # until the queue is resumed via
96
- # [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue]. Tasks can still be added
97
- # when the queue is paused. A queue is paused if its
98
- # [state][google.cloud.tasks.v2beta3.Queue.state] is [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED].
99
+ # [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue]. Tasks can
100
+ # still be added when the queue is paused. A queue is paused if its
101
+ # [state][google.cloud.tasks.v2beta3.Queue.state] is
102
+ # [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED].
99
103
  rpc :PauseQueue, PauseQueueRequest, Queue
100
104
  # Resume a queue.
101
105
  #
102
106
  # This method resumes a queue after it has been
103
107
  # [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED] or
104
- # [DISABLED][google.cloud.tasks.v2beta3.Queue.State.DISABLED]. The state of a queue is stored
105
- # in the queue's [state][google.cloud.tasks.v2beta3.Queue.state]; after calling this method it
106
- # will be set to [RUNNING][google.cloud.tasks.v2beta3.Queue.State.RUNNING].
108
+ # [DISABLED][google.cloud.tasks.v2beta3.Queue.State.DISABLED]. The state of a
109
+ # queue is stored in the queue's
110
+ # [state][google.cloud.tasks.v2beta3.Queue.state]; after calling this method
111
+ # it will be set to
112
+ # [RUNNING][google.cloud.tasks.v2beta3.Queue.State.RUNNING].
107
113
  #
108
114
  # WARNING: Resuming many high-QPS queues at the same time can
109
115
  # lead to target overloading. If you are resuming high-QPS
110
116
  # queues, follow the 500/50/5 pattern described in
111
- # [Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
117
+ # [Managing Cloud Tasks Scaling
118
+ # Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
112
119
  rpc :ResumeQueue, ResumeQueueRequest, Queue
113
- # Gets the access control policy for a [Queue][google.cloud.tasks.v2beta3.Queue].
114
- # Returns an empty policy if the resource exists and does not have a policy
115
- # set.
120
+ # Gets the access control policy for a
121
+ # [Queue][google.cloud.tasks.v2beta3.Queue]. Returns an empty policy if the
122
+ # resource exists and does not have a policy set.
116
123
  #
117
124
  # Authorization requires the following
118
125
  # [Google IAM](https://cloud.google.com/iam) permission on the specified
@@ -120,8 +127,8 @@ module Google
120
127
  #
121
128
  # * `cloudtasks.queues.getIamPolicy`
122
129
  rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
123
- # Sets the access control policy for a [Queue][google.cloud.tasks.v2beta3.Queue]. Replaces any existing
124
- # policy.
130
+ # Sets the access control policy for a
131
+ # [Queue][google.cloud.tasks.v2beta3.Queue]. Replaces any existing policy.
125
132
  #
126
133
  # Note: The Cloud Console does not check queue-level IAM permissions yet.
127
134
  # Project-level permissions are required to use the Cloud Console.
@@ -132,9 +139,10 @@ module Google
132
139
  #
133
140
  # * `cloudtasks.queues.setIamPolicy`
134
141
  rpc :SetIamPolicy, Google::Iam::V1::SetIamPolicyRequest, Google::Iam::V1::Policy
135
- # Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta3.Queue].
136
- # If the resource does not exist, this will return an empty set of
137
- # permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
142
+ # Returns permissions that a caller has on a
143
+ # [Queue][google.cloud.tasks.v2beta3.Queue]. If the resource does not exist,
144
+ # this will return an empty set of permissions, not a
145
+ # [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
138
146
  #
139
147
  # Note: This operation is designed to be used for building permission-aware
140
148
  # UIs and command-line tools, not for authorization checking. This operation
@@ -142,10 +150,10 @@ module Google
142
150
  rpc :TestIamPermissions, Google::Iam::V1::TestIamPermissionsRequest, Google::Iam::V1::TestIamPermissionsResponse
143
151
  # Lists the tasks in a queue.
144
152
  #
145
- # By default, only the [BASIC][google.cloud.tasks.v2beta3.Task.View.BASIC] view is retrieved
146
- # due to performance considerations;
147
- # [response_view][google.cloud.tasks.v2beta3.ListTasksRequest.response_view] controls the
148
- # subset of information which is returned.
153
+ # By default, only the [BASIC][google.cloud.tasks.v2beta3.Task.View.BASIC]
154
+ # view is retrieved due to performance considerations;
155
+ # [response_view][google.cloud.tasks.v2beta3.ListTasksRequest.response_view]
156
+ # controls the subset of information which is returned.
149
157
  #
150
158
  # The tasks may be returned in any order. The ordering may change at any
151
159
  # time.
@@ -156,7 +164,8 @@ module Google
156
164
  #
157
165
  # Tasks cannot be updated after creation; there is no UpdateTask command.
158
166
  #
159
- # * For [App Engine queues][google.cloud.tasks.v2beta3.AppEngineHttpQueue], the maximum task size is
167
+ # * For [App Engine queues][google.cloud.tasks.v2beta3.AppEngineHttpQueue],
168
+ # the maximum task size is
160
169
  # 100KB.
161
170
  rpc :CreateTask, CreateTaskRequest, Task
162
171
  # Deletes a task.
@@ -168,13 +177,14 @@ module Google
168
177
  # Forces a task to run now.
169
178
  #
170
179
  # When this method is called, Cloud Tasks will dispatch the task, even if
171
- # the task is already running, the queue has reached its [RateLimits][google.cloud.tasks.v2beta3.RateLimits] or
172
- # is [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED].
180
+ # the task is already running, the queue has reached its
181
+ # [RateLimits][google.cloud.tasks.v2beta3.RateLimits] or is
182
+ # [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED].
173
183
  #
174
184
  # This command is meant to be used for manual debugging. For
175
- # example, [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] can be used to retry a failed
176
- # task after a fix has been made or to manually force a task to be
177
- # dispatched now.
185
+ # example, [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] can be
186
+ # used to retry a failed task after a fix has been made or to manually force
187
+ # a task to be dispatched now.
178
188
  #
179
189
  # The dispatched task is returned. That is, the task that is returned
180
190
  # contains the [status][Task.status] after the task is dispatched but
@@ -182,9 +192,11 @@ module Google
182
192
  #
183
193
  # If Cloud Tasks receives a successful response from the task's
184
194
  # target, then the task will be deleted; otherwise the task's
185
- # [schedule_time][google.cloud.tasks.v2beta3.Task.schedule_time] will be reset to the time that
186
- # [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] was called plus the retry delay specified
187
- # in the queue's [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig].
195
+ # [schedule_time][google.cloud.tasks.v2beta3.Task.schedule_time] will be
196
+ # reset to the time that
197
+ # [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] was called plus
198
+ # the retry delay specified in the queue's
199
+ # [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig].
188
200
  #
189
201
  # [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] returns
190
202
  # [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/cloudtasks.rb CHANGED
@@ -17,7 +17,8 @@ module Google
17
17
  module Cloud
18
18
  module Tasks
19
19
  module V2beta3
20
- # Request message for {Google::Cloud::Tasks::V2beta3::CloudTasks::ListQueues ListQueues}.
20
+ # Request message for
21
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListQueues ListQueues}.
21
22
  # @!attribute [rw] parent
22
23
  # @return [String]
23
24
  # Required.
@@ -26,11 +27,11 @@ module Google
26
27
  # For example: `projects/PROJECT_ID/locations/LOCATION_ID`
27
28
  # @!attribute [rw] filter
28
29
  # @return [String]
29
- # `filter` can be used to specify a subset of queues. Any {Google::Cloud::Tasks::V2beta3::Queue Queue}
30
- # field can be used as a filter and several operators as supported.
31
- # For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
32
- # described in
33
- # [Stackdriver's Advanced Logs Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
30
+ # `filter` can be used to specify a subset of queues. Any
31
+ # {Google::Cloud::Tasks::V2beta3::Queue Queue} field can be used as a filter and
32
+ # several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The
33
+ # filter syntax is the same as described in [Stackdriver's Advanced Logs
34
+ # Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
34
35
  #
35
36
  # Sample filter "state: PAUSED".
36
37
  #
@@ -43,21 +44,24 @@ module Google
43
44
  # The maximum page size is 9800. If unspecified, the page size will
44
45
  # be the maximum. Fewer queues than requested might be returned,
45
46
  # even if more queues exist; use the
46
- # {Google::Cloud::Tasks::V2beta3::ListQueuesResponse#next_page_token next_page_token} in the
47
- # response to determine if more queues exist.
47
+ # {Google::Cloud::Tasks::V2beta3::ListQueuesResponse#next_page_token next_page_token}
48
+ # in the response to determine if more queues exist.
48
49
  # @!attribute [rw] page_token
49
50
  # @return [String]
50
51
  # A token identifying the page of results to return.
51
52
  #
52
53
  # To request the first page results, page_token must be empty. To
53
54
  # request the next page of results, page_token must be the value of
54
- # {Google::Cloud::Tasks::V2beta3::ListQueuesResponse#next_page_token next_page_token} returned
55
- # from the previous call to {Google::Cloud::Tasks::V2beta3::CloudTasks::ListQueues ListQueues}
56
- # method. It is an error to switch the value of the
57
- # {Google::Cloud::Tasks::V2beta3::ListQueuesRequest#filter filter} while iterating through pages.
55
+ # {Google::Cloud::Tasks::V2beta3::ListQueuesResponse#next_page_token next_page_token}
56
+ # returned from the previous call to
57
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListQueues ListQueues} method. It
58
+ # is an error to switch the value of the
59
+ # {Google::Cloud::Tasks::V2beta3::ListQueuesRequest#filter filter} while
60
+ # iterating through pages.
58
61
  class ListQueuesRequest; end
59
62
 
60
- # Response message for {Google::Cloud::Tasks::V2beta3::CloudTasks::ListQueues ListQueues}.
63
+ # Response message for
64
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListQueues ListQueues}.
61
65
  # @!attribute [rw] queues
62
66
  # @return [Array<Google::Cloud::Tasks::V2beta3::Queue>]
63
67
  # The list of queues.
@@ -66,7 +70,8 @@ module Google
66
70
  # A token to retrieve next page of results.
67
71
  #
68
72
  # To return the next page of results, call
69
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListQueues ListQueues} with this value as the
73
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListQueues ListQueues} with this
74
+ # value as the
70
75
  # {Google::Cloud::Tasks::V2beta3::ListQueuesRequest#page_token page_token}.
71
76
  #
72
77
  # If the next_page_token is empty, there are no more results.
@@ -74,7 +79,8 @@ module Google
74
79
  # The page token is valid for only 2 hours.
75
80
  class ListQueuesResponse; end
76
81
 
77
- # Request message for {Google::Cloud::Tasks::V2beta3::CloudTasks::GetQueue GetQueue}.
82
+ # Request message for
83
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::GetQueue GetQueue}.
78
84
  # @!attribute [rw] name
79
85
  # @return [String]
80
86
  # Required.
@@ -83,7 +89,8 @@ module Google
83
89
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
84
90
  class GetQueueRequest; end
85
91
 
86
- # Request message for {Google::Cloud::Tasks::V2beta3::CloudTasks::CreateQueue CreateQueue}.
92
+ # Request message for
93
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::CreateQueue CreateQueue}.
87
94
  # @!attribute [rw] parent
88
95
  # @return [String]
89
96
  # Required.
@@ -100,21 +107,25 @@ module Google
100
107
  #
101
108
  # The queue to create.
102
109
  #
103
- # {Google::Cloud::Tasks::V2beta3::Queue#name Queue's name} cannot be the same as an existing queue.
110
+ # {Google::Cloud::Tasks::V2beta3::Queue#name Queue's name} cannot be the same as
111
+ # an existing queue.
104
112
  class CreateQueueRequest; end
105
113
 
106
- # Request message for {Google::Cloud::Tasks::V2beta3::CloudTasks::UpdateQueue UpdateQueue}.
114
+ # Request message for
115
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::UpdateQueue UpdateQueue}.
107
116
  # @!attribute [rw] queue
108
117
  # @return [Google::Cloud::Tasks::V2beta3::Queue]
109
118
  # Required.
110
119
  #
111
120
  # The queue to create or update.
112
121
  #
113
- # The queue's {Google::Cloud::Tasks::V2beta3::Queue#name name} must be specified.
122
+ # The queue's {Google::Cloud::Tasks::V2beta3::Queue#name name} must be
123
+ # specified.
114
124
  #
115
125
  # Output only fields cannot be modified using UpdateQueue.
116
126
  # Any value specified for an output only field will be ignored.
117
- # The queue's {Google::Cloud::Tasks::V2beta3::Queue#name name} cannot be changed.
127
+ # The queue's {Google::Cloud::Tasks::V2beta3::Queue#name name} cannot be
128
+ # changed.
118
129
  # @!attribute [rw] update_mask
119
130
  # @return [Google::Protobuf::FieldMask]
120
131
  # A mask used to specify which fields of the queue are being updated.
@@ -122,7 +133,8 @@ module Google
122
133
  # If empty, then all fields will be updated.
123
134
  class UpdateQueueRequest; end
124
135
 
125
- # Request message for {Google::Cloud::Tasks::V2beta3::CloudTasks::DeleteQueue DeleteQueue}.
136
+ # Request message for
137
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::DeleteQueue DeleteQueue}.
126
138
  # @!attribute [rw] name
127
139
  # @return [String]
128
140
  # Required.
@@ -131,7 +143,8 @@ module Google
131
143
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
132
144
  class DeleteQueueRequest; end
133
145
 
134
- # Request message for {Google::Cloud::Tasks::V2beta3::CloudTasks::PurgeQueue PurgeQueue}.
146
+ # Request message for
147
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::PurgeQueue PurgeQueue}.
135
148
  # @!attribute [rw] name
136
149
  # @return [String]
137
150
  # Required.
@@ -140,7 +153,8 @@ module Google
140
153
  # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
141
154
  class PurgeQueueRequest; end
142
155
 
143
- # Request message for {Google::Cloud::Tasks::V2beta3::CloudTasks::PauseQueue PauseQueue}.
156
+ # Request message for
157
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::PauseQueue PauseQueue}.
144
158
  # @!attribute [rw] name
145
159
  # @return [String]
146
160
  # Required.
@@ -149,7 +163,8 @@ module Google
149
163
  # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
150
164
  class PauseQueueRequest; end
151
165
 
152
- # Request message for {Google::Cloud::Tasks::V2beta3::CloudTasks::ResumeQueue ResumeQueue}.
166
+ # Request message for
167
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::ResumeQueue ResumeQueue}.
153
168
  # @!attribute [rw] name
154
169
  # @return [String]
155
170
  # Required.
@@ -158,7 +173,8 @@ module Google
158
173
  # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
159
174
  class ResumeQueueRequest; end
160
175
 
161
- # Request message for listing tasks using {Google::Cloud::Tasks::V2beta3::CloudTasks::ListTasks ListTasks}.
176
+ # Request message for listing tasks using
177
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListTasks ListTasks}.
162
178
  # @!attribute [rw] parent
163
179
  # @return [String]
164
180
  # Required.
@@ -167,18 +183,19 @@ module Google
167
183
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
168
184
  # @!attribute [rw] response_view
169
185
  # @return [Google::Cloud::Tasks::V2beta3::Task::View]
170
- # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta3::Task Task} will be
171
- # returned.
172
- #
173
- # By default response_view is {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all
174
- # information is retrieved by default because some data, such as
175
- # payloads, might be desirable to return only when needed because
176
- # of its large size or because of the sensitivity of data that it
177
- # contains.
178
- #
179
- # Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} requires
180
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
181
- # permission on the {Google::Cloud::Tasks::V2beta3::Task Task} resource.
186
+ # The response_view specifies which subset of the
187
+ # {Google::Cloud::Tasks::V2beta3::Task Task} will be returned.
188
+ #
189
+ # By default response_view is
190
+ # {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all information is
191
+ # retrieved by default because some data, such as payloads, might be
192
+ # desirable to return only when needed because of its large size or because
193
+ # of the sensitivity of data that it contains.
194
+ #
195
+ # Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
196
+ # requires `cloudtasks.tasks.fullView` [Google
197
+ # IAM](https://cloud.google.com/iam/) permission on the
198
+ # {Google::Cloud::Tasks::V2beta3::Task Task} resource.
182
199
  # @!attribute [rw] page_size
183
200
  # @return [Integer]
184
201
  # Requested page size. Fewer tasks than requested might be returned.
@@ -186,22 +203,23 @@ module Google
186
203
  # The maximum page size is 1000. If unspecified, the page size will
187
204
  # be the maximum. Fewer tasks than requested might be returned,
188
205
  # even if more tasks exist; use
189
- # {Google::Cloud::Tasks::V2beta3::ListTasksResponse#next_page_token next_page_token} in the
190
- # response to determine if more tasks exist.
206
+ # {Google::Cloud::Tasks::V2beta3::ListTasksResponse#next_page_token next_page_token}
207
+ # in the response to determine if more tasks exist.
191
208
  # @!attribute [rw] page_token
192
209
  # @return [String]
193
210
  # A token identifying the page of results to return.
194
211
  #
195
212
  # To request the first page results, page_token must be empty. To
196
213
  # request the next page of results, page_token must be the value of
197
- # {Google::Cloud::Tasks::V2beta3::ListTasksResponse#next_page_token next_page_token} returned
198
- # from the previous call to {Google::Cloud::Tasks::V2beta3::CloudTasks::ListTasks ListTasks}
199
- # method.
214
+ # {Google::Cloud::Tasks::V2beta3::ListTasksResponse#next_page_token next_page_token}
215
+ # returned from the previous call to
216
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListTasks ListTasks} method.
200
217
  #
201
218
  # The page token is valid for only 2 hours.
202
219
  class ListTasksRequest; end
203
220
 
204
- # Response message for listing tasks using {Google::Cloud::Tasks::V2beta3::CloudTasks::ListTasks ListTasks}.
221
+ # Response message for listing tasks using
222
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListTasks ListTasks}.
205
223
  # @!attribute [rw] tasks
206
224
  # @return [Array<Google::Cloud::Tasks::V2beta3::Task>]
207
225
  # The list of tasks.
@@ -210,13 +228,15 @@ module Google
210
228
  # A token to retrieve next page of results.
211
229
  #
212
230
  # To return the next page of results, call
213
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListTasks ListTasks} with this value as the
231
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListTasks ListTasks} with this
232
+ # value as the
214
233
  # {Google::Cloud::Tasks::V2beta3::ListTasksRequest#page_token page_token}.
215
234
  #
216
235
  # If the next_page_token is empty, there are no more results.
217
236
  class ListTasksResponse; end
218
237
 
219
- # Request message for getting a task using {Google::Cloud::Tasks::V2beta3::CloudTasks::GetTask GetTask}.
238
+ # Request message for getting a task using
239
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::GetTask GetTask}.
220
240
  # @!attribute [rw] name
221
241
  # @return [String]
222
242
  # Required.
@@ -225,21 +245,23 @@ module Google
225
245
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
226
246
  # @!attribute [rw] response_view
227
247
  # @return [Google::Cloud::Tasks::V2beta3::Task::View]
228
- # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta3::Task Task} will be
229
- # returned.
230
- #
231
- # By default response_view is {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all
232
- # information is retrieved by default because some data, such as
233
- # payloads, might be desirable to return only when needed because
234
- # of its large size or because of the sensitivity of data that it
235
- # contains.
236
- #
237
- # Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} requires
238
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
239
- # permission on the {Google::Cloud::Tasks::V2beta3::Task Task} resource.
248
+ # The response_view specifies which subset of the
249
+ # {Google::Cloud::Tasks::V2beta3::Task Task} will be returned.
250
+ #
251
+ # By default response_view is
252
+ # {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all information is
253
+ # retrieved by default because some data, such as payloads, might be
254
+ # desirable to return only when needed because of its large size or because
255
+ # of the sensitivity of data that it contains.
256
+ #
257
+ # Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
258
+ # requires `cloudtasks.tasks.fullView` [Google
259
+ # IAM](https://cloud.google.com/iam/) permission on the
260
+ # {Google::Cloud::Tasks::V2beta3::Task Task} resource.
240
261
  class GetTaskRequest; end
241
262
 
242
- # Request message for {Google::Cloud::Tasks::V2beta3::CloudTasks::CreateTask CreateTask}.
263
+ # Request message for
264
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::CreateTask CreateTask}.
243
265
  # @!attribute [rw] parent
244
266
  # @return [String]
245
267
  # Required.
@@ -256,13 +278,13 @@ module Google
256
278
  #
257
279
  # Task names have the following format:
258
280
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
259
- # The user can optionally specify a task {Google::Cloud::Tasks::V2beta3::Task#name name}. If a
260
- # name is not specified then the system will generate a random
261
- # unique task id, which will be set in the task returned in the
262
- # {Google::Cloud::Tasks::V2beta3::Task#name response}.
281
+ # The user can optionally specify a task
282
+ # {Google::Cloud::Tasks::V2beta3::Task#name name}. If a name is not specified
283
+ # then the system will generate a random unique task id, which will be set in
284
+ # the task returned in the {Google::Cloud::Tasks::V2beta3::Task#name response}.
263
285
  #
264
- # If {Google::Cloud::Tasks::V2beta3::Task#schedule_time schedule_time} is not set or is in the
265
- # past then Cloud Tasks will set it to the current time.
286
+ # If {Google::Cloud::Tasks::V2beta3::Task#schedule_time schedule_time} is not
287
+ # set or is in the past then Cloud Tasks will set it to the current time.
266
288
  #
267
289
  # Task De-duplication:
268
290
  #
@@ -277,28 +299,29 @@ module Google
277
299
  # for ~9days after the original task was deleted or executed.
278
300
  #
279
301
  # Because there is an extra lookup cost to identify duplicate task
280
- # names, these {Google::Cloud::Tasks::V2beta3::CloudTasks::CreateTask CreateTask} calls have significantly
281
- # increased latency. Using hashed strings for the task id or for
282
- # the prefix of the task id is recommended. Choosing task ids that
283
- # are sequential or have sequential prefixes, for example using a
302
+ # names, these {Google::Cloud::Tasks::V2beta3::CloudTasks::CreateTask CreateTask}
303
+ # calls have significantly increased latency. Using hashed strings for the
304
+ # task id or for the prefix of the task id is recommended. Choosing task ids
305
+ # that are sequential or have sequential prefixes, for example using a
284
306
  # timestamp, causes an increase in latency and error rates in all
285
307
  # task commands. The infrastructure relies on an approximately
286
308
  # uniform distribution of task ids to store and serve tasks
287
309
  # efficiently.
288
310
  # @!attribute [rw] response_view
289
311
  # @return [Google::Cloud::Tasks::V2beta3::Task::View]
290
- # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta3::Task Task} will be
291
- # returned.
292
- #
293
- # By default response_view is {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all
294
- # information is retrieved by default because some data, such as
295
- # payloads, might be desirable to return only when needed because
296
- # of its large size or because of the sensitivity of data that it
297
- # contains.
298
- #
299
- # Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} requires
300
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
301
- # permission on the {Google::Cloud::Tasks::V2beta3::Task Task} resource.
312
+ # The response_view specifies which subset of the
313
+ # {Google::Cloud::Tasks::V2beta3::Task Task} will be returned.
314
+ #
315
+ # By default response_view is
316
+ # {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all information is
317
+ # retrieved by default because some data, such as payloads, might be
318
+ # desirable to return only when needed because of its large size or because
319
+ # of the sensitivity of data that it contains.
320
+ #
321
+ # Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
322
+ # requires `cloudtasks.tasks.fullView` [Google
323
+ # IAM](https://cloud.google.com/iam/) permission on the
324
+ # {Google::Cloud::Tasks::V2beta3::Task Task} resource.
302
325
  class CreateTaskRequest; end
303
326
 
304
327
  # Request message for deleting a task using
@@ -321,18 +344,19 @@ module Google
321
344
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
322
345
  # @!attribute [rw] response_view
323
346
  # @return [Google::Cloud::Tasks::V2beta3::Task::View]
324
- # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta3::Task Task} will be
325
- # returned.
326
- #
327
- # By default response_view is {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all
328
- # information is retrieved by default because some data, such as
329
- # payloads, might be desirable to return only when needed because
330
- # of its large size or because of the sensitivity of data that it
331
- # contains.
332
- #
333
- # Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} requires
334
- # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
335
- # permission on the {Google::Cloud::Tasks::V2beta3::Task Task} resource.
347
+ # The response_view specifies which subset of the
348
+ # {Google::Cloud::Tasks::V2beta3::Task Task} will be returned.
349
+ #
350
+ # By default response_view is
351
+ # {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all information is
352
+ # retrieved by default because some data, such as payloads, might be
353
+ # desirable to return only when needed because of its large size or because
354
+ # of the sensitivity of data that it contains.
355
+ #
356
+ # Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
357
+ # requires `cloudtasks.tasks.fullView` [Google
358
+ # IAM](https://cloud.google.com/iam/) permission on the
359
+ # {Google::Cloud::Tasks::V2beta3::Task Task} resource.
336
360
  class RunTaskRequest; end
337
361
  end
338
362
  end