google-cloud-storage_transfer-v1 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af7725237df5c5ef0673811dd3ebf384df3adfca2735c77dcbba090bff65fd3e
-  data.tar.gz: d6a6622e66087d34beccd36f184b0928beea1b562c8170ed753c261c1140aedb
+  metadata.gz: a776cdb6f238f03940db687371e80d5a4e15f6f14038ec7b57259076440e576f
+  data.tar.gz: df1886914fd19b4aa27ac0589f2a3abc2a834084863fb46a819ff06215fa625f
 SHA512:
-  metadata.gz: 3d9e6935bbe7dc97b515e9e5682f4df28842537dd1746960fcc038fc649701b1546d81c04f30987a3f4ba7da715fa803ba3705091b4de2845dc37197bfff8d04
-  data.tar.gz: 4f75bfc6e724e52509a4f6906cb0dce607ba8126c934de8989c2f4ce0568cb4e98e9e9ed15da458b8698c778f1ae6837e1f62a6920072c6a5e8ce975077d5953
+  metadata.gz: d4f7d9c12b27a1e7ead3dab96a41cb47b38d851934c56cc35dae2428de887b33ebd80b94580cf6f4acf302dac5d6dac9eaef0666182fafb249c1045f796bdd65
+  data.tar.gz: 3b4ffb9e40e3bae55731f29054fd616e4d25764e86ddd56efb9e6c10e30cdd7d6a92f35fa4a554302d36fc73504b1b0147cfc0180ebec1b350a7b2444fff18b6

data/lib/google/cloud/storage_transfer/v1/storage_transfer_service/client.rb

@@ -153,7 +153,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
 
@@ -1596,6 +1597,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 StorageTransferService API.
               #

data/lib/google/cloud/storage_transfer/v1/storage_transfer_service/operations.rb

@@ -93,7 +93,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
               )
 
               # Used by an LRO wrapper for some methods of this service
@@ -701,6 +702,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 Operations API.
               #

data/lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/client.rb

@@ -192,6 +192,22 @@ module Google
               # @return [::Google::Cloud::StorageTransfer::V1::GoogleServiceAccount]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/storage_transfer/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::StorageTransfer::V1::GetGoogleServiceAccountRequest.new
+              #
+              #   # Call the get_google_service_account method.
+              #   result = client.get_google_service_account request
+              #
+              #   # The returned object is of type Google::Cloud::StorageTransfer::V1::GoogleServiceAccount.
+              #   p result
+              #
               def get_google_service_account request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -254,6 +270,22 @@ module Google
               # @return [::Google::Cloud::StorageTransfer::V1::TransferJob]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/storage_transfer/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::StorageTransfer::V1::CreateTransferJobRequest.new
+              #
+              #   # Call the create_transfer_job method.
+              #   result = client.create_transfer_job request
+              #
+              #   # The returned object is of type Google::Cloud::StorageTransfer::V1::TransferJob.
+              #   p result
+              #
               def create_transfer_job request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -351,6 +383,22 @@ module Google
               # @return [::Google::Cloud::StorageTransfer::V1::TransferJob]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/storage_transfer/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::StorageTransfer::V1::UpdateTransferJobRequest.new
+              #
+              #   # Call the update_transfer_job method.
+              #   result = client.update_transfer_job request
+              #
+              #   # The returned object is of type Google::Cloud::StorageTransfer::V1::TransferJob.
+              #   p result
+              #
               def update_transfer_job request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -416,6 +464,22 @@ module Google
               # @return [::Google::Cloud::StorageTransfer::V1::TransferJob]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/storage_transfer/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::StorageTransfer::V1::GetTransferJobRequest.new
+              #
+              #   # Call the get_transfer_job method.
+              #   result = client.get_transfer_job request
+              #
+              #   # The returned object is of type Google::Cloud::StorageTransfer::V1::TransferJob.
+              #   p result
+              #
               def get_transfer_job request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -493,6 +557,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::StorageTransfer::V1::TransferJob>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/storage_transfer/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::StorageTransfer::V1::ListTransferJobsRequest.new
+              #
+              #   # Call the list_transfer_jobs method.
+              #   result = client.list_transfer_jobs 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::StorageTransfer::V1::TransferJob.
+              #     p item
+              #   end
+              #
               def list_transfer_jobs request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -556,6 +640,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/storage_transfer/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::StorageTransfer::V1::PauseTransferOperationRequest.new
+              #
+              #   # Call the pause_transfer_operation method.
+              #   result = client.pause_transfer_operation request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def pause_transfer_operation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -618,6 +718,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/storage_transfer/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::StorageTransfer::V1::ResumeTransferOperationRequest.new
+              #
+              #   # Call the resume_transfer_operation method.
+              #   result = client.resume_transfer_operation request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def resume_transfer_operation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -686,6 +802,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/storage_transfer/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::StorageTransfer::V1::RunTransferJobRequest.new
+              #
+              #   # Call the run_transfer_job method.
+              #   result = client.run_transfer_job request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
               def run_transfer_job request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -753,6 +892,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/storage_transfer/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::StorageTransfer::V1::DeleteTransferJobRequest.new
+              #
+              #   # Call the delete_transfer_job method.
+              #   result = client.delete_transfer_job request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_transfer_job request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -832,6 +987,22 @@ module Google
               # @return [::Google::Cloud::StorageTransfer::V1::AgentPool]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/storage_transfer/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::StorageTransfer::V1::CreateAgentPoolRequest.new
+              #
+              #   # Call the create_agent_pool method.
+              #   result = client.create_agent_pool request
+              #
+              #   # The returned object is of type Google::Cloud::StorageTransfer::V1::AgentPool.
+              #   p result
+              #
               def create_agent_pool request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -912,6 +1083,22 @@ module Google
               # @return [::Google::Cloud::StorageTransfer::V1::AgentPool]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/storage_transfer/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::StorageTransfer::V1::UpdateAgentPoolRequest.new
+              #
+              #   # Call the update_agent_pool method.
+              #   result = client.update_agent_pool request
+              #
+              #   # The returned object is of type Google::Cloud::StorageTransfer::V1::AgentPool.
+              #   p result
+              #
               def update_agent_pool request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -974,6 +1161,22 @@ module Google
               # @return [::Google::Cloud::StorageTransfer::V1::AgentPool]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/storage_transfer/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::StorageTransfer::V1::GetAgentPoolRequest.new
+              #
+              #   # Call the get_agent_pool method.
+              #   result = client.get_agent_pool request
+              #
+              #   # The returned object is of type Google::Cloud::StorageTransfer::V1::AgentPool.
+              #   p result
+              #
               def get_agent_pool request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1049,6 +1252,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::StorageTransfer::V1::AgentPool>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/storage_transfer/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::StorageTransfer::V1::ListAgentPoolsRequest.new
+              #
+              #   # Call the list_agent_pools method.
+              #   result = client.list_agent_pools 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::StorageTransfer::V1::AgentPool.
+              #     p item
+              #   end
+              #
               def list_agent_pools request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1112,6 +1335,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/storage_transfer/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::StorageTransfer::V1::DeleteAgentPoolRequest.new
+              #
+              #   # Call the delete_agent_pool method.
+              #   result = client.delete_agent_pool request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_agent_pool request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 

data/lib/google/cloud/storage_transfer/v1/storage_transfer_service/rest/operations.rb

@@ -136,6 +136,26 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::ListOperationsRequest.new
+              #
+              #   # Call the list_operations method.
+              #   result = client.list_operations 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::Longrunning::Operation.
+              #     p item
+              #   end
+              #
               def list_operations request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -201,6 +221,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::GetOperationRequest.new
+              #
+              #   # Call the get_operation method.
+              #   result = client.get_operation request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
               def get_operation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -267,6 +310,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::DeleteOperationRequest.new
+              #
+              #   # Call the delete_operation method.
+              #   result = client.delete_operation request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_operation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -338,6 +397,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::CancelOperationRequest.new
+              #
+              #   # Call the cancel_operation method.
+              #   result = client.cancel_operation request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def cancel_operation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 

data/lib/google/cloud/storage_transfer/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module StorageTransfer
       module V1
-        VERSION = "0.7.0"
+        VERSION = "0.8.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-storage_transfer-v1
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-27 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
@@ -223,7 +223,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: Transfers data from external data sources to a Google Cloud Storage bucket