RubyGems - google-cloud-iot-v1 - Versions diffs - 0.7.1 → 0.9.0 - Mend

google-cloud-iot-v1 0.7.1 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

checksums.yaml +4 -4
data/AUTHENTICATION.md +72 -101
data/lib/google/cloud/iot/v1/device_manager/client.rb +41 -9
data/lib/google/cloud/iot/v1/device_manager/rest/client.rb +345 -7
data/lib/google/cloud/iot/v1/device_manager/rest/service_stub.rb +14 -2
data/lib/google/cloud/iot/v1/version.rb +1 -1
data/proto_docs/google/api/client.rb +14 -0
data/proto_docs/google/api/field_behavior.rb +14 -0
metadata +5 -5

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8f967a178d0aa1ab9085fd46d29f1a4b088d8032128e84c01e630b9f31f9cd9
-  data.tar.gz: d76e1201370252f86d2e583856e91e89404b0706d7be735be7c7ccf0ca1f4440
+  metadata.gz: 1b88921e024e20e7ed21816263b95d8dd097f842b46582cdb841426bc9d5a76e
+  data.tar.gz: eb7861ca0268e283d22d5f7554fdac68940b2842e62be178363643c2c8de2d0c
 SHA512:
-  metadata.gz: 7f21a66a065355626fe1dac2531e367dd76bf4be872234af7c32a607bab39c33ecb9c7e2bcfbd42373df0540c14ec605b1cb5b4f923109ab0e4081fbdbbf5a43
-  data.tar.gz: 676333012b4c8cde3cae624af36c4d759f8df9e4fd81c79e33758a2e36b4e0b5345a22e07d18c48d9233d76bf77c4cd207a6bf6a53f837e56aae3d43bb949b28
+  metadata.gz: 60d1fb49a08d023e88fbfedd9b82e7075fadebda368e6901c87c3b8648e3a93230b16fee573a1ed46625bcc8328b4f0ba1ab20873739c6e4a1b3c4e9b07d25ac
+  data.tar.gz: 77e5d40a6080894b9698c9738c9e522117cb046831f4ff597f973dbf0f880c117699070495061e03baad281b5a57c43c9eb6257a55536d362ab5786cdcc7dee7

data/AUTHENTICATION.md CHANGED Viewed

@@ -1,151 +1,122 @@
 # Authentication
-In general, the google-cloud-iot-v1 library uses
-[Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
-credentials to connect to Google Cloud services. When running within
-[Google Cloud Platform environments](#google-cloud-platform-environments) the
-credentials will be discovered automatically. When running on other
-environments, the Service Account credentials can be specified by providing the
-path to the
-[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
-for the account (or the JSON itself) in
-[environment variables](#environment-variables). Additionally, Cloud SDK
-credentials can also be discovered automatically, but this is only recommended
-during development.
+The recommended way to authenticate to the google-cloud-iot-v1 library is to use
+[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
+To review all of your authentication options, see [Credentials lookup](#credential-lookup).
 ## Quickstart
-1. [Create a service account and credentials](#creating-a-service-account).
-2. Set the [environment variable](#environment-variables).
+The following example shows how to set up authentication for a local development
+environment with your user credentials.
-```sh
-export IOT_CREDENTIALS=path/to/keyfile.json
-```
-3. Initialize the client.
+**NOTE:** This method is _not_ recommended for running in production. User credentials
+should be used only during development.
-```ruby
-require "google/cloud/iot/v1"
+1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
+2. Set up a local ADC file with your user credentials:
-client = ::Google::Cloud::Iot::V1::DeviceManager::Client.new
+```sh
+gcloud auth application-default login
 ```
-## Credential Lookup
-The google-cloud-iot-v1 library aims to make authentication
-as simple as possible, and provides several mechanisms to configure your system
-without requiring **Service Account Credentials** directly in code.
-**Credentials** are discovered in the following order:
-1. Specify credentials in method arguments
-2. Specify credentials in configuration
-3. Discover credentials path in environment variables
-4. Discover credentials JSON in environment variables
-5. Discover credentials file in the Cloud SDK's path
-6. Discover GCP credentials
-### Google Cloud Platform environments
+3. Write code as if already authenticated.
-When running on Google Cloud Platform (GCP), including Google Compute Engine
-(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
-Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
-Code should be written as if already authenticated.
+For more information about setting up authentication for a local development environment, see
+[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
-### Environment Variables
+## Credential Lookup
-The **Credentials JSON** can be placed in environment variables instead of
-declaring them directly in code. Each service has its own environment variable,
-allowing for different service accounts to be used for different services. (See
-the READMEs for the individual service gems for details.) The path to the
-**Credentials JSON** file can be stored in the environment variable, or the
-**Credentials JSON** itself can be stored for environments such as Docker
-containers where writing files is difficult or not encouraged.
+The google-cloud-iot-v1 library provides several mechanisms to configure your system.
+Generally, using Application Default Credentials to facilitate automatic
+credentials discovery is the easist method. But if you need to explicitly specify
+credentials, there are several methods available to you.
-The environment variables that google-cloud-iot-v1
-checks for credentials are configured on the service Credentials class (such as
-{::Google::Cloud::Iot::V1::DeviceManager::Credentials}):
+Credentials are accepted in the following ways, in the following order or precedence:
-* `IOT_CREDENTIALS` - Path to JSON file, or JSON contents
-* `IOT_KEYFILE` - Path to JSON file, or JSON contents
-* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+1. Credentials specified in method arguments
+2. Credentials specified in configuration
+3. Credentials pointed to or included in environment variables
+4. Credentials found in local ADC file
+5. Credentials returned by the metadata server for the attached service account (GCP)
-```ruby
-require "google/cloud/iot/v1"
-ENV["IOT_CREDENTIALS"] = "path/to/keyfile.json"
+### Configuration
-client = ::Google::Cloud::Iot::V1::DeviceManager::Client.new
-```
+You can configure a path to a JSON credentials file, either for an individual client object or
+globally, for all client objects. The JSON file can contain credentials created for
+[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
+[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
+[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
-### Configuration
+Note: Service account keys are a security risk if not managed correctly. You should
+[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
+whenever possible.
-The path to the **Credentials JSON** file can be configured instead of storing
-it in an environment variable. Either on an individual client initialization:
+To configure a credentials file for an individual client initialization:
 ```ruby
 require "google/cloud/iot/v1"
 client = ::Google::Cloud::Iot::V1::DeviceManager::Client.new do |config|
-  config.credentials = "path/to/keyfile.json"
+  config.credentials = "path/to/credentialfile.json"
 end
 ```
-Or globally for all clients:
+To configure a credentials file globally for all clients:
 ```ruby
 require "google/cloud/iot/v1"
 ::Google::Cloud::Iot::V1::DeviceManager::Client.configure do |config|
-  config.credentials = "path/to/keyfile.json"
+  config.credentials = "path/to/credentialfile.json"
 end
 client = ::Google::Cloud::Iot::V1::DeviceManager::Client.new
 ```
-### Cloud SDK
+### Environment Variables
-This option allows for an easy way to authenticate during development. If
-credentials are not provided in code or in environment variables, then Cloud SDK
-credentials are discovered.
+You can also use an environment variable to provide a JSON credentials file.
+The environment variable can contain a path to the credentials file or, for
+environments such as Docker containers where writing files is not encouraged,
+you can include the credentials file itself.
-To configure your system for this, simply:
+The JSON file can contain credentials created for
+[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
+[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
+[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
-1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
-2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
-3. Write code as if already authenticated.
+Note: Service account keys are a security risk if not managed correctly. You should
+[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
+whenever possible.
+The environment variables that google-cloud-iot-v1
+checks for credentials are:
-**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
-*should* only be used during development.
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
-## Creating a Service Account
+```ruby
+require "google/cloud/iot/v1"
-Google Cloud requires **Service Account Credentials** to
-connect to the APIs. You will use the **JSON key file** to
-connect to most services with google-cloud-iot-v1.
+ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
-If you are not running this client within
-[Google Cloud Platform environments](#google-cloud-platform-environments), you
-need a Google Developers service account.
+client = ::Google::Cloud::Iot::V1::DeviceManager::Client.new
+```
-1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
-2. Create a new project or click on an existing project.
-3. Activate the menu in the upper left and select **APIs & Services**. From
-   here, you will enable the APIs that your application requires.
+### Local ADC file
-   *Note: You may need to enable billing in order to use these services.*
+You can set up a local ADC file with your user credentials for authentication during
+development. If credentials are not provided in code or in environment variables,
+then the local ADC credentials are discovered.
-4. Select **Credentials** from the side navigation.
+Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
-   Find the "Create credentials" drop down near the top of the page, and select
-   "Service account" to be guided through downloading a new JSON key file.
+### Google Cloud Platform environments
-   If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, click the pencil
-   tool on the right side to edit the service account, select the **Keys** tab,
-   and then select **Add Key**.
+When running on Google Cloud Platform (GCP), including Google Compute Engine
+(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
+Functions (GCF) and Cloud Run, credentials are retrieved from the attached
+service account automatically. Code should be written as if already authenticated.
-   The key file you download will be used by this library to authenticate API
-   requests and should be stored in a secure location.
+For more information, see
+[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).

data/lib/google/cloud/iot/v1/device_manager/client.rb CHANGED Viewed

@@ -30,6 +30,9 @@ module Google
           # Internet of Things (IoT) service. Securely connect and manage IoT devices.
           #
           class Client
+            # @private
+            DEFAULT_ENDPOINT_TEMPLATE = "cloudiot.$UNIVERSE_DOMAIN$"
             include Paths
             # @private
@@ -158,6 +161,15 @@ module Google
               @config
             end
+            ##
+            # The effective universe domain
+            #
+            # @return [String]
+            #
+            def universe_domain
+              @device_manager_stub.universe_domain
+            end
             ##
             # Create a new DeviceManager client object.
             #
@@ -191,8 +203,9 @@ module Google
               credentials = @config.credentials
               # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
-                                       !@config.endpoint.split(".").first.include?("-")
+              enable_self_signed_jwt = @config.endpoint.nil? ||
+                                       (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
+                                       !@config.endpoint.split(".").first.include?("-"))
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
               if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -203,10 +216,13 @@ module Google
               @device_manager_stub = ::Gapic::ServiceStub.new(
                 ::Google::Cloud::Iot::V1::DeviceManager::Stub,
-                credentials:  credentials,
-                endpoint:     @config.endpoint,
+                credentials: credentials,
+                endpoint: @config.endpoint,
+                endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+                universe_domain: @config.universe_domain,
                 channel_args: @config.channel_args,
-                interceptors: @config.interceptors
+                interceptors: @config.interceptors,
+                channel_pool_config: @config.channel_pool
               )
             end
@@ -2028,9 +2044,9 @@ module Google
             #   end
             #
             # @!attribute [rw] endpoint
-            #   The hostname or hostname:port of the service endpoint.
-            #   Defaults to `"cloudiot.googleapis.com"`.
-            #   @return [::String]
+            #   A custom service endpoint, as a hostname or hostname:port. The default is
+            #   nil, indicating to use the default endpoint in the current universe domain.
+            #   @return [::String,nil]
             # @!attribute [rw] credentials
             #   Credentials to send with calls. You may provide any of the following types:
             #    *  (`String`) The path to a service account key file in JSON format
@@ -2076,13 +2092,20 @@ module Google
             # @!attribute [rw] quota_project
             #   A separate project against which to charge quota.
             #   @return [::String]
+            # @!attribute [rw] universe_domain
+            #   The universe domain within which to make requests. This determines the
+            #   default endpoint URL. The default value of nil uses the environment
+            #   universe (usually the default "googleapis.com" universe).
+            #   @return [::String,nil]
             #
             class Configuration
               extend ::Gapic::Config
+              # @private
+              # The endpoint specific to the default "googleapis.com" universe. Deprecated.
               DEFAULT_ENDPOINT = "cloudiot.googleapis.com"
-              config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
+              config_attr :endpoint,      nil, ::String, nil
               config_attr :credentials,   nil do |value|
                 allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                 allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -2097,6 +2120,7 @@ module Google
               config_attr :metadata,      nil, ::Hash, nil
               config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
               config_attr :quota_project, nil, ::String, nil
+              config_attr :universe_domain, nil, ::String, nil
               # @private
               def initialize parent_config = nil
@@ -2117,6 +2141,14 @@ module Google
                 end
               end
+              ##
+              # Configuration for the channel pool
+              # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+              #
+              def channel_pool
+                @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+              end
               ##
               # Configuration RPC class for the DeviceManager API.
               #

data/lib/google/cloud/iot/v1/device_manager/rest/client.rb CHANGED Viewed

@@ -32,6 +32,9 @@ module Google
             # Internet of Things (IoT) service. Securely connect and manage IoT devices.
             #
             class Client
+              # @private
+              DEFAULT_ENDPOINT_TEMPLATE = "cloudiot.$UNIVERSE_DOMAIN$"
               include Paths
               # @private
@@ -160,6 +163,15 @@ module Google
                 @config
               end
+              ##
+              # The effective universe domain
+              #
+              # @return [String]
+              #
+              def universe_domain
+                @device_manager_stub.universe_domain
+              end
               ##
               # Create a new DeviceManager REST client object.
               #
@@ -187,8 +199,9 @@ module Google
                 credentials = @config.credentials
                 # Use self-signed JWT if the endpoint is unchanged from default,
                 # but only if the default endpoint does not have a region prefix.
-                enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
-                                         !@config.endpoint.split(".").first.include?("-")
+                enable_self_signed_jwt = @config.endpoint.nil? ||
+                                         (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
+                                         !@config.endpoint.split(".").first.include?("-"))
                 credentials ||= Credentials.default scope: @config.scope,
                                                     enable_self_signed_jwt: enable_self_signed_jwt
                 if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -198,7 +211,12 @@ module Google
                 @quota_project_id = @config.quota_project
                 @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
-                @device_manager_stub = ::Google::Cloud::Iot::V1::DeviceManager::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
+                @device_manager_stub = ::Google::Cloud::Iot::V1::DeviceManager::Rest::ServiceStub.new(
+                  endpoint: @config.endpoint,
+                  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+                  universe_domain: @config.universe_domain,
+                  credentials: credentials
+                )
               end
               # Service calls
@@ -235,6 +253,22 @@ module Google
               # @return [::Google::Cloud::Iot::V1::DeviceRegistry]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/iot/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Iot::V1::DeviceManager::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Iot::V1::CreateDeviceRegistryRequest.new
+              #
+              #   # Call the create_device_registry method.
+              #   result = client.create_device_registry request
+              #
+              #   # The returned object is of type Google::Cloud::Iot::V1::DeviceRegistry.
+              #   p result
+              #
               def create_device_registry request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
@@ -298,6 +332,22 @@ module Google
               # @return [::Google::Cloud::Iot::V1::DeviceRegistry]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/iot/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Iot::V1::DeviceManager::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Iot::V1::GetDeviceRegistryRequest.new
+              #
+              #   # Call the get_device_registry method.
+              #   result = client.get_device_registry request
+              #
+              #   # The returned object is of type Google::Cloud::Iot::V1::DeviceRegistry.
+              #   p result
+              #
               def get_device_registry request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
@@ -368,6 +418,22 @@ module Google
               # @return [::Google::Cloud::Iot::V1::DeviceRegistry]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/iot/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Iot::V1::DeviceManager::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Iot::V1::UpdateDeviceRegistryRequest.new
+              #
+              #   # Call the update_device_registry method.
+              #   result = client.update_device_registry request
+              #
+              #   # The returned object is of type Google::Cloud::Iot::V1::DeviceRegistry.
+              #   p result
+              #
               def update_device_registry request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
@@ -431,6 +497,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/iot/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Iot::V1::DeviceManager::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Iot::V1::DeleteDeviceRegistryRequest.new
+              #
+              #   # Call the delete_device_registry method.
+              #   result = client.delete_device_registry request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_device_registry request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
@@ -503,6 +585,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Iot::V1::DeviceRegistry>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/iot/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Iot::V1::DeviceManager::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Iot::V1::ListDeviceRegistriesRequest.new
+              #
+              #   # Call the list_device_registries method.
+              #   result = client.list_device_registries request
+              #
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
+              #     # Each element is of type ::Google::Cloud::Iot::V1::DeviceRegistry.
+              #     p item
+              #   end
+              #
               def list_device_registries request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
@@ -572,6 +674,22 @@ module Google
               # @return [::Google::Cloud::Iot::V1::Device]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/iot/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Iot::V1::DeviceManager::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Iot::V1::CreateDeviceRequest.new
+              #
+              #   # Call the create_device method.
+              #   result = client.create_device request
+              #
+              #   # The returned object is of type Google::Cloud::Iot::V1::Device.
+              #   p result
+              #
               def create_device request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
@@ -640,6 +758,22 @@ module Google
               # @return [::Google::Cloud::Iot::V1::Device]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/iot/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Iot::V1::DeviceManager::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Iot::V1::GetDeviceRequest.new
+              #
+              #   # Call the get_device method.
+              #   result = client.get_device request
+              #
+              #   # The returned object is of type Google::Cloud::Iot::V1::Device.
+              #   p result
+              #
               def get_device request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
@@ -710,6 +844,22 @@ module Google
               # @return [::Google::Cloud::Iot::V1::Device]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/iot/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Iot::V1::DeviceManager::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Iot::V1::UpdateDeviceRequest.new
+              #
+              #   # Call the update_device method.
+              #   result = client.update_device request
+              #
+              #   # The returned object is of type Google::Cloud::Iot::V1::Device.
+              #   p result
+              #
               def update_device request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
@@ -774,6 +924,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/iot/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Iot::V1::DeviceManager::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Iot::V1::DeleteDeviceRequest.new
+              #
+              #   # Call the delete_device method.
+              #   result = client.delete_device request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_device request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
@@ -859,6 +1025,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Iot::V1::Device>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/iot/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Iot::V1::DeviceManager::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Iot::V1::ListDevicesRequest.new
+              #
+              #   # Call the list_devices method.
+              #   result = client.list_devices request
+              #
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
+              #     # Each element is of type ::Google::Cloud::Iot::V1::Device.
+              #     p item
+              #   end
+              #
               def list_devices request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
@@ -934,6 +1120,22 @@ module Google
               # @return [::Google::Cloud::Iot::V1::DeviceConfig]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/iot/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Iot::V1::DeviceManager::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Iot::V1::ModifyCloudToDeviceConfigRequest.new
+              #
+              #   # Call the modify_cloud_to_device_config method.
+              #   result = client.modify_cloud_to_device_config request
+              #
+              #   # The returned object is of type Google::Cloud::Iot::V1::DeviceConfig.
+              #   p result
+              #
               def modify_cloud_to_device_config request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
@@ -1003,6 +1205,22 @@ module Google
               # @return [::Google::Cloud::Iot::V1::ListDeviceConfigVersionsResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/iot/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Iot::V1::DeviceManager::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Iot::V1::ListDeviceConfigVersionsRequest.new
+              #
+              #   # Call the list_device_config_versions method.
+              #   result = client.list_device_config_versions request
+              #
+              #   # The returned object is of type Google::Cloud::Iot::V1::ListDeviceConfigVersionsResponse.
+              #   p result
+              #
               def list_device_config_versions request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
@@ -1072,6 +1290,22 @@ module Google
               # @return [::Google::Cloud::Iot::V1::ListDeviceStatesResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/iot/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Iot::V1::DeviceManager::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Iot::V1::ListDeviceStatesRequest.new
+              #
+              #   # Call the list_device_states method.
+              #   result = client.list_device_states request
+              #
+              #   # The returned object is of type Google::Cloud::Iot::V1::ListDeviceStatesResponse.
+              #   p result
+              #
               def list_device_states request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
@@ -1147,6 +1381,22 @@ module Google
               # @return [::Google::Iam::V1::Policy]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/iot/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Iot::V1::DeviceManager::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Iam::V1::SetIamPolicyRequest.new
+              #
+              #   # Call the set_iam_policy method.
+              #   result = client.set_iam_policy request
+              #
+              #   # The returned object is of type Google::Iam::V1::Policy.
+              #   p result
+              #
               def set_iam_policy request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
@@ -1215,6 +1465,22 @@ module Google
               # @return [::Google::Iam::V1::Policy]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/iot/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Iot::V1::DeviceManager::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Iam::V1::GetIamPolicyRequest.new
+              #
+              #   # Call the get_iam_policy method.
+              #   result = client.get_iam_policy request
+              #
+              #   # The returned object is of type Google::Iam::V1::Policy.
+              #   p result
+              #
               def get_iam_policy request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
@@ -1285,6 +1551,22 @@ module Google
               # @return [::Google::Iam::V1::TestIamPermissionsResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/iot/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Iot::V1::DeviceManager::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Iam::V1::TestIamPermissionsRequest.new
+              #
+              #   # Call the test_iam_permissions method.
+              #   result = client.test_iam_permissions request
+              #
+              #   # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
+              #   p result
+              #
               def test_iam_permissions request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
@@ -1369,6 +1651,22 @@ module Google
               # @return [::Google::Cloud::Iot::V1::SendCommandToDeviceResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/iot/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Iot::V1::DeviceManager::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Iot::V1::SendCommandToDeviceRequest.new
+              #
+              #   # Call the send_command_to_device method.
+              #   result = client.send_command_to_device request
+              #
+              #   # The returned object is of type Google::Cloud::Iot::V1::SendCommandToDeviceResponse.
+              #   p result
+              #
               def send_command_to_device request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
@@ -1439,6 +1737,22 @@ module Google
               # @return [::Google::Cloud::Iot::V1::BindDeviceToGatewayResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/iot/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Iot::V1::DeviceManager::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Iot::V1::BindDeviceToGatewayRequest.new
+              #
+              #   # Call the bind_device_to_gateway method.
+              #   result = client.bind_device_to_gateway request
+              #
+              #   # The returned object is of type Google::Cloud::Iot::V1::BindDeviceToGatewayResponse.
+              #   p result
+              #
               def bind_device_to_gateway request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
@@ -1509,6 +1823,22 @@ module Google
               # @return [::Google::Cloud::Iot::V1::UnbindDeviceFromGatewayResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/iot/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Iot::V1::DeviceManager::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Iot::V1::UnbindDeviceFromGatewayRequest.new
+              #
+              #   # Call the unbind_device_from_gateway method.
+              #   result = client.unbind_device_from_gateway request
+              #
+              #   # The returned object is of type Google::Cloud::Iot::V1::UnbindDeviceFromGatewayResponse.
+              #   p result
+              #
               def unbind_device_from_gateway request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
@@ -1574,9 +1904,9 @@ module Google
               #   end
               #
               # @!attribute [rw] endpoint
-              #   The hostname or hostname:port of the service endpoint.
-              #   Defaults to `"cloudiot.googleapis.com"`.
-              #   @return [::String]
+              #   A custom service endpoint, as a hostname or hostname:port. The default is
+              #   nil, indicating to use the default endpoint in the current universe domain.
+              #   @return [::String,nil]
               # @!attribute [rw] credentials
               #   Credentials to send with calls. You may provide any of the following types:
               #    *  (`String`) The path to a service account key file in JSON format
@@ -1613,13 +1943,20 @@ module Google
               # @!attribute [rw] quota_project
               #   A separate project against which to charge quota.
               #   @return [::String]
+              # @!attribute [rw] universe_domain
+              #   The universe domain within which to make requests. This determines the
+              #   default endpoint URL. The default value of nil uses the environment
+              #   universe (usually the default "googleapis.com" universe).
+              #   @return [::String,nil]
               #
               class Configuration
                 extend ::Gapic::Config
+                # @private
+                # The endpoint specific to the default "googleapis.com" universe. Deprecated.
                 DEFAULT_ENDPOINT = "cloudiot.googleapis.com"
-                config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
+                config_attr :endpoint,      nil, ::String, nil
                 config_attr :credentials,   nil do |value|
                   allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                   allowed.any? { |klass| klass === value }
@@ -1631,6 +1968,7 @@ module Google
                 config_attr :metadata,      nil, ::Hash, nil
                 config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
                 config_attr :quota_project, nil, ::String, nil
+                config_attr :universe_domain, nil, ::String, nil
                 # @private
                 def initialize parent_config = nil

data/lib/google/cloud/iot/v1/device_manager/rest/service_stub.rb CHANGED Viewed

@@ -30,16 +30,28 @@ module Google
             # including transcoding, making the REST call, and deserialing the response.
             #
             class ServiceStub
-              def initialize endpoint:, credentials:
+              def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
                 # These require statements are intentionally placed here to initialize
                 # the REST modules only when it's required.
                 require "gapic/rest"
-                @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
+                @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
+                                                             endpoint_template: endpoint_template,
+                                                             universe_domain: universe_domain,
+                                                             credentials: credentials,
                                                              numeric_enums: true,
                                                              raise_faraday_errors: false
               end
+              ##
+              # The effective universe domain
+              #
+              # @return [String]
+              #
+              def universe_domain
+                @client_stub.universe_domain
+              end
               ##
               # Baseline implementation for the create_device_registry REST call
               #

data/lib/google/cloud/iot/v1/version.rb CHANGED Viewed

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Iot
       module V1
-        VERSION = "0.7.1"
+        VERSION = "0.9.0"
       end
     end
   end

data/proto_docs/google/api/client.rb CHANGED Viewed

@@ -21,6 +21,7 @@ module Google
   module Api
     # Required information for every language.
     # @!attribute [rw] reference_docs_uri
+    #   @deprecated This field is deprecated and may be removed in the next major version update.
     #   @return [::String]
     #     Link to automatically generated reference documentation.  Example:
     #     https://cloud.google.com/nodejs/docs/reference/asset/latest
@@ -304,6 +305,19 @@ module Google
     #                seconds: 360 # 6 minutes
     #              total_poll_timeout:
     #                 seconds: 54000 # 90 minutes
+    # @!attribute [rw] auto_populated_fields
+    #   @return [::Array<::String>]
+    #     List of top-level fields of the request message, that should be
+    #     automatically populated by the client libraries based on their
+    #     (google.api.field_info).format. Currently supported format: UUID4.
+    #
+    #     Example of a YAML configuration:
+    #
+    #      publishing:
+    #        method_settings:
+    #          - selector: google.example.v1.ExampleService.CreateExample
+    #            auto_populated_fields:
+    #            - request_id
     class MethodSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/api/field_behavior.rb CHANGED Viewed

@@ -66,6 +66,20 @@ module Google
       # a non-empty value will be returned. The user will not be aware of what
       # non-empty value to expect.
       NON_EMPTY_DEFAULT = 7
+      # Denotes that the field in a resource (a message annotated with
+      # google.api.resource) is used in the resource name to uniquely identify the
+      # resource. For AIP-compliant APIs, this should only be applied to the
+      # `name` field on the resource.
+      #
+      # This behavior should not be applied to references to other resources within
+      # the message.
+      #
+      # The identifier field of resources often have different field behavior
+      # depending on the request it is embedded in (e.g. for Create methods name
+      # is optional and unused, while for Update methods it is required). Instead
+      # of method-specific annotations, only `IDENTIFIER` is required.
+      IDENTIFIER = 8
     end
   end
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-iot-v1
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Google LLC
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-04 00:00:00.000000000 Z
+date: 2024-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.21.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.21.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -233,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Registers and manages IoT (Internet of Things) devices that connect to the