google-cloud-tasks-v2beta3 0.3.1 → 0.6.0

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

@@ -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

@@ -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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Tasks
       module V2beta3
-        VERSION = "0.3.1"
+        VERSION = "0.6.0"
       end
     end
   end

data/proto_docs/google/api/field_behavior.rb

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-tasks-v2beta3
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-07 00:00:00.000000000 Z
+date: 2021-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -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: []
@@ -224,14 +226,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.2.13
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Tasks V2beta3 API