Reference documentation and code samples for the Cloud IoT API module Google::Cloud::Iot.
Methods
.configure
defself.configure()->::Google::Cloud::Config
Configure the google-cloud-iot 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.iot)
Returns
(::Google::Cloud::Config) — The default configuration used by this library
By default, this returns an instance ofGoogle::Cloud::Iot::V1::DeviceManager::Clientfor a gRPC client for version V1 of the API.
However, you can specify a different API version by passing it in theversionparameter. If the DeviceManager 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:restor:grpcin
thetransportparameter.
About DeviceManager
Internet of Things (IoT) service. Securely connect and manage IoT devices.
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.
[[["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 IoT API - Module Google::Cloud::Iot (v1.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.0 (latest)](/ruby/docs/reference/google-cloud-iot/latest/Google-Cloud-Iot)\n- [1.2.0](/ruby/docs/reference/google-cloud-iot/1.2.0/Google-Cloud-Iot)\n- [1.1.0](/ruby/docs/reference/google-cloud-iot/1.1.0/Google-Cloud-Iot)\n- [1.0.3](/ruby/docs/reference/google-cloud-iot/1.0.3/Google-Cloud-Iot) \nReference documentation and code samples for the Cloud IoT API module Google::Cloud::Iot.\n\nMethods\n-------\n\n### .configure\n\n def self.configure() -\u003e ::Google::Cloud::Config\n\nConfigure the google-cloud-iot 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.iot) \n**Returns**\n\n- (::Google::Cloud::Config) --- The default configuration used by this library\n\n### .device_manager\n\n def self.device_manager(version: :v1, transport: :grpc, &block) -\u003e ::Object\n\nCreate a new client object for DeviceManager.\n\n\n\u003cbr /\u003e\n\nBy default, this returns an instance of\n[Google::Cloud::Iot::V1::DeviceManager::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-iot-v1/latest/Google-Cloud-Iot-V1-DeviceManager-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 DeviceManager 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\n#### About DeviceManager\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nInternet of Things (IoT) service. Securely connect and manage IoT devices. \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\nConstants\n---------\n\n### VERSION\n\n**value:**\"1.3.0\""]]