Module: Google::Cloud::Filestore

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

Constant Summary collapse

VERSION = 
"2.0.1"

Class Method Summary collapse

Class Method Details

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

Create a new client object for CloudFilestoreManager.

By default, this returns an instance of Google::Cloud::Filestore::V1::CloudFilestoreManager::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 CloudFilestoreManager 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.

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

About CloudFilestoreManager

Configures and manages Filestore resources.

Filestore Manager v1.

The file.googleapis.com service implements the Filestore API and defines the following resource model for managing instances:

  • The service works with a collection of cloud projects, named: /projects/*
  • Each project has a collection of available locations, named: /locations/*
  • Each location has a collection of instances and backups, named: /instances/* and /backups/* respectively.
  • As such, Filestore instances are resources of the form: /projects/{project_number}/locations/{location_id}/instances/{instance_id} and backups are resources of the form: /projects/{project_number}/locations/{location_id}/backup/{backup_id}

Note that location_id must be a Google Cloud zone for instances, but a Google Cloud region for backups; for example:

  • projects/12345/locations/us-central1-c/instances/my-filestore
  • projects/12345/locations/us-central1/backups/my-backup

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.



93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/google/cloud/filestore.rb', line 93

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

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

.cloud_filestore_manager_available?(version: :v1, transport: :grpc) ⇒ boolean

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

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:

  • (boolean) —

    Whether the service is available.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/google/cloud/filestore.rb', line 117

def self.cloud_filestore_manager_available? version: :v1, transport: :grpc
  require "google/cloud/filestore/#{version.to_s.downcase}"
  package_name = Google::Cloud::Filestore
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::Filestore.const_get package_name
  return false unless service_module.const_defined? :CloudFilestoreManager
  service_module = service_module.const_get :CloudFilestoreManager
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

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

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



164
165
166
167
168
 
# File 'lib/google/cloud/filestore.rb', line 164

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

  ::Google::Cloud.configure.filestore
end