google-cloud-tasks 1.1.0 → 1.1.1
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.
- checksums.yaml +4 -4
- data/README.md +3 -3
- data/lib/google/cloud/tasks.rb +2 -2
- data/lib/google/cloud/tasks/v2.rb +2 -2
- data/lib/google/cloud/tasks/v2/cloud_tasks_client.rb +15 -45
- data/lib/google/cloud/tasks/v2/cloudtasks_pb.rb +2 -1
- data/lib/google/cloud/tasks/v2/doc/google/cloud/tasks/v2/cloudtasks.rb +15 -45
- data/lib/google/cloud/tasks/v2/doc/google/cloud/tasks/v2/queue.rb +2 -3
- data/lib/google/cloud/tasks/v2/doc/google/cloud/tasks/v2/target.rb +16 -10
- data/lib/google/cloud/tasks/v2/doc/google/cloud/tasks/v2/task.rb +1 -3
- data/lib/google/cloud/tasks/v2/doc/google/iam/v1/policy.rb +2 -2
- data/lib/google/cloud/tasks/v2/queue_pb.rb +1 -1
- data/lib/google/cloud/tasks/v2/task_pb.rb +1 -1
- data/lib/google/cloud/tasks/v2beta2.rb +2 -2
- data/lib/google/cloud/tasks/v2beta2/cloud_tasks_client.rb +211 -267
- data/lib/google/cloud/tasks/v2beta2/cloudtasks_pb.rb +3 -1
- data/lib/google/cloud/tasks/v2beta2/cloudtasks_services_pb.rb +58 -69
- data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb +188 -250
- data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/queue.rb +57 -81
- data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/target.rb +86 -89
- data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/task.rb +25 -42
- data/lib/google/cloud/tasks/v2beta2/doc/google/iam/v1/policy.rb +2 -2
- data/lib/google/cloud/tasks/v2beta2/queue_pb.rb +2 -1
- data/lib/google/cloud/tasks/v2beta2/target_pb.rb +0 -1
- data/lib/google/cloud/tasks/v2beta2/task_pb.rb +2 -1
- data/lib/google/cloud/tasks/v2beta3.rb +2 -2
- data/lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb +15 -45
- data/lib/google/cloud/tasks/v2beta3/cloudtasks_pb.rb +2 -1
- data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/cloudtasks.rb +15 -45
- data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/target.rb +5 -5
- data/lib/google/cloud/tasks/v2beta3/doc/google/iam/v1/policy.rb +2 -2
- data/lib/google/cloud/tasks/v2beta3/queue_pb.rb +1 -1
- data/lib/google/cloud/tasks/v2beta3/task_pb.rb +1 -1
- data/lib/google/cloud/tasks/version.rb +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 07063017ddc2c5f294c92738e866194e62fc147613af5cb948d80896fefb050c
|
4
|
+
data.tar.gz: 4142af8246017146d7ad67e50d934b247df1ef68a16e1f3028034775ffaa09cf
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 24dbec2fe9eba337408d29e63b68de903f135fadbfd89a92ad630b3da4e8c57aa2b8c73115cf1f4953369d34873be9fdf6ce3537e4970241a9edfb3b1d01815d
|
7
|
+
data.tar.gz: 1ed6c801a5d45a2b6022e2adaf1012b144d42c3ed29a002e4b28843208323b6c77918c2dd49e754fab3adbf78b5df7356c2e964bb2537925db90cd5568953c56
|
data/README.md
CHANGED
@@ -12,7 +12,7 @@ steps:
|
|
12
12
|
1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
13
13
|
2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
|
14
14
|
3. [Enable the Cloud Tasks API.](https://console.cloud.google.com/apis/library/tasks.googleapis.com)
|
15
|
-
4. [Setup Authentication.](https://googleapis.
|
15
|
+
4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-tasks/latest/file.AUTHENTICATION.html)
|
16
16
|
|
17
17
|
### Installation
|
18
18
|
```
|
@@ -27,14 +27,14 @@ $ gem install google-cloud-tasks
|
|
27
27
|
- View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
|
28
28
|
to see the full list of Cloud APIs that we cover.
|
29
29
|
|
30
|
-
[Client Library Documentation]: https://googleapis.
|
30
|
+
[Client Library Documentation]: https://googleapis.dev/ruby/google-cloud-tasks/latest
|
31
31
|
[Product Documentation]: https://cloud.google.com/tasks
|
32
32
|
|
33
33
|
## Enabling Logging
|
34
34
|
|
35
35
|
To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
36
36
|
The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
|
37
|
-
or a [`Google::Cloud::Logging::Logger`](https://googleapis.
|
37
|
+
or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
|
38
38
|
that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
|
39
39
|
and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
40
40
|
|
data/lib/google/cloud/tasks.rb
CHANGED
@@ -34,7 +34,7 @@ module Google
|
|
34
34
|
# 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
35
35
|
# 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
|
36
36
|
# 3. [Enable the Cloud Tasks API.](https://console.cloud.google.com/apis/library/tasks.googleapis.com)
|
37
|
-
# 4. [Setup Authentication.](https://googleapis.
|
37
|
+
# 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-tasks/latest/file.AUTHENTICATION.html)
|
38
38
|
#
|
39
39
|
# ### Installation
|
40
40
|
# ```
|
@@ -53,7 +53,7 @@ module Google
|
|
53
53
|
#
|
54
54
|
# To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
55
55
|
# The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
|
56
|
-
# or a [`Google::Cloud::Logging::Logger`](https://googleapis.
|
56
|
+
# or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
|
57
57
|
# that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
|
58
58
|
# and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
59
59
|
#
|
@@ -35,7 +35,7 @@ module Google
|
|
35
35
|
# 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
36
36
|
# 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
|
37
37
|
# 3. [Enable the Cloud Tasks API.](https://console.cloud.google.com/apis/library/tasks.googleapis.com)
|
38
|
-
# 4. [Setup Authentication.](https://googleapis.
|
38
|
+
# 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-tasks/latest/file.AUTHENTICATION.html)
|
39
39
|
#
|
40
40
|
# ### Installation
|
41
41
|
# ```
|
@@ -54,7 +54,7 @@ module Google
|
|
54
54
|
#
|
55
55
|
# To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
56
56
|
# The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
|
57
|
-
# or a [`Google::Cloud::Logging::Logger`](https://googleapis.
|
57
|
+
# or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
|
58
58
|
# that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
|
59
59
|
# and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
60
60
|
#
|
@@ -391,9 +391,7 @@ module Google
|
|
391
391
|
# Queues are returned in lexicographical order.
|
392
392
|
#
|
393
393
|
# @param parent [String]
|
394
|
-
# Required.
|
395
|
-
#
|
396
|
-
# The location name.
|
394
|
+
# Required. The location name.
|
397
395
|
# For example: `projects/PROJECT_ID/locations/LOCATION_ID`
|
398
396
|
# @param filter [String]
|
399
397
|
# `filter` can be used to specify a subset of queues. Any {Google::Cloud::Tasks::V2::Queue Queue}
|
@@ -462,9 +460,7 @@ module Google
|
|
462
460
|
# Gets a queue.
|
463
461
|
#
|
464
462
|
# @param name [String]
|
465
|
-
# Required.
|
466
|
-
#
|
467
|
-
# The resource name of the queue. For example:
|
463
|
+
# Required. The resource name of the queue. For example:
|
468
464
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
469
465
|
# @param options [Google::Gax::CallOptions]
|
470
466
|
# Overrides the default settings for this call, e.g, timeout,
|
@@ -506,18 +502,14 @@ module Google
|
|
506
502
|
# this method.
|
507
503
|
#
|
508
504
|
# @param parent [String]
|
509
|
-
# Required.
|
510
|
-
#
|
511
|
-
# The location name in which the queue will be created.
|
505
|
+
# Required. The location name in which the queue will be created.
|
512
506
|
# For example: `projects/PROJECT_ID/locations/LOCATION_ID`
|
513
507
|
#
|
514
508
|
# The list of allowed locations can be obtained by calling Cloud
|
515
509
|
# Tasks' implementation of
|
516
510
|
# {Google::Cloud::Location::Locations::ListLocations ListLocations}.
|
517
511
|
# @param queue [Google::Cloud::Tasks::V2::Queue | Hash]
|
518
|
-
# Required.
|
519
|
-
#
|
520
|
-
# The queue to create.
|
512
|
+
# Required. The queue to create.
|
521
513
|
#
|
522
514
|
# {Google::Cloud::Tasks::V2::Queue#name Queue's name} cannot be the same as an existing queue.
|
523
515
|
# A hash of the same form as `Google::Cloud::Tasks::V2::Queue`
|
@@ -570,9 +562,7 @@ module Google
|
|
570
562
|
# this method.
|
571
563
|
#
|
572
564
|
# @param queue [Google::Cloud::Tasks::V2::Queue | Hash]
|
573
|
-
# Required.
|
574
|
-
#
|
575
|
-
# The queue to create or update.
|
565
|
+
# Required. The queue to create or update.
|
576
566
|
#
|
577
567
|
# The queue's {Google::Cloud::Tasks::V2::Queue#name name} must be specified.
|
578
568
|
#
|
@@ -632,9 +622,7 @@ module Google
|
|
632
622
|
# this method.
|
633
623
|
#
|
634
624
|
# @param name [String]
|
635
|
-
# Required.
|
636
|
-
#
|
637
|
-
# The queue name. For example:
|
625
|
+
# Required. The queue name. For example:
|
638
626
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
639
627
|
# @param options [Google::Gax::CallOptions]
|
640
628
|
# Overrides the default settings for this call, e.g, timeout,
|
@@ -670,9 +658,7 @@ module Google
|
|
670
658
|
# might be dispatched before the purge takes effect. A purge is irreversible.
|
671
659
|
#
|
672
660
|
# @param name [String]
|
673
|
-
# Required.
|
674
|
-
#
|
675
|
-
# The queue name. For example:
|
661
|
+
# Required. The queue name. For example:
|
676
662
|
# `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
|
677
663
|
# @param options [Google::Gax::CallOptions]
|
678
664
|
# Overrides the default settings for this call, e.g, timeout,
|
@@ -709,9 +695,7 @@ module Google
|
|
709
695
|
# {Google::Cloud::Tasks::V2::Queue#state state} is {Google::Cloud::Tasks::V2::Queue::State::PAUSED PAUSED}.
|
710
696
|
#
|
711
697
|
# @param name [String]
|
712
|
-
# Required.
|
713
|
-
#
|
714
|
-
# The queue name. For example:
|
698
|
+
# Required. The queue name. For example:
|
715
699
|
# `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
|
716
700
|
# @param options [Google::Gax::CallOptions]
|
717
701
|
# Overrides the default settings for this call, e.g, timeout,
|
@@ -754,9 +738,7 @@ module Google
|
|
754
738
|
# Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
|
755
739
|
#
|
756
740
|
# @param name [String]
|
757
|
-
# Required.
|
758
|
-
#
|
759
|
-
# The queue name. For example:
|
741
|
+
# Required. The queue name. For example:
|
760
742
|
# `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
|
761
743
|
# @param options [Google::Gax::CallOptions]
|
762
744
|
# Overrides the default settings for this call, e.g, timeout,
|
@@ -941,9 +923,7 @@ module Google
|
|
941
923
|
# time.
|
942
924
|
#
|
943
925
|
# @param parent [String]
|
944
|
-
# Required.
|
945
|
-
#
|
946
|
-
# The queue name. For example:
|
926
|
+
# Required. The queue name. For example:
|
947
927
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
948
928
|
# @param response_view [Google::Cloud::Tasks::V2::Task::View]
|
949
929
|
# The response_view specifies which subset of the {Google::Cloud::Tasks::V2::Task Task} will be
|
@@ -1013,9 +993,7 @@ module Google
|
|
1013
993
|
# Gets a task.
|
1014
994
|
#
|
1015
995
|
# @param name [String]
|
1016
|
-
# Required.
|
1017
|
-
#
|
1018
|
-
# The task name. For example:
|
996
|
+
# Required. The task name. For example:
|
1019
997
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
1020
998
|
# @param response_view [Google::Cloud::Tasks::V2::Task::View]
|
1021
999
|
# The response_view specifies which subset of the {Google::Cloud::Tasks::V2::Task Task} will be
|
@@ -1065,16 +1043,12 @@ module Google
|
|
1065
1043
|
# * The maximum task size is 100KB.
|
1066
1044
|
#
|
1067
1045
|
# @param parent [String]
|
1068
|
-
# Required.
|
1069
|
-
#
|
1070
|
-
# The queue name. For example:
|
1046
|
+
# Required. The queue name. For example:
|
1071
1047
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
1072
1048
|
#
|
1073
1049
|
# The queue must already exist.
|
1074
1050
|
# @param task [Google::Cloud::Tasks::V2::Task | Hash]
|
1075
|
-
# Required.
|
1076
|
-
#
|
1077
|
-
# The task to add.
|
1051
|
+
# Required. The task to add.
|
1078
1052
|
#
|
1079
1053
|
# Task names have the following format:
|
1080
1054
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
|
@@ -1162,9 +1136,7 @@ module Google
|
|
1162
1136
|
# failed.
|
1163
1137
|
#
|
1164
1138
|
# @param name [String]
|
1165
|
-
# Required.
|
1166
|
-
#
|
1167
|
-
# The task name. For example:
|
1139
|
+
# Required. The task name. For example:
|
1168
1140
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
1169
1141
|
# @param options [Google::Gax::CallOptions]
|
1170
1142
|
# Overrides the default settings for this call, e.g, timeout,
|
@@ -1218,9 +1190,7 @@ module Google
|
|
1218
1190
|
# task that has already succeeded or permanently failed.
|
1219
1191
|
#
|
1220
1192
|
# @param name [String]
|
1221
|
-
# Required.
|
1222
|
-
#
|
1223
|
-
# The task name. For example:
|
1193
|
+
# Required. The task name. For example:
|
1224
1194
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
1225
1195
|
# @param response_view [Google::Cloud::Tasks::V2::Task::View]
|
1226
1196
|
# The response_view specifies which subset of the {Google::Cloud::Tasks::V2::Task Task} will be
|
@@ -5,13 +5,14 @@
|
|
5
5
|
require 'google/protobuf'
|
6
6
|
|
7
7
|
require 'google/api/annotations_pb'
|
8
|
+
require 'google/api/client_pb'
|
9
|
+
require 'google/api/field_behavior_pb'
|
8
10
|
require 'google/cloud/tasks/v2/queue_pb'
|
9
11
|
require 'google/cloud/tasks/v2/task_pb'
|
10
12
|
require 'google/iam/v1/iam_policy_pb'
|
11
13
|
require 'google/iam/v1/policy_pb'
|
12
14
|
require 'google/protobuf/empty_pb'
|
13
15
|
require 'google/protobuf/field_mask_pb'
|
14
|
-
require 'google/rpc/code_pb'
|
15
16
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
16
17
|
add_message "google.cloud.tasks.v2.ListQueuesRequest" do
|
17
18
|
optional :parent, :string, 1
|
@@ -20,9 +20,7 @@ module Google
|
|
20
20
|
# Request message for {Google::Cloud::Tasks::V2::CloudTasks::ListQueues ListQueues}.
|
21
21
|
# @!attribute [rw] parent
|
22
22
|
# @return [String]
|
23
|
-
# Required.
|
24
|
-
#
|
25
|
-
# The location name.
|
23
|
+
# Required. The location name.
|
26
24
|
# For example: `projects/PROJECT_ID/locations/LOCATION_ID`
|
27
25
|
# @!attribute [rw] filter
|
28
26
|
# @return [String]
|
@@ -78,18 +76,14 @@ module Google
|
|
78
76
|
# Request message for {Google::Cloud::Tasks::V2::CloudTasks::GetQueue GetQueue}.
|
79
77
|
# @!attribute [rw] name
|
80
78
|
# @return [String]
|
81
|
-
# Required.
|
82
|
-
#
|
83
|
-
# The resource name of the queue. For example:
|
79
|
+
# Required. The resource name of the queue. For example:
|
84
80
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
85
81
|
class GetQueueRequest; end
|
86
82
|
|
87
83
|
# Request message for {Google::Cloud::Tasks::V2::CloudTasks::CreateQueue CreateQueue}.
|
88
84
|
# @!attribute [rw] parent
|
89
85
|
# @return [String]
|
90
|
-
# Required.
|
91
|
-
#
|
92
|
-
# The location name in which the queue will be created.
|
86
|
+
# Required. The location name in which the queue will be created.
|
93
87
|
# For example: `projects/PROJECT_ID/locations/LOCATION_ID`
|
94
88
|
#
|
95
89
|
# The list of allowed locations can be obtained by calling Cloud
|
@@ -97,9 +91,7 @@ module Google
|
|
97
91
|
# {Google::Cloud::Location::Locations::ListLocations ListLocations}.
|
98
92
|
# @!attribute [rw] queue
|
99
93
|
# @return [Google::Cloud::Tasks::V2::Queue]
|
100
|
-
# Required.
|
101
|
-
#
|
102
|
-
# The queue to create.
|
94
|
+
# Required. The queue to create.
|
103
95
|
#
|
104
96
|
# {Google::Cloud::Tasks::V2::Queue#name Queue's name} cannot be the same as an existing queue.
|
105
97
|
class CreateQueueRequest; end
|
@@ -107,9 +99,7 @@ module Google
|
|
107
99
|
# Request message for {Google::Cloud::Tasks::V2::CloudTasks::UpdateQueue UpdateQueue}.
|
108
100
|
# @!attribute [rw] queue
|
109
101
|
# @return [Google::Cloud::Tasks::V2::Queue]
|
110
|
-
# Required.
|
111
|
-
#
|
112
|
-
# The queue to create or update.
|
102
|
+
# Required. The queue to create or update.
|
113
103
|
#
|
114
104
|
# The queue's {Google::Cloud::Tasks::V2::Queue#name name} must be specified.
|
115
105
|
#
|
@@ -126,45 +116,35 @@ module Google
|
|
126
116
|
# Request message for {Google::Cloud::Tasks::V2::CloudTasks::DeleteQueue DeleteQueue}.
|
127
117
|
# @!attribute [rw] name
|
128
118
|
# @return [String]
|
129
|
-
# Required.
|
130
|
-
#
|
131
|
-
# The queue name. For example:
|
119
|
+
# Required. The queue name. For example:
|
132
120
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
133
121
|
class DeleteQueueRequest; end
|
134
122
|
|
135
123
|
# Request message for {Google::Cloud::Tasks::V2::CloudTasks::PurgeQueue PurgeQueue}.
|
136
124
|
# @!attribute [rw] name
|
137
125
|
# @return [String]
|
138
|
-
# Required.
|
139
|
-
#
|
140
|
-
# The queue name. For example:
|
126
|
+
# Required. The queue name. For example:
|
141
127
|
# `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
|
142
128
|
class PurgeQueueRequest; end
|
143
129
|
|
144
130
|
# Request message for {Google::Cloud::Tasks::V2::CloudTasks::PauseQueue PauseQueue}.
|
145
131
|
# @!attribute [rw] name
|
146
132
|
# @return [String]
|
147
|
-
# Required.
|
148
|
-
#
|
149
|
-
# The queue name. For example:
|
133
|
+
# Required. The queue name. For example:
|
150
134
|
# `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
|
151
135
|
class PauseQueueRequest; end
|
152
136
|
|
153
137
|
# Request message for {Google::Cloud::Tasks::V2::CloudTasks::ResumeQueue ResumeQueue}.
|
154
138
|
# @!attribute [rw] name
|
155
139
|
# @return [String]
|
156
|
-
# Required.
|
157
|
-
#
|
158
|
-
# The queue name. For example:
|
140
|
+
# Required. The queue name. For example:
|
159
141
|
# `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
|
160
142
|
class ResumeQueueRequest; end
|
161
143
|
|
162
144
|
# Request message for listing tasks using {Google::Cloud::Tasks::V2::CloudTasks::ListTasks ListTasks}.
|
163
145
|
# @!attribute [rw] parent
|
164
146
|
# @return [String]
|
165
|
-
# Required.
|
166
|
-
#
|
167
|
-
# The queue name. For example:
|
147
|
+
# Required. The queue name. For example:
|
168
148
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
169
149
|
# @!attribute [rw] response_view
|
170
150
|
# @return [Google::Cloud::Tasks::V2::Task::View]
|
@@ -221,9 +201,7 @@ module Google
|
|
221
201
|
# Request message for getting a task using {Google::Cloud::Tasks::V2::CloudTasks::GetTask GetTask}.
|
222
202
|
# @!attribute [rw] name
|
223
203
|
# @return [String]
|
224
|
-
# Required.
|
225
|
-
#
|
226
|
-
# The task name. For example:
|
204
|
+
# Required. The task name. For example:
|
227
205
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
228
206
|
# @!attribute [rw] response_view
|
229
207
|
# @return [Google::Cloud::Tasks::V2::Task::View]
|
@@ -244,17 +222,13 @@ module Google
|
|
244
222
|
# Request message for {Google::Cloud::Tasks::V2::CloudTasks::CreateTask CreateTask}.
|
245
223
|
# @!attribute [rw] parent
|
246
224
|
# @return [String]
|
247
|
-
# Required.
|
248
|
-
#
|
249
|
-
# The queue name. For example:
|
225
|
+
# Required. The queue name. For example:
|
250
226
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
251
227
|
#
|
252
228
|
# The queue must already exist.
|
253
229
|
# @!attribute [rw] task
|
254
230
|
# @return [Google::Cloud::Tasks::V2::Task]
|
255
|
-
# Required.
|
256
|
-
#
|
257
|
-
# The task to add.
|
231
|
+
# Required. The task to add.
|
258
232
|
#
|
259
233
|
# Task names have the following format:
|
260
234
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
|
@@ -307,9 +281,7 @@ module Google
|
|
307
281
|
# {Google::Cloud::Tasks::V2::CloudTasks::DeleteTask DeleteTask}.
|
308
282
|
# @!attribute [rw] name
|
309
283
|
# @return [String]
|
310
|
-
# Required.
|
311
|
-
#
|
312
|
-
# The task name. For example:
|
284
|
+
# Required. The task name. For example:
|
313
285
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
314
286
|
class DeleteTaskRequest; end
|
315
287
|
|
@@ -317,9 +289,7 @@ module Google
|
|
317
289
|
# {Google::Cloud::Tasks::V2::CloudTasks::RunTask RunTask}.
|
318
290
|
# @!attribute [rw] name
|
319
291
|
# @return [String]
|
320
|
-
# Required.
|
321
|
-
#
|
322
|
-
# The task name. For example:
|
292
|
+
# Required. The task name. For example:
|
323
293
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
324
294
|
# @!attribute [rw] response_view
|
325
295
|
# @return [Google::Cloud::Tasks::V2::Task::View]
|
@@ -165,8 +165,7 @@ module Google
|
|
165
165
|
# If unspecified when the queue is created, Cloud Tasks will pick the
|
166
166
|
# default.
|
167
167
|
#
|
168
|
-
# *
|
169
|
-
# is 500.
|
168
|
+
# * The maximum allowed value is 500.
|
170
169
|
#
|
171
170
|
#
|
172
171
|
# This field has the same meaning as
|
@@ -195,7 +194,7 @@ module Google
|
|
195
194
|
# value of
|
196
195
|
# {Google::Cloud::Tasks::V2::RateLimits#max_dispatches_per_second max_dispatches_per_second}.
|
197
196
|
#
|
198
|
-
# For
|
197
|
+
# For queues that were created or updated using
|
199
198
|
# `queue.yaml/xml`, `max_burst_size` is equal to
|
200
199
|
# [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
|
201
200
|
# Since `max_burst_size` is output only, if
|
@@ -45,11 +45,10 @@ module Google
|
|
45
45
|
# The {Google::Cloud::Tasks::V2::AppEngineRouting AppEngineRouting} used to construct the URL that the task is
|
46
46
|
# delivered to can be set at the queue-level or task-level:
|
47
47
|
#
|
48
|
-
# * If set
|
49
|
-
#
|
50
|
-
#
|
51
|
-
#
|
52
|
-
# {Google::Cloud::Tasks::V2::AppEngineHttpRequest#app_engine_routing task-level app_engine_routing}.
|
48
|
+
# * If [app_engine_routing_override is set on the
|
49
|
+
# queue][Queue.app_engine_routing_override], this value is used for all
|
50
|
+
# tasks in the queue, no matter what the setting is for the [task-level
|
51
|
+
# app_engine_routing][AppEngineHttpRequest.app_engine_routing].
|
53
52
|
#
|
54
53
|
#
|
55
54
|
# The `url` that the task will be sent to is:
|
@@ -72,7 +71,7 @@ module Google
|
|
72
71
|
# the app's handler returns a non-2xx response code or Cloud Tasks does
|
73
72
|
# not receive response before the {Google::Cloud::Tasks::V2::Task#dispatch_deadline deadline}. Failed
|
74
73
|
# tasks will be retried according to the
|
75
|
-
# {Queue
|
74
|
+
# {Google::Cloud::Tasks::V2::Queue#retry_config retry configuration}. `503` (Service Unavailable) is
|
76
75
|
# considered an App Engine system error instead of an application error and
|
77
76
|
# will cause Cloud Tasks' traffic congestion control to temporarily throttle
|
78
77
|
# the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
|
@@ -95,10 +94,10 @@ module Google
|
|
95
94
|
# @return [Google::Cloud::Tasks::V2::AppEngineRouting]
|
96
95
|
# Task-level setting for App Engine routing.
|
97
96
|
#
|
98
|
-
# If set
|
99
|
-
#
|
100
|
-
#
|
101
|
-
#
|
97
|
+
# * If [app_engine_routing_override is set on the
|
98
|
+
# queue][Queue.app_engine_routing_override], this value is used for all
|
99
|
+
# tasks in the queue, no matter what the setting is for the [task-level
|
100
|
+
# app_engine_routing][AppEngineHttpRequest.app_engine_routing].
|
102
101
|
# @!attribute [rw] relative_uri
|
103
102
|
# @return [String]
|
104
103
|
# The relative URI.
|
@@ -173,6 +172,13 @@ module Google
|
|
173
172
|
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
|
174
173
|
# and [App Engine Flex request
|
175
174
|
# routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
|
175
|
+
#
|
176
|
+
# Using {Google::Cloud::Tasks::V2::AppEngineRouting AppEngineRouting} requires
|
177
|
+
# [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
|
178
|
+
# Google IAM permission for the project
|
179
|
+
# and the following scope:
|
180
|
+
#
|
181
|
+
# `https://www.googleapis.com/auth/cloud-platform`
|
176
182
|
# @!attribute [rw] service
|
177
183
|
# @return [String]
|
178
184
|
# App service.
|