RubyGems - google-cloud-tasks-v2beta3 - Versions diffs - 0.3.0 → 0.5.0 - Mend

google-cloud-tasks-v2beta3 0.3.0 → 0.5.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 (19) hide show

checksums.yaml +4 -4
data/README.md +64 -0
data/lib/google/cloud/tasks/v2beta3.rb +3 -0
data/lib/google/cloud/tasks/v2beta3/cloud_tasks/client.rb +45 -29
data/lib/google/cloud/tasks/v2beta3/cloudtasks_pb.rb +2 -0
data/lib/google/cloud/tasks/v2beta3/cloudtasks_services_pb.rb +16 -16
data/lib/google/cloud/tasks/v2beta3/queue_pb.rb +11 -0
data/lib/google/cloud/tasks/v2beta3/target_pb.rb +5 -0
data/lib/google/cloud/tasks/v2beta3/task_pb.rb +1 -0
data/lib/google/cloud/tasks/v2beta3/version.rb +1 -1
data/proto_docs/google/api/field_behavior.rb +6 -0
data/proto_docs/google/api/resource.rb +50 -14
data/proto_docs/google/cloud/tasks/v2beta3/cloudtasks.rb +12 -0
data/proto_docs/google/cloud/tasks/v2beta3/queue.rb +73 -11
data/proto_docs/google/cloud/tasks/v2beta3/target.rb +27 -0
data/proto_docs/google/cloud/tasks/v2beta3/task.rb +9 -0
data/proto_docs/google/protobuf/any.rb +5 -2
data/proto_docs/google/protobuf/timestamp.rb +10 -1
metadata +6 -4

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 612e8851a66ad8f184ce029e07b0be5fff55afaccf58400a47482eb6992a1e48
-  data.tar.gz: 4f378ff8d31bcbcb9383ac4a0f822476a7d3b922c8a7582dfc97f82c4188e740
+  metadata.gz: c0e3212ceb3d851ea3a2c31734e6d7ab87d6dd89e7b36b24d9b50d9535ce6883
+  data.tar.gz: fd7dd723c42b373356c69dad40a27bdd05389e66c92f92b434c4c73c1974c6c3
 SHA512:
-  metadata.gz: 284bc82418e0d51dcfa9bad01683c4494416ce50153a3d007f505f3612dfe1bcc658aa433001d84b41735558def958026c8b998108824ed04a51bd293873a8da
-  data.tar.gz: d8bea38af1f5b5fab40c30b3d744fd5eb24ddbdf570c04cc45643ee38769653d88e53112759ab32c2d50249e3e7b0e3f8ea4e9d71722446c9717a16fd1c1a4d9
+  metadata.gz: 6d7f523c6619e818d387c52985256cc0aaf1e00c82ea4159245ab4612e71576b55f8cb5e3c799fc4875acec1d60a88c828768d80246b4151ab5c9e10096fb5b8
+  data.tar.gz: b68c1b63dd37acb20dad16266bba6d724ca7bbe246ed856a26eeb6a93a4dd5115400739c47cacd5780dde7aa147ffd5af844ce80f58843098e1d7aef88830c1d

data/README.md CHANGED Viewed

@@ -6,6 +6,12 @@ Cloud Tasks is a fully managed service that allows you to manage the execution,
 https://github.com/googleapis/google-cloud-ruby
+This gem is a _versioned_ client. It provides basic client classes for a
+specific version of the Cloud Tasks V2beta3 API. Most users should consider using
+the main client gem,
+[google-cloud-tasks](https://rubygems.org/gems/google-cloud-tasks).
+See the section below titled *Which client should I use?* for more information.
 ## Installation
 ```
@@ -73,3 +79,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
 and later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.
+## Which client should I use?
+Most modern Ruby client libraries for Google APIs come in two flavors: the main
+client library with a name such as `google-cloud-tasks`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-tasks-v2beta3`.
+_In most cases, you should install the main client._
+### What's the difference between the main client and a versioned client?
+A _versioned client_ provides a basic set of data types and client classes for
+a _single version_ of a specific service. (That is, for a service with multiple
+versions, there might be a separate versioned client for each service version.)
+Most versioned clients are written and maintained by a code generator.
+The _main client_ is designed to provide you with the _recommended_ client
+interfaces for the service. There will be only one main client for any given
+service, even a service with multiple versions. The main client includes
+factory methods for constructing the client objects we recommend for most
+users. In some cases, those will be classes provided by an underlying versioned
+client; in other cases, they will be handwritten higher-level client objects
+with additional capabilities, convenience methods, or best practices built in.
+Generally, the main client will default to a recommended service version,
+although in some cases you can override this if you need to talk to a specific
+service version.
+### Why would I want to use the main client?
+We recommend that most users install the main client gem for a service. You can
+identify this gem as the one _without_ a version in its name, e.g.
+`google-cloud-tasks`.
+The main client is recommended because it will embody the best practices for
+accessing the service, and may also provide more convenient interfaces or
+tighter integration into frameworks and third-party libraries. In addition, the
+documentation and samples published by Google will generally demonstrate use of
+the main client.
+### Why would I want to use a versioned client?
+You can use a versioned client if you are content with a possibly lower-level
+class interface, you explicitly want to avoid features provided by the main
+client, or you want to access a specific service version not be covered by the
+main client. You can identify versioned client gems because the service version
+is part of the name, e.g. `google-cloud-tasks-v2beta3`.
+### What about the google-apis-<name> clients?
+Client library gems with names that begin with `google-apis-` are based on an
+older code generation technology. They talk to a REST/JSON backend (whereas
+most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
+not offer the same performance, features, and ease of use provided by more
+modern clients.
+The `google-apis-` clients have wide coverage across Google services, so you
+might need to use one if there is no modern client available for the service.
+However, if a modern client is available, we generally recommend it over the
+older `google-apis-` clients.

data/lib/google/cloud/tasks/v2beta3.rb CHANGED Viewed

@@ -33,3 +33,6 @@ module Google
     end
   end
 end
+helper_path = ::File.join __dir__, "v2beta3", "_helpers.rb"
+require "google/cloud/tasks/v2beta3/_helpers" if ::File.file? helper_path

data/lib/google/cloud/tasks/v2beta3/cloud_tasks/client.rb CHANGED Viewed

@@ -66,85 +66,85 @@ module Google
                                 end
                 default_config = Client::Configuration.new parent_config
-                default_config.rpcs.list_queues.timeout = 10.0
+                default_config.rpcs.list_queues.timeout = 20.0
                 default_config.rpcs.list_queues.retry_policy = {
                   initial_delay: 0.1,
                   max_delay:     10.0,
                   multiplier:    1.3,
-                  retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
+                  retry_codes:   [4, 14]
                 }
-                default_config.rpcs.get_queue.timeout = 10.0
+                default_config.rpcs.get_queue.timeout = 20.0
                 default_config.rpcs.get_queue.retry_policy = {
                   initial_delay: 0.1,
                   max_delay:     10.0,
                   multiplier:    1.3,
-                  retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
+                  retry_codes:   [4, 14]
                 }
-                default_config.rpcs.create_queue.timeout = 10.0
+                default_config.rpcs.create_queue.timeout = 20.0
-                default_config.rpcs.update_queue.timeout = 10.0
+                default_config.rpcs.update_queue.timeout = 20.0
-                default_config.rpcs.delete_queue.timeout = 10.0
+                default_config.rpcs.delete_queue.timeout = 20.0
                 default_config.rpcs.delete_queue.retry_policy = {
                   initial_delay: 0.1,
                   max_delay:     10.0,
                   multiplier:    1.3,
-                  retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
+                  retry_codes:   [4, 14]
                 }
-                default_config.rpcs.purge_queue.timeout = 10.0
+                default_config.rpcs.purge_queue.timeout = 20.0
-                default_config.rpcs.pause_queue.timeout = 10.0
+                default_config.rpcs.pause_queue.timeout = 20.0
-                default_config.rpcs.resume_queue.timeout = 10.0
+                default_config.rpcs.resume_queue.timeout = 20.0
-                default_config.rpcs.get_iam_policy.timeout = 10.0
+                default_config.rpcs.get_iam_policy.timeout = 20.0
                 default_config.rpcs.get_iam_policy.retry_policy = {
                   initial_delay: 0.1,
                   max_delay:     10.0,
                   multiplier:    1.3,
-                  retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
+                  retry_codes:   [4, 14]
                 }
-                default_config.rpcs.set_iam_policy.timeout = 10.0
+                default_config.rpcs.set_iam_policy.timeout = 20.0
-                default_config.rpcs.test_iam_permissions.timeout = 10.0
+                default_config.rpcs.test_iam_permissions.timeout = 20.0
                 default_config.rpcs.test_iam_permissions.retry_policy = {
                   initial_delay: 0.1,
                   max_delay:     10.0,
                   multiplier:    1.3,
-                  retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
+                  retry_codes:   [4, 14]
                 }
-                default_config.rpcs.list_tasks.timeout = 10.0
+                default_config.rpcs.list_tasks.timeout = 20.0
                 default_config.rpcs.list_tasks.retry_policy = {
                   initial_delay: 0.1,
                   max_delay:     10.0,
                   multiplier:    1.3,
-                  retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
+                  retry_codes:   [4, 14]
                 }
-                default_config.rpcs.get_task.timeout = 10.0
+                default_config.rpcs.get_task.timeout = 20.0
                 default_config.rpcs.get_task.retry_policy = {
                   initial_delay: 0.1,
                   max_delay:     10.0,
                   multiplier:    1.3,
-                  retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
+                  retry_codes:   [4, 14]
                 }
-                default_config.rpcs.create_task.timeout = 10.0
+                default_config.rpcs.create_task.timeout = 20.0
-                default_config.rpcs.delete_task.timeout = 10.0
+                default_config.rpcs.delete_task.timeout = 20.0
                 default_config.rpcs.delete_task.retry_policy = {
                   initial_delay: 0.1,
                   max_delay:     10.0,
                   multiplier:    1.3,
-                  retry_codes:   ["DEADLINE_EXCEEDED", "UNAVAILABLE"]
+                  retry_codes:   [4, 14]
                 }
-                default_config.rpcs.run_task.timeout = 10.0
+                default_config.rpcs.run_task.timeout = 20.0
                 default_config
               end
@@ -207,7 +207,13 @@ module Google
               # Create credentials
               credentials = @config.credentials
-              credentials ||= Credentials.default scope: @config.scope
+              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # but only if the default endpoint does not have a region prefix.
+              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
+                                       @config.endpoint == Client.configure.endpoint &&
+                                       !@config.endpoint.split(".").first.include?("-")
+              credentials ||= Credentials.default scope:                  @config.scope,
+                                                  enable_self_signed_jwt: enable_self_signed_jwt
               if credentials.is_a?(String) || credentials.is_a?(Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
@@ -240,7 +246,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload list_queues(parent: nil, filter: nil, page_size: nil, page_token: nil)
+            # @overload list_queues(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil)
             #   Pass arguments to `list_queues` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -277,6 +283,11 @@ module Google
             #     from the previous call to {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#list_queues ListQueues}
             #     method. It is an error to switch the value of the
             #     {::Google::Cloud::Tasks::V2beta3::ListQueuesRequest#filter filter} while iterating through pages.
+            #   @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
+            #     Optional. Read mask is used for a more granular control over what the API returns.
+            #     If the mask is not present all fields will be returned except
+            #     [Queue.stats]. [Queue.stats] will be returned only if it was  explicitly
+            #     specified in the mask.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Tasks::V2beta3::Queue>]
@@ -337,7 +348,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload get_queue(name: nil)
+            # @overload get_queue(name: nil, read_mask: nil)
             #   Pass arguments to `get_queue` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -345,6 +356,11 @@ module Google
             #   @param name [::String]
             #     Required. The resource name of the queue. For example:
             #     `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+            #   @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
+            #     Optional. Read mask is used for a more granular control over what the API returns.
+            #     If the mask is not present all fields will be returned except
+            #     [Queue.stats]. [Queue.stats] will be returned only if it was  explicitly
+            #     specified in the mask.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Tasks::V2beta3::Queue]
@@ -1675,7 +1691,7 @@ module Google
               config_attr :endpoint,      "cloudtasks.googleapis.com", ::String
               config_attr :credentials,   nil do |value|
-                allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
+                allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                 allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
                 allowed.any? { |klass| klass === value }
               end
@@ -1715,7 +1731,7 @@ module Google
               # Each configuration object is of type `Gapic::Config::Method` and includes
               # the following configuration fields:
               #
-              #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+              #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
               #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
               #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
               #     include the following keys:

data/lib/google/cloud/tasks/v2beta3/cloudtasks_pb.rb CHANGED Viewed

@@ -20,6 +20,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :filter, :string, 2
       optional :page_size, :int32, 3
       optional :page_token, :string, 4
+      optional :read_mask, :message, 5, "google.protobuf.FieldMask"
     end
     add_message "google.cloud.tasks.v2beta3.ListQueuesResponse" do
       repeated :queues, :message, 1, "google.cloud.tasks.v2beta3.Queue"
@@ -27,6 +28,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.cloud.tasks.v2beta3.GetQueueRequest" do
       optional :name, :string, 1
+      optional :read_mask, :message, 2, "google.protobuf.FieldMask"
     end
     add_message "google.cloud.tasks.v2beta3.CreateQueueRequest" do
       optional :parent, :string, 1

data/lib/google/cloud/tasks/v2beta3/cloudtasks_services_pb.rb CHANGED Viewed

@@ -37,9 +37,9 @@ module Google
             # Lists queues.
             #
             # Queues are returned in lexicographical order.
-            rpc :ListQueues, ListQueuesRequest, ListQueuesResponse
+            rpc :ListQueues, ::Google::Cloud::Tasks::V2beta3::ListQueuesRequest, ::Google::Cloud::Tasks::V2beta3::ListQueuesResponse
             # Gets a queue.
-            rpc :GetQueue, GetQueueRequest, Queue
+            rpc :GetQueue, ::Google::Cloud::Tasks::V2beta3::GetQueueRequest, ::Google::Cloud::Tasks::V2beta3::Queue
             # Creates a queue.
             #
             # Queues created with this method allow tasks to live for a maximum of 31
@@ -52,7 +52,7 @@ module Google
             # [Overview of Queue Management and
             # queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
             # this method.
-            rpc :CreateQueue, CreateQueueRequest, Queue
+            rpc :CreateQueue, ::Google::Cloud::Tasks::V2beta3::CreateQueueRequest, ::Google::Cloud::Tasks::V2beta3::Queue
             # Updates a queue.
             #
             # This method creates the queue if it does not exist and updates
@@ -68,7 +68,7 @@ module Google
             # [Overview of Queue Management and
             # queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
             # this method.
-            rpc :UpdateQueue, UpdateQueueRequest, Queue
+            rpc :UpdateQueue, ::Google::Cloud::Tasks::V2beta3::UpdateQueueRequest, ::Google::Cloud::Tasks::V2beta3::Queue
             # Deletes a queue.
             #
             # This command will delete the queue even if it has tasks in it.
@@ -82,14 +82,14 @@ module Google
             # [Overview of Queue Management and
             # queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
             # this method.
-            rpc :DeleteQueue, DeleteQueueRequest, Google::Protobuf::Empty
+            rpc :DeleteQueue, ::Google::Cloud::Tasks::V2beta3::DeleteQueueRequest, ::Google::Protobuf::Empty
             # Purges a queue by deleting all of its tasks.
             #
             # All tasks created before this method is called are permanently deleted.
             #
             # Purge operations can take up to one minute to take effect. Tasks
             # might be dispatched before the purge takes effect. A purge is irreversible.
-            rpc :PurgeQueue, PurgeQueueRequest, Queue
+            rpc :PurgeQueue, ::Google::Cloud::Tasks::V2beta3::PurgeQueueRequest, ::Google::Cloud::Tasks::V2beta3::Queue
             # Pauses the queue.
             #
             # If a queue is paused then the system will stop dispatching tasks
@@ -97,7 +97,7 @@ module Google
             # [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue]. Tasks can still be added
             # when the queue is paused. A queue is paused if its
             # [state][google.cloud.tasks.v2beta3.Queue.state] is [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED].
-            rpc :PauseQueue, PauseQueueRequest, Queue
+            rpc :PauseQueue, ::Google::Cloud::Tasks::V2beta3::PauseQueueRequest, ::Google::Cloud::Tasks::V2beta3::Queue
             # Resume a queue.
             #
             # This method resumes a queue after it has been
@@ -111,7 +111,7 @@ module Google
             # queues, follow the 500/50/5 pattern described in
             # [Managing Cloud Tasks Scaling
             # Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
-            rpc :ResumeQueue, ResumeQueueRequest, Queue
+            rpc :ResumeQueue, ::Google::Cloud::Tasks::V2beta3::ResumeQueueRequest, ::Google::Cloud::Tasks::V2beta3::Queue
             # Gets the access control policy for a [Queue][google.cloud.tasks.v2beta3.Queue].
             # Returns an empty policy if the resource exists and does not have a policy
             # set.
@@ -121,7 +121,7 @@ module Google
             # resource parent:
             #
             # * `cloudtasks.queues.getIamPolicy`
-            rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
+            rpc :GetIamPolicy, ::Google::Iam::V1::GetIamPolicyRequest, ::Google::Iam::V1::Policy
             # Sets the access control policy for a [Queue][google.cloud.tasks.v2beta3.Queue]. Replaces any existing
             # policy.
             #
@@ -133,7 +133,7 @@ module Google
             # resource parent:
             #
             # * `cloudtasks.queues.setIamPolicy`
-            rpc :SetIamPolicy, Google::Iam::V1::SetIamPolicyRequest, Google::Iam::V1::Policy
+            rpc :SetIamPolicy, ::Google::Iam::V1::SetIamPolicyRequest, ::Google::Iam::V1::Policy
             # Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta3.Queue].
             # If the resource does not exist, this will return an empty set of
             # permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
@@ -141,7 +141,7 @@ module Google
             # Note: This operation is designed to be used for building permission-aware
             # UIs and command-line tools, not for authorization checking. This operation
             # may "fail open" without warning.
-            rpc :TestIamPermissions, Google::Iam::V1::TestIamPermissionsRequest, Google::Iam::V1::TestIamPermissionsResponse
+            rpc :TestIamPermissions, ::Google::Iam::V1::TestIamPermissionsRequest, ::Google::Iam::V1::TestIamPermissionsResponse
             # Lists the tasks in a queue.
             #
             # By default, only the [BASIC][google.cloud.tasks.v2beta3.Task.View.BASIC] view is retrieved
@@ -151,21 +151,21 @@ module Google
             #
             # The tasks may be returned in any order. The ordering may change at any
             # time.
-            rpc :ListTasks, ListTasksRequest, ListTasksResponse
+            rpc :ListTasks, ::Google::Cloud::Tasks::V2beta3::ListTasksRequest, ::Google::Cloud::Tasks::V2beta3::ListTasksResponse
             # Gets a task.
-            rpc :GetTask, GetTaskRequest, Task
+            rpc :GetTask, ::Google::Cloud::Tasks::V2beta3::GetTaskRequest, ::Google::Cloud::Tasks::V2beta3::Task
             # Creates a task and adds it to a queue.
             #
             # Tasks cannot be updated after creation; there is no UpdateTask command.
             #
             # * The maximum task size is 100KB.
-            rpc :CreateTask, CreateTaskRequest, Task
+            rpc :CreateTask, ::Google::Cloud::Tasks::V2beta3::CreateTaskRequest, ::Google::Cloud::Tasks::V2beta3::Task
             # Deletes a task.
             #
             # A task can be deleted if it is scheduled or dispatched. A task
             # cannot be deleted if it has executed successfully or permanently
             # failed.
-            rpc :DeleteTask, DeleteTaskRequest, Google::Protobuf::Empty
+            rpc :DeleteTask, ::Google::Cloud::Tasks::V2beta3::DeleteTaskRequest, ::Google::Protobuf::Empty
             # Forces a task to run now.
             #
             # When this method is called, Cloud Tasks will dispatch the task, even if
@@ -190,7 +190,7 @@ module Google
             # [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] returns
             # [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
             # task that has already succeeded or permanently failed.
-            rpc :RunTask, RunTaskRequest, Task
+            rpc :RunTask, ::Google::Cloud::Tasks::V2beta3::RunTaskRequest, ::Google::Cloud::Tasks::V2beta3::Task
           end
           Stub = Service.rpc_stub_class

data/lib/google/cloud/tasks/v2beta3/queue_pb.rb CHANGED Viewed

@@ -17,8 +17,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :retry_config, :message, 5, "google.cloud.tasks.v2beta3.RetryConfig"
       optional :state, :enum, 6, "google.cloud.tasks.v2beta3.Queue.State"
       optional :purge_time, :message, 7, "google.protobuf.Timestamp"
+      optional :task_ttl, :message, 8, "google.protobuf.Duration"
+      optional :tombstone_ttl, :message, 9, "google.protobuf.Duration"
       optional :stackdriver_logging_config, :message, 10, "google.cloud.tasks.v2beta3.StackdriverLoggingConfig"
       optional :type, :enum, 11, "google.cloud.tasks.v2beta3.Queue.Type"
+      optional :stats, :message, 12, "google.cloud.tasks.v2beta3.QueueStats"
       oneof :queue_type do
         optional :app_engine_http_queue, :message, 3, "google.cloud.tasks.v2beta3.AppEngineHttpQueue"
       end
@@ -49,6 +52,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.cloud.tasks.v2beta3.StackdriverLoggingConfig" do
       optional :sampling_ratio, :double, 1
     end
+    add_message "google.cloud.tasks.v2beta3.QueueStats" do
+      optional :tasks_count, :int64, 1
+      optional :oldest_estimated_arrival_time, :message, 2, "google.protobuf.Timestamp"
+      optional :executed_last_minute_count, :int64, 3
+      optional :concurrent_dispatches_count, :int64, 4
+      optional :effective_execution_rate, :double, 5
+    end
   end
 end
@@ -62,6 +72,7 @@ module Google
         RateLimits = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta3.RateLimits").msgclass
         RetryConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta3.RetryConfig").msgclass
         StackdriverLoggingConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta3.StackdriverLoggingConfig").msgclass
+        QueueStats = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta3.QueueStats").msgclass
       end
     end
   end

data/lib/google/cloud/tasks/v2beta3/target_pb.rb CHANGED Viewed

@@ -6,6 +6,10 @@ require 'google/protobuf'
 require 'google/api/annotations_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/tasks/v2beta3/target.proto", :syntax => :proto3) do
+    add_message "google.cloud.tasks.v2beta3.PullMessage" do
+      optional :payload, :bytes, 1
+      optional :tag, :string, 2
+    end
     add_message "google.cloud.tasks.v2beta3.HttpRequest" do
       optional :url, :string, 1
       optional :http_method, :enum, 2, "google.cloud.tasks.v2beta3.HttpMethod"
@@ -57,6 +61,7 @@ module Google
   module Cloud
     module Tasks
       module V2beta3
+        PullMessage = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta3.PullMessage").msgclass
         HttpRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta3.HttpRequest").msgclass
         AppEngineHttpQueue = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta3.AppEngineHttpQueue").msgclass
         AppEngineHttpRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta3.AppEngineHttpRequest").msgclass

data/lib/google/cloud/tasks/v2beta3/task_pb.rb CHANGED Viewed

@@ -24,6 +24,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       oneof :payload_type do
         optional :app_engine_http_request, :message, 3, "google.cloud.tasks.v2beta3.AppEngineHttpRequest"
         optional :http_request, :message, 11, "google.cloud.tasks.v2beta3.HttpRequest"
+        optional :pull_message, :message, 13, "google.cloud.tasks.v2beta3.PullMessage"
       end
     end
     add_enum "google.cloud.tasks.v2beta3.Task.View" do

data/lib/google/cloud/tasks/v2beta3/version.rb CHANGED Viewed

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Tasks
       module V2beta3
-        VERSION = "0.3.0"
+        VERSION = "0.5.0"
       end
     end
   end

data/proto_docs/google/api/field_behavior.rb CHANGED Viewed

@@ -54,6 +54,12 @@ module Google
       # This indicates that the field may be set once in a request to create a
       # resource, but may not be changed thereafter.
       IMMUTABLE = 5
+      # Denotes that a (repeated) field is an unordered list.
+      # This indicates that the service may provide the elements of the list
+      # in any arbitrary order, rather than the order the user originally
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
     end
   end
 end

data/proto_docs/google/api/resource.rb CHANGED Viewed

@@ -43,12 +43,12 @@ module Google
     #
     # The ResourceDescriptor Yaml config will look like:
     #
-    #    resources:
-    #    - type: "pubsub.googleapis.com/Topic"
-    #      name_descriptor:
-    #        - pattern: "projects/\\{project}/topics/\\{topic}"
-    #          parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #          parent_name_extractor: "projects/\\{project}"
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
     #         }
     # @!attribute [rw] plural
     #   @return [::String]
-    #     The plural name used in the resource name, such as 'projects' for
-    #     the name of 'projects/\\{project}'. It is the same concept of the `plural`
-    #     field in k8s CRD spec
+    #     The plural name used in the resource name and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
+    #     concept of the `plural` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
     # @!attribute [rw] singular
     #   @return [::String]
     #     The same concept of the `singular` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
     #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
     class ResourceDescriptor
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
         # that from being necessary once there are multiple patterns.)
         FUTURE_MULTI_PATTERN = 2
       end
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      end
     end
     # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
     #             type: "pubsub.googleapis.com/Topic"
     #           }];
     #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
     # @!attribute [rw] child_type
     #   @return [::String]
     #     The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
     #
     #     Example:
     #
-    #       message ListLogEntriesRequest {
-    #         string parent = 1 [(google.api.resource_reference) = {
-    #           child_type: "logging.googleapis.com/LogEntry"
-    #         };
-    #       }
+    #         message ListLogEntriesRequest {
+    #           string parent = 1 [(google.api.resource_reference) = {
+    #             child_type: "logging.googleapis.com/LogEntry"
+    #           };
+    #         }
     class ResourceReference
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/tasks/v2beta3/cloudtasks.rb CHANGED Viewed

@@ -58,6 +58,12 @@ module Google
         #     from the previous call to {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#list_queues ListQueues}
         #     method. It is an error to switch the value of the
         #     {::Google::Cloud::Tasks::V2beta3::ListQueuesRequest#filter filter} while iterating through pages.
+        # @!attribute [rw] read_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. Read mask is used for a more granular control over what the API returns.
+        #     If the mask is not present all fields will be returned except
+        #     [Queue.stats]. [Queue.stats] will be returned only if it was  explicitly
+        #     specified in the mask.
         class ListQueuesRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -88,6 +94,12 @@ module Google
         #   @return [::String]
         #     Required. The resource name of the queue. For example:
         #     `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
+        # @!attribute [rw] read_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. Read mask is used for a more granular control over what the API returns.
+        #     If the mask is not present all fields will be returned except
+        #     [Queue.stats]. [Queue.stats] will be returned only if it was  explicitly
+        #     specified in the mask.
         class GetQueueRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/tasks/v2beta3/queue.rb CHANGED Viewed

@@ -110,6 +110,32 @@ module Google
         #
         #     Purge time will be truncated to the nearest microsecond. Purge
         #     time will be unset if the queue has never been purged.
+        # @!attribute [rw] task_ttl
+        #   @return [::Google::Protobuf::Duration]
+        #     The maximum amount of time that a task will be retained in
+        #     this queue.
+        #
+        #     Queues created by Cloud Tasks have a default `task_ttl` of 31 days.
+        #     After a task has lived for `task_ttl`, the task will be deleted
+        #     regardless of whether it was dispatched or not.
+        #
+        #     The `task_ttl` for queues created via queue.yaml/xml is equal to the
+        #     maximum duration because there is a
+        #     [storage quota](https://cloud.google.com/appengine/quotas#Task_Queue) for
+        #     these queues. To view the maximum valid duration, see the documentation for
+        #     {::Google::Protobuf::Duration Duration}.
+        # @!attribute [rw] tombstone_ttl
+        #   @return [::Google::Protobuf::Duration]
+        #     The task tombstone time to live (TTL).
+        #
+        #     After a task is deleted or executed, the task's tombstone is
+        #     retained for the length of time specified by `tombstone_ttl`.
+        #     The tombstone is used by task de-duplication; another task with the same
+        #     name can't be created until the tombstone has expired. For more information
+        #     about task de-duplication, see the documentation for
+        #     {::Google::Cloud::Tasks::V2beta3::CreateTaskRequest#task CreateTaskRequest}.
+        #
+        #     Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour.
         # @!attribute [rw] stackdriver_logging_config
         #   @return [::Google::Cloud::Tasks::V2beta3::StackdriverLoggingConfig]
         #     Configuration options for writing logs to
@@ -122,6 +148,11 @@ module Google
         #     `Queue.type` is an immutable property of the queue that is set at the queue
         #     creation time. When left unspecified, the default value of `PUSH` is
         #     selected.
+        # @!attribute [r] stats
+        #   @return [::Google::Cloud::Tasks::V2beta3::QueueStats]
+        #     Output only. The realtime, informational statistics for a queue. In order
+        #     to receive the statistics the caller should include this field in the
+        #     FieldMask.
         class Queue
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -199,7 +230,7 @@ module Google
         #     queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
         # @!attribute [rw] max_burst_size
         #   @return [::Integer]
-        #     Output only. The max burst size.
+        #     The max burst size.
         #
         #     Max burst size limits how fast tasks in queue are processed when
         #     many tasks are in the queue and the rate is high. This field
@@ -216,21 +247,21 @@ module Google
         #     continuously refilled with new tokens based on
         #     {::Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second max_dispatches_per_second}.
         #
-        #     Cloud Tasks will pick the value of `max_burst_size` based on the
-        #     value of
+        #     The default value of `max_burst_size` is picked by Cloud Tasks
+        #     based on the value of
         #     {::Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second max_dispatches_per_second}.
         #
+        #     The maximum value of `max_burst_size` is 500.
+        #
         #     For App Engine queues that were created or updated using
         #     `queue.yaml/xml`, `max_burst_size` is equal to
         #     [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
-        #     Since `max_burst_size` is output only, if
-        #     {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#update_queue UpdateQueue} is called on a queue
-        #     created by `queue.yaml/xml`, `max_burst_size` will be reset based
-        #     on the value of
-        #     {::Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second max_dispatches_per_second},
-        #     regardless of whether
-        #     {::Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second max_dispatches_per_second}
-        #     is updated.
+        #     If
+        #     {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#update_queue UpdateQueue} is called on a queue without
+        #     explicitly setting a value for `max_burst_size`,
+        #     `max_burst_size` value will get updated if
+        #     {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#update_queue UpdateQueue} is updating
+        #     {::Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second max_dispatches_per_second}.
         # @!attribute [rw] max_concurrent_dispatches
         #   @return [::Integer]
         #     The maximum number of concurrent tasks that Cloud Tasks allows
@@ -371,6 +402,37 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+        # Statistics for a queue.
+        # @!attribute [r] tasks_count
+        #   @return [::Integer]
+        #     Output only. An estimation of the number of tasks in the queue, that is, the tasks in
+        #     the queue that haven't been executed, the tasks in the queue which the
+        #     queue has dispatched but has not yet received a reply for, and the failed
+        #     tasks that the queue is retrying.
+        # @!attribute [r] oldest_estimated_arrival_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. An estimation of the nearest time in the future where a task in the queue
+        #     is scheduled to be executed.
+        # @!attribute [r] executed_last_minute_count
+        #   @return [::Integer]
+        #     Output only. The number of tasks that the queue has dispatched and received a reply for
+        #     during the last minute. This variable counts both successful and
+        #     non-successful executions.
+        # @!attribute [r] concurrent_dispatches_count
+        #   @return [::Integer]
+        #     Output only. The number of requests that the queue has dispatched but has not received
+        #     a reply for yet.
+        # @!attribute [r] effective_execution_rate
+        #   @return [::Float]
+        #     Output only. The current maximum number of tasks per second executed by the queue.
+        #     The maximum value of this variable is controlled by the RateLimits of the
+        #     Queue. However, this value could be less to avoid overloading the endpoints
+        #     tasks in the queue are targeting.
+        class QueueStats
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

data/proto_docs/google/cloud/tasks/v2beta3/target.rb CHANGED Viewed

@@ -21,6 +21,33 @@ module Google
   module Cloud
     module Tasks
       module V2beta3
+        # Pull Message.
+        #
+        # This proto can only be used for tasks in a queue which has
+        # {::Google::Cloud::Tasks::V2beta3::Queue#type PULL} type. It currently exists for backwards compatibility with
+        # the App Engine Task Queue SDK. This message type maybe returned with methods
+        # [list][google.cloud.tasks.v2beta3.CloudTask.ListTasks] and
+        # [get][google.cloud.tasks.v2beta3.CloudTask.ListTasks], when the response view
+        # is [FULL][google.cloud.tasks.v2beta3.Task.View.Full].
+        # @!attribute [rw] payload
+        #   @return [::String]
+        #     A data payload consumed by the worker to execute the task.
+        # @!attribute [rw] tag
+        #   @return [::String]
+        #     The tasks's tag.
+        #
+        #     The tag is less than 500 characters.
+        #
+        #     SDK compatibility: Although the SDK allows tags to be either
+        #     string or
+        #     [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
+        #     only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
+        #     encoded, the tag will be empty when the task is returned by Cloud Tasks.
+        class PullMessage
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
         # HTTP request.
         #
         # The task will be pushed to the worker as an HTTP request. If the worker

data/proto_docs/google/cloud/tasks/v2beta3/task.rb CHANGED Viewed

@@ -54,6 +54,15 @@ module Google
         #     HTTP request that is sent to the task's target.
         #
         #     An HTTP task is a task that has {::Google::Cloud::Tasks::V2beta3::HttpRequest HttpRequest} set.
+        # @!attribute [rw] pull_message
+        #   @return [::Google::Cloud::Tasks::V2beta3::PullMessage]
+        #     Pull Message contained in a task in a {::Google::Cloud::Tasks::V2beta3::Queue#type PULL} queue type. This
+        #     payload type cannot be explicitly set through Cloud Tasks API. Its
+        #     purpose, currently is to provide backward compatibility with App Engine
+        #     Task Queue
+        #     [pull](https://cloud.google.com/appengine/docs/standard/java/taskqueue/pull/)
+        #     queues to provide a way to inspect contents of pull tasks through the
+        #     {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#get_task CloudTasks.GetTask}.
         # @!attribute [rw] schedule_time
         #   @return [::Google::Protobuf::Timestamp]
         #     The time when the task is scheduled to be attempted.

data/proto_docs/google/protobuf/any.rb CHANGED Viewed

@@ -57,10 +57,13 @@ module Google
     #  Example 4: Pack and unpack a message in Go
     #
     #      foo := &pb.Foo{...}
-    #      any, err := ptypes.MarshalAny(foo)
+    #      any, err := anypb.New(foo)
+    #      if err != nil {
+    #        ...
+    #      }
     #      ...
     #      foo := &pb.Foo{}
-    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #      if err := any.UnmarshalTo(foo); err != nil {
     #        ...
     #      }
     #

data/proto_docs/google/protobuf/timestamp.rb CHANGED Viewed

@@ -70,7 +70,16 @@ module Google
     #         .setNanos((int) ((millis % 1000) * 1000000)).build();
     #
     #
-    # Example 5: Compute Timestamp from current time in Python.
+    # Example 5: Compute Timestamp from Java `Instant.now()`.
+    #
+    #     Instant now = Instant.now();
+    #
+    #     Timestamp timestamp =
+    #         Timestamp.newBuilder().setSeconds(now.getEpochSecond())
+    #             .setNanos(now.getNano()).build();
+    #
+    #
+    # Example 6: Compute Timestamp from current time in Python.
     #
     #     timestamp = Timestamp()
     #     timestamp.GetCurrentTime()

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-tasks-v2beta3
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-22 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -173,7 +173,9 @@ dependencies:
 description: Cloud Tasks is a fully managed service that allows you to manage the
   execution, dispatch and delivery of a large number of distributed tasks. You can
   asynchronously perform work outside of a user request. Your tasks can be executed
-  on App Engine or any arbitrary HTTP endpoint.
+  on App Engine or any arbitrary HTTP endpoint. Note that google-cloud-tasks-v2beta3
+  is a version-specific client library. For most uses, we recommend installing the
+  main client library google-cloud-tasks instead. See the readme for more details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -231,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.2.6
 signing_key:
 specification_version: 4
 summary: API Client library for the Cloud Tasks V2beta3 API