Filestore API - Module Google::Cloud::Filestore (v1.0.1)

Reference documentation and code samples for the Filestore API module Google::Cloud::Filestore.

Methods

.cloud_filestore_manager

def self.cloud_filestore_manager(version: :v1, &block) -> CloudFilestoreManager::Client

Create a new client object for CloudFilestoreManager.

By default, this returns an instance of Google::Cloud::Filestore::V1::CloudFilestoreManager::Client for version V1 of the API. However, you can specify 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.

About CloudFilestoreManager

Configures and manages Cloud Filestore resources.

Cloud Filestore Manager v1.

The file.googleapis.com service implements the Cloud 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, Cloud 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 GCP zone for instances and but to a GCP region for backups; for example:

  • projects/12345/locations/us-central1-c/instances/my-filestore
  • projects/12345/locations/us-central1/backups/my-backup
Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (CloudFilestoreManager::Client) — A client object for the specified version.

.configure

def self.configure() -> ::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 gRPC 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
  • (::Google::Cloud.configure.filestore)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

Constants

VERSION

value: "1.0.1"