Reference documentation and code samples for the Parallelstore API module Google::Cloud::Parallelstore.
Methods
.configure
defself.configure()->::Google::Cloud::Config
Configure the google-cloud-parallelstore 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
(::Google::Cloud.configure.parallelstore)
Returns
(::Google::Cloud::Config) — The default configuration used by this library
By default, this returns an instance of
Google::Cloud::Parallelstore::V1::Parallelstore::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 Parallelstore 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 Parallelstore service.
You can determine whether the method will succeed by calling
Parallelstore.parallelstore_available?.
About Parallelstore
Service describing handlers for resources
Configures and manages parallelstore resources.
Parallelstore service.
The parallelstore.googleapis.com service implements the parallelstore 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 named /instances/*.
Parallelstore instances are resources of the form:
/projects/{project_id}/locations/{location_id}/instances/{instance_id}
Note that location_id must be a Google Cloud zone; for example:
Determines whether the Parallelstore service is supported by the current client.
If true, you can retrieve a client object by calling Parallelstore.parallelstore.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the Parallelstore service,
or if the versioned client gem needs an update to support the Parallelstore 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Parallelstore API - Module Google::Cloud::Parallelstore (v2.0.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.1 (latest)](/ruby/docs/reference/google-cloud-parallelstore/latest/Google-Cloud-Parallelstore)\n- [1.1.0](/ruby/docs/reference/google-cloud-parallelstore/1.1.0/Google-Cloud-Parallelstore)\n- [1.0.1](/ruby/docs/reference/google-cloud-parallelstore/1.0.1/Google-Cloud-Parallelstore)\n- [0.1.0](/ruby/docs/reference/google-cloud-parallelstore/0.1.0/Google-Cloud-Parallelstore) \nReference documentation and code samples for the Parallelstore API module Google::Cloud::Parallelstore.\n\nMethods\n-------\n\n### .configure\n\n def self.configure() -\u003e ::Google::Cloud::Config\n\nConfigure the google-cloud-parallelstore library.\n\nThe following configuration parameters are supported:\n\n- `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.\n- `lib_name` (*type:* `String`) - The library name as recorded in instrumentation and logging.\n- `lib_version` (*type:* `String`) - The library version as recorded in instrumentation and logging.\n- `interceptors` (*type:* `Array\u003cGRPC::ClientInterceptor\u003e`) - An array of interceptors that are run before calls are executed.\n- `timeout` (*type:* `Numeric`) - Default timeout in seconds.\n- `metadata` (*type:* `Hash{Symbol=\u003eString}`) - Additional headers to be sent with the call.\n- `retry_policy` (*type:* `Hash`) - The retry policy. The value is a hash with the following keys:\n - `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.\n - `:max_delay` (*type:* `Numeric`) - The max delay in seconds.\n - `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.\n- `:retry_codes` (*type:* `Array\u003cString\u003e`) - The error codes that should trigger a retry. \n**Yields**\n\n- (::Google::Cloud.configure.parallelstore) \n**Returns**\n\n- (::Google::Cloud::Config) --- The default configuration used by this library\n\n### .parallelstore\n\n def self.parallelstore(version: :v1, transport: :grpc, &block) -\u003e ::Object\n\nCreate a new client object for Parallelstore.\n\nBy default, this returns an instance of\n[Google::Cloud::Parallelstore::V1::Parallelstore::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-parallelstore-v1/latest/Google-Cloud-Parallelstore-V1-Parallelstore-Client)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the Parallelstore service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\nYou can also specify a different transport by passing `:rest` or `:grpc` in\nthe `transport` parameter.\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the given transport of the Parallelstore service.\nYou can determine whether the method will succeed by calling\n[Parallelstore.parallelstore_available?](/ruby/docs/reference/google-cloud-parallelstore/latest/Google-Cloud-Parallelstore#Google__Cloud__Parallelstore_parallelstore_available__class_ \"Google::Cloud::Parallelstore.parallelstore_available? (method)\").\n\n#### About Parallelstore\n\nService describing handlers for resources\nConfigures and manages parallelstore resources.\n\nParallelstore service.\n\nThe `parallelstore.googleapis.com` service implements the parallelstore API\nand defines the following resource model for managing instances:\n\n- The service works with a collection of cloud projects, named: `/projects/`\n- Each project has a collection of available locations, named: `/locations/`\n- Each location has a collection of instances named `/instances/*`.\n- Parallelstore instances are resources of the form: `/projects/{project_id}/locations/{location_id}/instances/{instance_id}`\n\nNote that location_id must be a Google Cloud `zone`; for example:\n\n- `projects/12345/locations/us-central1-c/instances/my-parallelstore-share` \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .parallelstore_available?\n\n def self.parallelstore_available?(version: :v1, transport: :grpc) -\u003e boolean\n\nDetermines whether the Parallelstore service is supported by the current client.\nIf true, you can retrieve a client object by calling [Parallelstore.parallelstore](/ruby/docs/reference/google-cloud-parallelstore/latest/Google-Cloud-Parallelstore#Google__Cloud__Parallelstore_parallelstore_class_ \"Google::Cloud::Parallelstore.parallelstore (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the Parallelstore service,\nor if the versioned client gem needs an update to support the Parallelstore service. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\nConstants\n---------\n\n### VERSION\n\n**value:**\"2.0.1\""]]