Module: Google::Cloud::Storage::Control

Defined in:
lib/google/cloud/storage/control.rb,
lib/google/cloud/storage/control/version.rb

Constant Summary collapse

VERSION = 
"1.1.0"

Class Method Summary collapse

Class Method Details

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

Configure the google-cloud-storage-control 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



138
139
140
141
142
 
# File 'lib/google/cloud/storage/control.rb', line 138

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

  ::Google::Cloud.configure.storage_control
end

.storage_control(version: :v2, &block) ⇒ ::Object

Create a new client object for StorageControl.

By default, this returns an instance of Google::Cloud::Storage::Control::V2::StorageControl::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the StorageControl service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

Raises an exception if the currently installed versioned client gem for the given API version does not support the StorageControl service. You can determine whether the method will succeed by calling storage_control_available?.

About StorageControl

StorageControl service includes selected control plane operations.

Parameters:

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

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

Returns:

  • (::Object) —

    A client object for the specified version.



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

def self.storage_control version: :v2, &block
  require "google/cloud/storage/control/#{version.to_s.downcase}"

  package_name = Google::Cloud::Storage::Control
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Storage::Control.const_get(package_name).const_get(:StorageControl)
  service_module.const_get(:Client).new(&block)
end

.storage_control_available?(version: :v2) ⇒ boolean

Determines whether the StorageControl service is supported by the current client. If true, you can retrieve a client object by calling storage_control. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the StorageControl service, or if the versioned client gem needs an update to support the StorageControl service.

Parameters:

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

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

Returns:

  • (boolean) —

    Whether the service is available.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/google/cloud/storage/control.rb', line 95

def self.storage_control_available? version: :v2
  require "google/cloud/storage/control/#{version.to_s.downcase}"
  package_name = Google::Cloud::Storage::Control
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::Storage::Control.const_get package_name
  return false unless service_module.const_defined? :StorageControl
  service_module = service_module.const_get :StorageControl
  service_module.const_defined? :Client
rescue ::LoadError
  false
end