Module: Google::Cloud::StorageTransfer

Defined in:
lib/google/cloud/storage_transfer.rb,
lib/google/cloud/storage_transfer/version.rb

Constant Summary collapse

VERSION = 
"1.4.1"

Class Method Summary collapse

Class Method Details

.configure {|::Google::Cloud.configure.storage_transfer| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-storage_transfer library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Yields:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



112
113
114
115
116
 
# File 'lib/google/cloud/storage_transfer.rb', line 112

def self.configure
  yield ::Google::Cloud.configure.storage_transfer if block_given?

  ::Google::Cloud.configure.storage_transfer
end

.storage_transfer_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for StorageTransferService.

By default, this returns an instance of Google::Cloud::StorageTransfer::V1::StorageTransferService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the StorageTransferService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About StorageTransferService

Storage Transfer Service and its protos. Transfers data between between Google Cloud Storage buckets or from a data source external to Google to a Cloud Storage bucket.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/google/cloud/storage_transfer.rb', line 72

def self.storage_transfer_service version: :v1, transport: :grpc, &block
  require "google/cloud/storage_transfer/#{version.to_s.downcase}"

  package_name = Google::Cloud::StorageTransfer
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::StorageTransfer.const_get(package_name).const_get(:StorageTransferService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end