Reference documentation and code samples for the Cloud TPU API module Google::Cloud::Tpu.
Methods
.configure
defself.configure()->::Google::Cloud::Config
Configure the google-cloud-tpu 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.tpu)
Returns
(::Google::Cloud::Config) — The default configuration used by this library
.tpu
defself.tpu(version::v1,&block)->::Object
Create a new client object for Tpu.
By default, this returns an instance of
Google::Cloud::Tpu::V1::Tpu::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 Tpu 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 Tpu service.
You can determine whether the method will succeed by calling
Tpu.tpu_available?.
About Tpu
Manages TPU nodes and other resources
TPU API v1
Parameter
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
Returns
(::Object) — A client object for the specified version.
.tpu_available?
defself.tpu_available?(version::v1)->boolean
Determines whether the Tpu service is supported by the current client.
If true, you can retrieve a client object by calling Tpu.tpu.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the Tpu service,
or if the versioned client gem needs an update to support the Tpu service.
Parameter
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
[[["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-09-04 UTC."],[],[],null,["# Cloud TPU API - Module Google::Cloud::Tpu (v1.4.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.1 (latest)](/ruby/docs/reference/google-cloud-tpu/latest/Google-Cloud-Tpu)\n- [1.4.0](/ruby/docs/reference/google-cloud-tpu/1.4.0/Google-Cloud-Tpu)\n- [1.3.1](/ruby/docs/reference/google-cloud-tpu/1.3.1/Google-Cloud-Tpu)\n- [1.2.0](/ruby/docs/reference/google-cloud-tpu/1.2.0/Google-Cloud-Tpu)\n- [1.1.0](/ruby/docs/reference/google-cloud-tpu/1.1.0/Google-Cloud-Tpu)\n- [1.0.1](/ruby/docs/reference/google-cloud-tpu/1.0.1/Google-Cloud-Tpu) \nReference documentation and code samples for the Cloud TPU API module Google::Cloud::Tpu.\n\nMethods\n-------\n\n### .configure\n\n def self.configure() -\u003e ::Google::Cloud::Config\n\nConfigure the google-cloud-tpu 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.tpu) \n**Returns**\n\n- (::Google::Cloud::Config) --- The default configuration used by this library\n\n### .tpu\n\n def self.tpu(version: :v1, &block) -\u003e ::Object\n\nCreate a new client object for Tpu.\n\n\nBy default, this returns an instance of\n[Google::Cloud::Tpu::V1::Tpu::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-tpu-v1/latest/Google-Cloud-Tpu-V1-Tpu-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 Tpu service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the Tpu service.\nYou can determine whether the method will succeed by calling\n[Tpu.tpu_available?](/ruby/docs/reference/google-cloud-tpu/latest/Google-Cloud-Tpu#Google__Cloud__Tpu_tpu_available__class_ \"Google::Cloud::Tpu.tpu_available? (method)\").\n\n#### About Tpu\n\nManages TPU nodes and other resources\n\n\u003cbr /\u003e\n\nTPU API v1 \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .tpu_available?\n\n def self.tpu_available?(version: :v1) -\u003e boolean\n\nDetermines whether the Tpu service is supported by the current client.\nIf true, you can retrieve a client object by calling [Tpu.tpu](/ruby/docs/reference/google-cloud-tpu/latest/Google-Cloud-Tpu#Google__Cloud__Tpu_tpu_class_ \"Google::Cloud::Tpu.tpu (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 Tpu service,\nor if the versioned client gem needs an update to support the Tpu service. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\nConstants\n---------\n\n### VERSION\n\n**value:**\"1.4.1\""]]