google-cloud-tasks-v2 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fc458310d9519284809db91d4decce47c8590e7a44af2c444d6ba626d198e51
-  data.tar.gz: '0908a45fc002152c9e1259dfcc6680652efc79cd6ba11e2447d13124d328014d'
+  metadata.gz: 4609c324323ef5da39a20b7e7badaf67d4c10729d08dde1cce9147d5dd96a070
+  data.tar.gz: b1ea7e746c8cfa67676c4753997a99da6f4ef2d1edde3a9803ce61299e440e77
 SHA512:
-  metadata.gz: 505427abd2604868628701d74666a47cc00961817c6bedf5dd5ccecca9bc78ad99c03a129aaf132c9ed343054bd086198c9837344a8f8eaea8f3f630cd881735
-  data.tar.gz: 495a3154f884a9b7ea3671530a6103bab8cab73e93b50360943e8802e85e505957e9edff8647aa8933f05642c622e919783f395e8ecc12a0e1e6efcf65052081
+  metadata.gz: 9b3a436272c5c31399e847de2cf6b6a6ca52c5a38e39754427eecee8c44a9588b3811cfc619e4387f7f0bad76f470dcdd302a54e4b917aae11970b652da68f30
+  data.tar.gz: e26fb942b05db20d0430c7c9984c1fbcf16d13a779644c3c2df1ac8da22b9a0afd449a9e817912fb2af422f1be657d57293f77362e3a1b9c1687a9874a26e87a

data/lib/google/cloud/tasks/v2/cloud_tasks/client.rb

@@ -202,7 +202,8 @@ module Google
                 credentials:  credentials,
                 endpoint:     @config.endpoint,
                 channel_args: @config.channel_args,
-                interceptors: @config.interceptors
+                interceptors: @config.interceptors,
+                channel_pool_config: @config.channel_pool
               )
             end
 
@@ -2024,6 +2025,14 @@ module Google
                 end
               end
 
+              ##
+              # Configuration for the channel pool
+              # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+              #
+              def channel_pool
+                @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+              end
+
               ##
               # Configuration RPC class for the CloudTasks API.
               #

data/lib/google/cloud/tasks/v2/cloud_tasks/rest/client.rb

@@ -267,6 +267,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Tasks::V2::Queue>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/tasks/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Tasks::V2::ListQueuesRequest.new
+              #
+              #   # Call the list_queues method.
+              #   result = client.list_queues request
+              #
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
+              #     # Each element is of type ::Google::Cloud::Tasks::V2::Queue.
+              #     p item
+              #   end
+              #
               def list_queues request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -331,6 +351,22 @@ module Google
               # @return [::Google::Cloud::Tasks::V2::Queue]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/tasks/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Tasks::V2::GetQueueRequest.new
+              #
+              #   # Call the get_queue method.
+              #   result = client.get_queue request
+              #
+              #   # The returned object is of type Google::Cloud::Tasks::V2::Queue.
+              #   p result
+              #
               def get_queue request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -414,6 +450,22 @@ module Google
               # @return [::Google::Cloud::Tasks::V2::Queue]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/tasks/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Tasks::V2::CreateQueueRequest.new
+              #
+              #   # Call the create_queue method.
+              #   result = client.create_queue request
+              #
+              #   # The returned object is of type Google::Cloud::Tasks::V2::Queue.
+              #   p result
+              #
               def create_queue request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -500,6 +552,22 @@ module Google
               # @return [::Google::Cloud::Tasks::V2::Queue]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/tasks/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Tasks::V2::UpdateQueueRequest.new
+              #
+              #   # Call the update_queue method.
+              #   result = client.update_queue request
+              #
+              #   # The returned object is of type Google::Cloud::Tasks::V2::Queue.
+              #   p result
+              #
               def update_queue request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -575,6 +643,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/tasks/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Tasks::V2::DeleteQueueRequest.new
+              #
+              #   # Call the delete_queue method.
+              #   result = client.delete_queue request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_queue request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -643,6 +727,22 @@ module Google
               # @return [::Google::Cloud::Tasks::V2::Queue]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/tasks/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Tasks::V2::PurgeQueueRequest.new
+              #
+              #   # Call the purge_queue method.
+              #   result = client.purge_queue request
+              #
+              #   # The returned object is of type Google::Cloud::Tasks::V2::Queue.
+              #   p result
+              #
               def purge_queue request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -713,6 +813,22 @@ module Google
               # @return [::Google::Cloud::Tasks::V2::Queue]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/tasks/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Tasks::V2::PauseQueueRequest.new
+              #
+              #   # Call the pause_queue method.
+              #   result = client.pause_queue request
+              #
+              #   # The returned object is of type Google::Cloud::Tasks::V2::Queue.
+              #   p result
+              #
               def pause_queue request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -789,6 +905,22 @@ module Google
               # @return [::Google::Cloud::Tasks::V2::Queue]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/tasks/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Tasks::V2::ResumeQueueRequest.new
+              #
+              #   # Call the resume_queue method.
+              #   result = client.resume_queue request
+              #
+              #   # The returned object is of type Google::Cloud::Tasks::V2::Queue.
+              #   p result
+              #
               def resume_queue request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -863,6 +995,22 @@ module Google
               # @return [::Google::Iam::V1::Policy]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/tasks/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Iam::V1::GetIamPolicyRequest.new
+              #
+              #   # Call the get_iam_policy method.
+              #   result = client.get_iam_policy request
+              #
+              #   # The returned object is of type Google::Iam::V1::Policy.
+              #   p result
+              #
               def get_iam_policy request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -947,6 +1095,22 @@ module Google
               # @return [::Google::Iam::V1::Policy]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/tasks/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Iam::V1::SetIamPolicyRequest.new
+              #
+              #   # Call the set_iam_policy method.
+              #   result = client.set_iam_policy request
+              #
+              #   # The returned object is of type Google::Iam::V1::Policy.
+              #   p result
+              #
               def set_iam_policy request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1022,6 +1186,22 @@ module Google
               # @return [::Google::Iam::V1::TestIamPermissionsResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/tasks/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Iam::V1::TestIamPermissionsRequest.new
+              #
+              #   # Call the test_iam_permissions method.
+              #   result = client.test_iam_permissions request
+              #
+              #   # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
+              #   p result
+              #
               def test_iam_permissions request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1125,6 +1305,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Tasks::V2::Task>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/tasks/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Tasks::V2::ListTasksRequest.new
+              #
+              #   # Call the list_tasks method.
+              #   result = client.list_tasks request
+              #
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
+              #     # Each element is of type ::Google::Cloud::Tasks::V2::Task.
+              #     p item
+              #   end
+              #
               def list_tasks request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1202,6 +1402,22 @@ module Google
               # @return [::Google::Cloud::Tasks::V2::Task]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/tasks/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Tasks::V2::GetTaskRequest.new
+              #
+              #   # Call the get_task method.
+              #   result = client.get_task request
+              #
+              #   # The returned object is of type Google::Cloud::Tasks::V2::Task.
+              #   p result
+              #
               def get_task request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1318,6 +1534,22 @@ module Google
               # @return [::Google::Cloud::Tasks::V2::Task]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/tasks/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Tasks::V2::CreateTaskRequest.new
+              #
+              #   # Call the create_task method.
+              #   result = client.create_task request
+              #
+              #   # The returned object is of type Google::Cloud::Tasks::V2::Task.
+              #   p result
+              #
               def create_task request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1385,6 +1617,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/tasks/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Tasks::V2::DeleteTaskRequest.new
+              #
+              #   # Call the delete_task method.
+              #   result = client.delete_task request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_task request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1486,6 +1734,22 @@ module Google
               # @return [::Google::Cloud::Tasks::V2::Task]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/tasks/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Tasks::V2::RunTaskRequest.new
+              #
+              #   # Call the run_task method.
+              #   result = client.run_task request
+              #
+              #   # The returned object is of type Google::Cloud::Tasks::V2::Task.
+              #   p result
+              #
               def run_task request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 

data/lib/google/cloud/tasks/v2/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Tasks
       module V2
-        VERSION = "0.8.2"
+        VERSION = "0.9.0"
       end
     end
   end

data/proto_docs/google/api/field_behavior.rb

@@ -66,6 +66,20 @@ module Google
       # a non-empty value will be returned. The user will not be aware of what
       # non-empty value to expect.
       NON_EMPTY_DEFAULT = 7
+
+      # Denotes that the field in a resource (a message annotated with
+      # google.api.resource) is used in the resource name to uniquely identify the
+      # resource. For AIP-compliant APIs, this should only be applied to the
+      # `name` field on the resource.
+      #
+      # This behavior should not be applied to references to other resources within
+      # the message.
+      #
+      # The identifier field of resources often have different field behavior
+      # depending on the request it is embedded in (e.g. for Create methods name
+      # is optional and unused, while for Update methods it is required). Instead
+      # of method-specific annotations, only `IDENTIFIER` is required.
+      IDENTIFIER = 8
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-tasks-v2
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-04 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -260,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Manages the execution of large numbers of distributed requests.