google-cloud-tasks-v2 0.2.1 → 0.2.6

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8a6fc1cfb392a1ac362dc26dec564a2e502678d0eda9e82f6d135b0957ddeae3
4
- data.tar.gz: 35893d17d12498d4f5a9fd4ff3f40482b04ae818941a28a5e754141d6c5f4544
3
+ metadata.gz: de446c07d14f4d3d06fa42eca07d0bc29d9e583addfb0485a4ce83aa9d0d724e
4
+ data.tar.gz: 90ca5383440f32fc8575158ca4ab7d20e87ac9e5be6b145692c8e281be2b936e
5
5
  SHA512:
6
- metadata.gz: bfc7eb1436b9ac28c029045e96dffa525716ad1a4cf2a415121f5523453b03cb6e9961b8b13b62e540676ae1ea8fd4c8ad5aac5c4915bfde23fd8a681e8ebbfc
7
- data.tar.gz: 41624fc4eb4195da991a8bf34a460b6b217e28c5cf9db87aff967f174b3997a7a70c2b59bd717f8d03fd701a45ebbe7dad465b2699589af65bd5308fdbce9fad
6
+ metadata.gz: '0841bf72681ef49d31dcc569a007b82c21f3ddabf350b472a9566f825d26846f9a04adf373847eabf344c90ef1d0bc3f24fdf5ad473e1b76dcc639ce23968769'
7
+ data.tar.gz: 6eba7a3a6538eb6304865004a879ed1b12d036b2971c1bb0a9dc4b196be5f6114fc949949daab563929d7784f43899ca4868ac113ec2e5f5a8efcd5d82b744e9
data/README.md CHANGED
@@ -18,6 +18,7 @@ In order to use this library, you first need to go through the following steps:
18
18
 
19
19
  1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
20
20
  1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
21
+ 1. [Enable the API.](https://console.cloud.google.com/apis/library/cloudtasks.googleapis.com)
21
22
  1. {file:AUTHENTICATION.md Set up authentication.}
22
23
 
23
24
  ## Quick Start
@@ -33,6 +34,9 @@ response = client.list_queues request
33
34
  View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-tasks-v2/latest)
34
35
  for class and method documentation.
35
36
 
37
+ See also the [Product Documentation](https://cloud.google.com/tasks)
38
+ for general usage information.
39
+
36
40
  ## Enabling Logging
37
41
 
38
42
  To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
@@ -33,3 +33,6 @@ module Google
33
33
  end
34
34
  end
35
35
  end
36
+
37
+ helper_path = ::File.join __dir__, "v2", "_helpers.rb"
38
+ require "google/cloud/tasks/v2/_helpers" if ::File.file? helper_path
@@ -71,7 +71,7 @@ module Google
71
71
  initial_delay: 0.1,
72
72
  max_delay: 10.0,
73
73
  multiplier: 1.3,
74
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
74
+ retry_codes: [4, 14]
75
75
  }
76
76
 
77
77
  default_config.rpcs.get_queue.timeout = 10.0
@@ -79,7 +79,7 @@ module Google
79
79
  initial_delay: 0.1,
80
80
  max_delay: 10.0,
81
81
  multiplier: 1.3,
82
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
82
+ retry_codes: [4, 14]
83
83
  }
84
84
 
85
85
  default_config.rpcs.create_queue.timeout = 10.0
@@ -91,7 +91,7 @@ module Google
91
91
  initial_delay: 0.1,
92
92
  max_delay: 10.0,
93
93
  multiplier: 1.3,
94
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
94
+ retry_codes: [4, 14]
95
95
  }
96
96
 
97
97
  default_config.rpcs.purge_queue.timeout = 10.0
@@ -105,7 +105,7 @@ module Google
105
105
  initial_delay: 0.1,
106
106
  max_delay: 10.0,
107
107
  multiplier: 1.3,
108
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
108
+ retry_codes: [4, 14]
109
109
  }
110
110
 
111
111
  default_config.rpcs.set_iam_policy.timeout = 10.0
@@ -115,7 +115,7 @@ module Google
115
115
  initial_delay: 0.1,
116
116
  max_delay: 10.0,
117
117
  multiplier: 1.3,
118
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
118
+ retry_codes: [4, 14]
119
119
  }
120
120
 
121
121
  default_config.rpcs.list_tasks.timeout = 10.0
@@ -123,7 +123,7 @@ module Google
123
123
  initial_delay: 0.1,
124
124
  max_delay: 10.0,
125
125
  multiplier: 1.3,
126
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
126
+ retry_codes: [4, 14]
127
127
  }
128
128
 
129
129
  default_config.rpcs.get_task.timeout = 10.0
@@ -131,7 +131,7 @@ module Google
131
131
  initial_delay: 0.1,
132
132
  max_delay: 10.0,
133
133
  multiplier: 1.3,
134
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
134
+ retry_codes: [4, 14]
135
135
  }
136
136
 
137
137
  default_config.rpcs.create_task.timeout = 10.0
@@ -141,7 +141,7 @@ module Google
141
141
  initial_delay: 0.1,
142
142
  max_delay: 10.0,
143
143
  multiplier: 1.3,
144
- retry_codes: ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
144
+ retry_codes: [4, 14]
145
145
  }
146
146
 
147
147
  default_config.rpcs.run_task.timeout = 10.0
@@ -1675,7 +1675,7 @@ module Google
1675
1675
 
1676
1676
  config_attr :endpoint, "cloudtasks.googleapis.com", ::String
1677
1677
  config_attr :credentials, nil do |value|
1678
- allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1678
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1679
1679
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
1680
1680
  allowed.any? { |klass| klass === value }
1681
1681
  end
@@ -1703,7 +1703,7 @@ module Google
1703
1703
  def rpcs
1704
1704
  @rpcs ||= begin
1705
1705
  parent_rpcs = nil
1706
- parent_rpcs = @parent_config.rpcs if @parent_config&.respond_to? :rpcs
1706
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
1707
1707
  Rpcs.new parent_rpcs
1708
1708
  end
1709
1709
  end
@@ -1715,7 +1715,7 @@ module Google
1715
1715
  # Each configuration object is of type `Gapic::Config::Method` and includes
1716
1716
  # the following configuration fields:
1717
1717
  #
1718
- # * `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
1718
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
1719
1719
  # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
1720
1720
  # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
1721
1721
  # include the following keys:
@@ -38,9 +38,9 @@ module Google
38
38
  # Lists queues.
39
39
  #
40
40
  # Queues are returned in lexicographical order.
41
- rpc :ListQueues, ListQueuesRequest, ListQueuesResponse
41
+ rpc :ListQueues, ::Google::Cloud::Tasks::V2::ListQueuesRequest, ::Google::Cloud::Tasks::V2::ListQueuesResponse
42
42
  # Gets a queue.
43
- rpc :GetQueue, GetQueueRequest, Queue
43
+ rpc :GetQueue, ::Google::Cloud::Tasks::V2::GetQueueRequest, ::Google::Cloud::Tasks::V2::Queue
44
44
  # Creates a queue.
45
45
  #
46
46
  # Queues created with this method allow tasks to live for a maximum of 31
@@ -53,7 +53,7 @@ module Google
53
53
  # [Overview of Queue Management and
54
54
  # queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
55
55
  # this method.
56
- rpc :CreateQueue, CreateQueueRequest, Queue
56
+ rpc :CreateQueue, ::Google::Cloud::Tasks::V2::CreateQueueRequest, ::Google::Cloud::Tasks::V2::Queue
57
57
  # Updates a queue.
58
58
  #
59
59
  # This method creates the queue if it does not exist and updates
@@ -69,7 +69,7 @@ module Google
69
69
  # [Overview of Queue Management and
70
70
  # queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
71
71
  # this method.
72
- rpc :UpdateQueue, UpdateQueueRequest, Queue
72
+ rpc :UpdateQueue, ::Google::Cloud::Tasks::V2::UpdateQueueRequest, ::Google::Cloud::Tasks::V2::Queue
73
73
  # Deletes a queue.
74
74
  #
75
75
  # This command will delete the queue even if it has tasks in it.
@@ -83,14 +83,14 @@ module Google
83
83
  # [Overview of Queue Management and
84
84
  # queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
85
85
  # this method.
86
- rpc :DeleteQueue, DeleteQueueRequest, Google::Protobuf::Empty
86
+ rpc :DeleteQueue, ::Google::Cloud::Tasks::V2::DeleteQueueRequest, ::Google::Protobuf::Empty
87
87
  # Purges a queue by deleting all of its tasks.
88
88
  #
89
89
  # All tasks created before this method is called are permanently deleted.
90
90
  #
91
91
  # Purge operations can take up to one minute to take effect. Tasks
92
92
  # might be dispatched before the purge takes effect. A purge is irreversible.
93
- rpc :PurgeQueue, PurgeQueueRequest, Queue
93
+ rpc :PurgeQueue, ::Google::Cloud::Tasks::V2::PurgeQueueRequest, ::Google::Cloud::Tasks::V2::Queue
94
94
  # Pauses the queue.
95
95
  #
96
96
  # If a queue is paused then the system will stop dispatching tasks
@@ -98,7 +98,7 @@ module Google
98
98
  # [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue]. Tasks can still be added
99
99
  # when the queue is paused. A queue is paused if its
100
100
  # [state][google.cloud.tasks.v2.Queue.state] is [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
101
- rpc :PauseQueue, PauseQueueRequest, Queue
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
@@ -112,7 +112,7 @@ module Google
112
112
  # queues, follow the 500/50/5 pattern described in
113
113
  # [Managing Cloud Tasks Scaling
114
114
  # Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
115
- rpc :ResumeQueue, ResumeQueueRequest, Queue
115
+ rpc :ResumeQueue, ::Google::Cloud::Tasks::V2::ResumeQueueRequest, ::Google::Cloud::Tasks::V2::Queue
116
116
  # Gets the access control policy for a [Queue][google.cloud.tasks.v2.Queue].
117
117
  # Returns an empty policy if the resource exists and does not have a policy
118
118
  # set.
@@ -122,7 +122,7 @@ module Google
122
122
  # resource parent:
123
123
  #
124
124
  # * `cloudtasks.queues.getIamPolicy`
125
- rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
125
+ rpc :GetIamPolicy, ::Google::Iam::V1::GetIamPolicyRequest, ::Google::Iam::V1::Policy
126
126
  # Sets the access control policy for a [Queue][google.cloud.tasks.v2.Queue]. Replaces any existing
127
127
  # policy.
128
128
  #
@@ -134,7 +134,7 @@ module Google
134
134
  # resource parent:
135
135
  #
136
136
  # * `cloudtasks.queues.setIamPolicy`
137
- rpc :SetIamPolicy, Google::Iam::V1::SetIamPolicyRequest, Google::Iam::V1::Policy
137
+ rpc :SetIamPolicy, ::Google::Iam::V1::SetIamPolicyRequest, ::Google::Iam::V1::Policy
138
138
  # Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2.Queue].
139
139
  # If the resource does not exist, this will return an empty set of
140
140
  # permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
@@ -142,7 +142,7 @@ module Google
142
142
  # Note: This operation is designed to be used for building permission-aware
143
143
  # UIs and command-line tools, not for authorization checking. This operation
144
144
  # may "fail open" without warning.
145
- rpc :TestIamPermissions, Google::Iam::V1::TestIamPermissionsRequest, Google::Iam::V1::TestIamPermissionsResponse
145
+ rpc :TestIamPermissions, ::Google::Iam::V1::TestIamPermissionsRequest, ::Google::Iam::V1::TestIamPermissionsResponse
146
146
  # Lists the tasks in a queue.
147
147
  #
148
148
  # By default, only the [BASIC][google.cloud.tasks.v2.Task.View.BASIC] view is retrieved
@@ -152,21 +152,21 @@ module Google
152
152
  #
153
153
  # The tasks may be returned in any order. The ordering may change at any
154
154
  # time.
155
- rpc :ListTasks, ListTasksRequest, ListTasksResponse
155
+ rpc :ListTasks, ::Google::Cloud::Tasks::V2::ListTasksRequest, ::Google::Cloud::Tasks::V2::ListTasksResponse
156
156
  # Gets a task.
157
- rpc :GetTask, GetTaskRequest, Task
157
+ rpc :GetTask, ::Google::Cloud::Tasks::V2::GetTaskRequest, ::Google::Cloud::Tasks::V2::Task
158
158
  # Creates a task and adds it to a queue.
159
159
  #
160
160
  # Tasks cannot be updated after creation; there is no UpdateTask command.
161
161
  #
162
162
  # * The maximum task size is 100KB.
163
- rpc :CreateTask, CreateTaskRequest, Task
163
+ rpc :CreateTask, ::Google::Cloud::Tasks::V2::CreateTaskRequest, ::Google::Cloud::Tasks::V2::Task
164
164
  # Deletes a task.
165
165
  #
166
166
  # A task can be deleted if it is scheduled or dispatched. A task
167
167
  # cannot be deleted if it has executed successfully or permanently
168
168
  # failed.
169
- rpc :DeleteTask, DeleteTaskRequest, Google::Protobuf::Empty
169
+ rpc :DeleteTask, ::Google::Cloud::Tasks::V2::DeleteTaskRequest, ::Google::Protobuf::Empty
170
170
  # Forces a task to run now.
171
171
  #
172
172
  # When this method is called, Cloud Tasks will dispatch the task, even if
@@ -191,7 +191,7 @@ module Google
191
191
  # [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] returns
192
192
  # [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
193
193
  # task that has already succeeded or permanently failed.
194
- rpc :RunTask, RunTaskRequest, Task
194
+ rpc :RunTask, ::Google::Cloud::Tasks::V2::RunTaskRequest, ::Google::Cloud::Tasks::V2::Task
195
195
  end
196
196
 
197
197
  Stub = Service.rpc_stub_class
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Tasks
23
23
  module V2
24
- VERSION = "0.2.1"
24
+ VERSION = "0.2.6"
25
25
  end
26
26
  end
27
27
  end
@@ -43,12 +43,12 @@ module Google
43
43
  #
44
44
  # The ResourceDescriptor Yaml config will look like:
45
45
  #
46
- # resources:
47
- # - type: "pubsub.googleapis.com/Topic"
48
- # name_descriptor:
49
- # - pattern: "projects/\\{project}/topics/\\{topic}"
50
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
- # parent_name_extractor: "projects/\\{project}"
46
+ # resources:
47
+ # - type: "pubsub.googleapis.com/Topic"
48
+ # name_descriptor:
49
+ # - pattern: "projects/{project}/topics/{topic}"
50
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
+ # parent_name_extractor: "projects/{project}"
52
52
  #
53
53
  # Sometimes, resources have multiple patterns, typically because they can
54
54
  # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
183
183
  # }
184
184
  # @!attribute [rw] plural
185
185
  # @return [::String]
186
- # The plural name used in the resource name, such as 'projects' for
187
- # the name of 'projects/\\{project}'. It is the same concept of the `plural`
188
- # field in k8s CRD spec
186
+ # The plural name used in the resource name and permission names, such as
187
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
188
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
189
+ # concept of the `plural` field in k8s CRD spec
189
190
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
191
+ #
192
+ # Note: The plural form is required even for singleton resources. See
193
+ # https://aip.dev/156
190
194
  # @!attribute [rw] singular
191
195
  # @return [::String]
192
196
  # The same concept of the `singular` field in k8s CRD spec
193
197
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
194
198
  # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
199
+ # @!attribute [rw] style
200
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
201
+ # Style flag(s) for this resource.
202
+ # These indicate that a resource is expected to conform to a given
203
+ # style. See the specific style flags for additional information.
195
204
  class ResourceDescriptor
196
205
  include ::Google::Protobuf::MessageExts
197
206
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
211
220
  # that from being necessary once there are multiple patterns.)
212
221
  FUTURE_MULTI_PATTERN = 2
213
222
  end
223
+
224
+ # A flag representing a specific style that a resource claims to conform to.
225
+ module Style
226
+ # The unspecified value. Do not use.
227
+ STYLE_UNSPECIFIED = 0
228
+
229
+ # This resource is intended to be "declarative-friendly".
230
+ #
231
+ # Declarative-friendly resources must be more strictly consistent, and
232
+ # setting this to true communicates to tools that this resource should
233
+ # adhere to declarative-friendly expectations.
234
+ #
235
+ # Note: This is used by the API linter (linter.aip.dev) to enable
236
+ # additional checks.
237
+ DECLARATIVE_FRIENDLY = 1
238
+ end
214
239
  end
215
240
 
216
241
  # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
226
251
  # type: "pubsub.googleapis.com/Topic"
227
252
  # }];
228
253
  # }
254
+ #
255
+ # Occasionally, a field may reference an arbitrary resource. In this case,
256
+ # APIs use the special value * in their resource reference.
257
+ #
258
+ # Example:
259
+ #
260
+ # message GetIamPolicyRequest {
261
+ # string resource = 2 [(google.api.resource_reference) = {
262
+ # type: "*"
263
+ # }];
264
+ # }
229
265
  # @!attribute [rw] child_type
230
266
  # @return [::String]
231
267
  # The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
234
270
  #
235
271
  # Example:
236
272
  #
237
- # message ListLogEntriesRequest {
238
- # string parent = 1 [(google.api.resource_reference) = {
239
- # child_type: "logging.googleapis.com/LogEntry"
240
- # };
241
- # }
273
+ # message ListLogEntriesRequest {
274
+ # string parent = 1 [(google.api.resource_reference) = {
275
+ # child_type: "logging.googleapis.com/LogEntry"
276
+ # };
277
+ # }
242
278
  class ResourceReference
243
279
  include ::Google::Protobuf::MessageExts
244
280
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-tasks-v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.1
4
+ version: 0.2.6
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-05-26 00:00:00.000000000 Z
11
+ date: 2021-01-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,14 +16,14 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: '0.2'
19
+ version: '0.3'
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
- version: '0.2'
26
+ version: '0.3'
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: google-cloud-errors
29
29
  requirement: !ruby/object:Gem::Requirement
@@ -231,7 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
231
231
  - !ruby/object:Gem::Version
232
232
  version: '0'
233
233
  requirements: []
234
- rubygems_version: 3.0.6
234
+ rubygems_version: 3.2.6
235
235
  signing_key:
236
236
  specification_version: 4
237
237
  summary: API Client library for the Cloud Tasks V2 API