google-cloud-storage_transfer-v1 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40ca77c02f4a6e403441548a57d2b36cf900798b38104168c38523a31b5c8c48
-  data.tar.gz: 979478a9632e396f100c6c3baae7dcee3f66cfc5d8bd0f798b868089d5a3cbcf
+  metadata.gz: c56312327a5b6109f223205eac3f6aab3a7fdd9d7f108cedac8ac4df14300719
+  data.tar.gz: 6635a127cf70f9b8087720e7ee4f0c61e156e6b16f3e10c6adbcbd5187faa05f
 SHA512:
-  metadata.gz: 5cc2ee55f3a694c9adeb843b4faea81709760989df0b9c2898ea751fee1d1f99c4e2ba6b560c875497d5f1d7ddc40f91dd2230b2910d5b9d2604a27f1128f185
-  data.tar.gz: ff5dfdfeb9851fd8cf177f9162c1b5dbe5eef038ca8e8fc37957f5c6b6a0aac96fc4e45fbf8f00472101862da32bb5a73ecf620ad3f45970108e2a8044991b2f
+  metadata.gz: 7653113070f45bd525544710de7cf7e5c8eef71ed471f3558782a742f92bcc38edae80abdbf936d4f19f2498c1588e8bab163234d65a6c9af3e0d81579e28d8e
+  data.tar.gz: 000f8b4af98b20061cb2418dc278425b8e8316ec4bf7213a6892005c9cc32297335c68aafbba5162263b693345d643419194f5c85b54cc5f99efc2cb9bebdace

data/AUTHENTICATION.md

@@ -112,7 +112,7 @@ credentials are discovered.
 To configure your system for this, simply:
 
 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
-2. Authenticate using OAuth 2.0 `$ gcloud auth login`
+2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
 3. Write code as if already authenticated.
 
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK

data/README.md

@@ -1,6 +1,6 @@
 # Ruby Client for the Storage Transfer Service V1 API
 
-API Client library for the Storage Transfer Service V1 API
+Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.
 
 Storage Transfer Service allows you to quickly import online data into Cloud Storage. You can also set up a repeating schedule for transferring data, as well as transfer data within Cloud Storage, from one bucket to another.
 
@@ -46,7 +46,7 @@ for general usage information.
 ## Enabling Logging
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
 or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
 that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
 and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/cloud/storage_transfer/v1/storage_transfer_service/rest"
+require "google/cloud/storage_transfer/v1/version"
+
+module Google
+  module Cloud
+    module StorageTransfer
+      ##
+      # To load just the REST part of this package, including all its services, and instantiate a REST client:
+      #
+      # @example
+      #
+      #     require "google/cloud/storage_transfer/v1/rest"
+      #     client = ::Google::Cloud::StorageTransfer::V1::StorageTransferService::Rest::Client.new
+      #
+      module V1
+      end
+    end
+  end
+end

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

@@ -66,7 +66,12 @@ module Google
                                 end
                 default_config = Client::Configuration.new parent_config
 
-                default_config.timeout = 30.0
+                default_config.timeout = 60.0
+                default_config.retry_policy = {
+                  initial_delay: 1.0, max_delay: 60.0, multiplier: 2, retry_codes: [14]
+                }
+
+                default_config.rpcs.create_transfer_job.timeout = 60.0
 
                 default_config
               end
@@ -371,7 +376,7 @@ module Google
             #     other fields are rejected with the error
             #     {::Google::Rpc::Code::INVALID_ARGUMENT INVALID_ARGUMENT}. Updating a job status
             #     to {::Google::Cloud::StorageTransfer::V1::TransferJob::Status::DELETED DELETED} requires
-            #     `storagetransfer.jobs.delete` permissions.
+            #     `storagetransfer.jobs.delete` permission.
             #   @param update_transfer_job_field_mask [::Google::Protobuf::FieldMask, ::Hash]
             #     The field mask of the fields in `transferJob` that are to be updated in
             #     this request.  Fields in `transferJob` that can be updated are:
@@ -592,13 +597,11 @@ module Google
             #   # 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|
+            #   # 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 response
+            #     p item
             #   end
             #
             def list_transfer_jobs request, options = nil
@@ -851,14 +854,14 @@ module Google
             #   # 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:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def run_transfer_job request, options = nil
@@ -903,6 +906,95 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Deletes a transfer job. Deleting a transfer job sets its status to
+            # {::Google::Cloud::StorageTransfer::V1::TransferJob::Status::DELETED DELETED}.
+            #
+            # @overload delete_transfer_job(request, options = nil)
+            #   Pass arguments to `delete_transfer_job` via a request object, either of type
+            #   {::Google::Cloud::StorageTransfer::V1::DeleteTransferJobRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::StorageTransfer::V1::DeleteTransferJobRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload delete_transfer_job(job_name: nil, project_id: nil)
+            #   Pass arguments to `delete_transfer_job` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param job_name [::String]
+            #     Required. The job to delete.
+            #   @param project_id [::String]
+            #     Required. The ID of the Google Cloud project that owns the
+            #     job.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Protobuf::Empty]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Protobuf::Empty]
+            #
+            # @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::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?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::StorageTransfer::V1::DeleteTransferJobRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.delete_transfer_job.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::StorageTransfer::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              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
+
+              options.apply_defaults timeout:      @config.rpcs.delete_transfer_job.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.delete_transfer_job.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @storage_transfer_service_stub.call_rpc :delete_transfer_job, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Creates an agent pool resource.
             #
@@ -1247,13 +1339,11 @@ module Google
             #   # Call the list_agent_pools method.
             #   result = client.list_agent_pools 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|
+            #   # 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 response
+            #     p item
             #   end
             #
             def list_agent_pools request, options = nil
@@ -1559,6 +1649,11 @@ module Google
                 #
                 attr_reader :run_transfer_job
                 ##
+                # RPC-specific configuration for `delete_transfer_job`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :delete_transfer_job
+                ##
                 # RPC-specific configuration for `create_agent_pool`
                 # @return [::Gapic::Config::Method]
                 #
@@ -1602,6 +1697,8 @@ module Google
                   @resume_transfer_operation = ::Gapic::Config::Method.new resume_transfer_operation_config
                   run_transfer_job_config = parent_rpcs.run_transfer_job if parent_rpcs.respond_to? :run_transfer_job
                   @run_transfer_job = ::Gapic::Config::Method.new run_transfer_job_config
+                  delete_transfer_job_config = parent_rpcs.delete_transfer_job if parent_rpcs.respond_to? :delete_transfer_job
+                  @delete_transfer_job = ::Gapic::Config::Method.new delete_transfer_job_config
                   create_agent_pool_config = parent_rpcs.create_agent_pool if parent_rpcs.respond_to? :create_agent_pool
                   @create_agent_pool = ::Gapic::Config::Method.new create_agent_pool_config
                   update_agent_pool_config = parent_rpcs.update_agent_pool if parent_rpcs.respond_to? :update_agent_pool

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

@@ -158,13 +158,11 @@ module Google
             #   # 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|
+            #   # 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 response
+            #     p item
             #   end
             #
             def list_operations request, options = nil
@@ -253,14 +251,14 @@ module Google
             #   # 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:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def get_operation request, options = nil
@@ -540,14 +538,14 @@ module Google
             #   # 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:
+            #   # 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 "Error!"
+            #     puts "No response received."
             #   end
             #
             def wait_operation request, options = nil