google-cloud-storage_transfer-v1 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ad8fb3ed24ae2ddc9807d57172b770db7c0152cab93a358c1dc572eecce68cd
-  data.tar.gz: a14d4ebac4be9ca66cd821708f6caee3d1282df5403c3801eaf790f5639bd709
+  metadata.gz: 55c503cb0b2dc31c3a7e65d3049ee7c5927878570d1dd1e66f1fa3fb90ac1902
+  data.tar.gz: 74caf82b189522819d2a786984fc73966cc93a34ad0193444e9c8566cbcd310d
 SHA512:
-  metadata.gz: d57b72eb5fec5e2041ed40716cc63d6f9b42b39622fdd4a06f88e785c8c25f50652825a509b6da56152bc3fd68670d15733f71bf1c75bc938772a3e710a8122b
-  data.tar.gz: 317525abdf6f4ba46b225e1059cf87adcc887e0549958638294f83ea763b385c8d2dd68e9a5416e0d0d372687409cea5619a59c1b16db3f4a4f4253e349bd5e6
+  metadata.gz: 1a35b812854082d5c13b9184f803535a04a03aed833594720885f3b166259e7ea76f7a7e5b0d55418ea5ee6708260696dd6aa63a5faca197ea61aa032f9b04ac
+  data.tar.gz: afffabaf2311b63efc6a01244ecdfc32cd118fa264201f469e5a08f5ff9bb0e32b53c03400b25c9660913f9ae208fe75087e90be5bf28a4ce811f58412d8a851

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

@@ -195,6 +195,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC 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::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?
 
@@ -212,9 +227,11 @@ module Google
                 gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "project_id" => request.project_id
-              }
+              header_params = {}
+              if request.project_id
+                header_params["project_id"] = request.project_id
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -263,6 +280,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC 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::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?
 
@@ -358,6 +390,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC 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::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?
 
@@ -375,9 +422,11 @@ module Google
                 gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "job_name" => request.job_name
-              }
+              header_params = {}
+              if request.job_name
+                header_params["job_name"] = request.job_name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -430,6 +479,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC 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::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?
 
@@ -447,9 +511,11 @@ module Google
                 gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "job_name" => request.job_name
-              }
+              header_params = {}
+              if request.job_name
+                header_params["job_name"] = request.job_name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -513,6 +579,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC 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::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 all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::StorageTransfer::V1::TransferJob.
+            #     p response
+            #   end
+            #
             def list_transfer_jobs request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -576,6 +663,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC 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::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?
 
@@ -593,9 +695,11 @@ module Google
                 gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -644,6 +748,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC 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::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?
 
@@ -661,9 +780,11 @@ module Google
                 gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -717,6 +838,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC 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::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 this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def run_transfer_job request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -734,9 +877,11 @@ module Google
                 gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "job_name" => request.job_name
-              }
+              header_params = {}
+              if request.job_name
+                header_params["job_name"] = request.job_name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 

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

@@ -143,6 +143,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::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 all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Longrunning::Operation.
+            #     p response
+            #   end
+            #
             def list_operations request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -160,9 +181,11 @@ module Google
                 gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -215,6 +238,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::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 this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def get_operation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -232,9 +277,11 @@ module Google
                 gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -287,6 +334,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::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?
 
@@ -304,9 +366,11 @@ module Google
                 gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -364,6 +428,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::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?
 
@@ -381,9 +460,11 @@ module Google
                 gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -444,6 +525,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::WaitOperationRequest.new
+            #
+            #   # Call the wait_operation method.
+            #   result = client.wait_operation request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def wait_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.1.0"
+        VERSION = "0.1.1"
       end
     end
   end

data/lib/google/storagetransfer/v1/transfer_pb.rb

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/storagetransfer/v1/transfer.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -11,6 +9,8 @@ require 'google/protobuf/duration_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/storagetransfer/v1/transfer_types_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/storagetransfer/v1/transfer.proto", :syntax => :proto3) do
     add_message "google.storagetransfer.v1.GetGoogleServiceAccountRequest" do

data/lib/google/storagetransfer/v1/transfer_services_pb.rb

@@ -29,7 +29,7 @@ module Google
           # source external to Google to a Cloud Storage bucket.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

data/lib/google/storagetransfer/v1/transfer_types_pb.rb

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/storagetransfer/v1/transfer_types.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/protobuf/any_pb'
@@ -11,6 +9,8 @@ require 'google/protobuf/timestamp_pb'
 require 'google/rpc/code_pb'
 require 'google/type/date_pb'
 require 'google/type/timeofday_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/storagetransfer/v1/transfer_types.proto", :syntax => :proto3) do
     add_message "google.storagetransfer.v1.GoogleServiceAccount" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-storage_transfer-v1
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-19 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common