Class: Google::Cloud::Iot::V1::DeviceManager::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/iot/v1/device_manager/client.rb

Overview

Client for the DeviceManager service.

Internet of Things (IoT) service. Securely connect and manage IoT devices.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#device_path, #location_path, #registry_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new DeviceManager client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Iot::V1::DeviceManager::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Iot::V1::DeviceManager::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the DeviceManager client.

Yield Parameters:



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 189

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/iot/v1/device_manager_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  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.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)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @device_manager_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Iot::V1::DeviceManager::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the DeviceManager Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all DeviceManager clients
::Google::Cloud::Iot::V1::DeviceManager::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 59

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Iot", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.create_device_registry.timeout = 120.0

    default_config.rpcs.get_device_registry.timeout = 120.0
    default_config.rpcs.get_device_registry.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.update_device_registry.timeout = 120.0

    default_config.rpcs.delete_device_registry.timeout = 120.0
    default_config.rpcs.delete_device_registry.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_device_registries.timeout = 120.0
    default_config.rpcs.list_device_registries.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.create_device.timeout = 120.0

    default_config.rpcs.get_device.timeout = 120.0
    default_config.rpcs.get_device.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.update_device.timeout = 120.0

    default_config.rpcs.delete_device.timeout = 120.0
    default_config.rpcs.delete_device.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_devices.timeout = 120.0
    default_config.rpcs.list_devices.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.modify_cloud_to_device_config.timeout = 120.0
    default_config.rpcs.modify_cloud_to_device_config.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4, 8]
    }

    default_config.rpcs.list_device_config_versions.timeout = 120.0
    default_config.rpcs.list_device_config_versions.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_device_states.timeout = 120.0
    default_config.rpcs.list_device_states.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.set_iam_policy.timeout = 120.0

    default_config.rpcs.get_iam_policy.timeout = 120.0

    default_config.rpcs.test_iam_permissions.timeout = 120.0

    default_config.rpcs.send_command_to_device.timeout = 120.0
    default_config.rpcs.send_command_to_device.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4, 8]
    }

    default_config.rpcs.bind_device_to_gateway.timeout = 120.0

    default_config.rpcs.unbind_device_from_gateway.timeout = 120.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#bind_device_to_gateway(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::BindDeviceToGatewayResponse #bind_device_to_gateway(parent: nil, gateway_id: nil, device_id: nil) ⇒ ::Google::Cloud::Iot::V1::BindDeviceToGatewayResponse

Associates the device with the gateway.

Examples:

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::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

Overloads:

  • #bind_device_to_gateway(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::BindDeviceToGatewayResponse

    Pass arguments to bind_device_to_gateway via a request object, either of type BindDeviceToGatewayRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Iot::V1::BindDeviceToGatewayRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #bind_device_to_gateway(parent: nil, gateway_id: nil, device_id: nil) ⇒ ::Google::Cloud::Iot::V1::BindDeviceToGatewayResponse

    Pass arguments to bind_device_to_gateway via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The name of the registry. For example, projects/example-project/locations/us-central1/registries/my-registry.

    • gateway_id (::String) (defaults to: nil) —

      Required. The value of gateway_id can be either the device numeric ID or the user-defined device identifier.

    • device_id (::String) (defaults to: nil) —

      Required. The device to associate with the specified gateway. The value of device_id can be either the device numeric ID or the user-defined device identifier.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 1883

def bind_device_to_gateway request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Iot::V1::BindDeviceToGatewayRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.bind_device_to_gateway.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Iot::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.bind_device_to_gateway.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.bind_device_to_gateway.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @device_manager_stub.call_rpc :bind_device_to_gateway, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

Configure the DeviceManager Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



159
160
161
162
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 159

def configure
  yield @config if block_given?
  @config
end

#create_device(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::Device #create_device(parent: nil, device: nil) ⇒ ::Google::Cloud::Iot::V1::Device

Creates a device in a device registry.

Examples:

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::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

Overloads:

  • #create_device(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::Device

    Pass arguments to create_device via a request object, either of type CreateDeviceRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Iot::V1::CreateDeviceRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_device(parent: nil, device: nil) ⇒ ::Google::Cloud::Iot::V1::Device

    Pass arguments to create_device via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The name of the device registry where this device should be created. For example, projects/example-project/locations/us-central1/registries/my-registry.

    • device (::Google::Cloud::Iot::V1::Device, ::Hash) (defaults to: nil) —

      Required. The device registration details. The field name must be empty. The server generates name from the device registry id and the parent field.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 736

def create_device request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Iot::V1::CreateDeviceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_device.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Iot::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_device.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_device.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @device_manager_stub.call_rpc :create_device, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_device_registry(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::DeviceRegistry #create_device_registry(parent: nil, device_registry: nil) ⇒ ::Google::Cloud::Iot::V1::DeviceRegistry

Creates a device registry that contains devices.

Examples:

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::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

Overloads:

  • #create_device_registry(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::DeviceRegistry

    Pass arguments to create_device_registry via a request object, either of type CreateDeviceRegistryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Iot::V1::CreateDeviceRegistryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_device_registry(parent: nil, device_registry: nil) ⇒ ::Google::Cloud::Iot::V1::DeviceRegistry

    Pass arguments to create_device_registry via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The project and cloud region where this device registry must be created. For example, projects/example-project/locations/us-central1.

    • device_registry (::Google::Cloud::Iot::V1::DeviceRegistry, ::Hash) (defaults to: nil) —

      Required. The device registry. The field name must be empty. The server will generate that field from the device registry id provided and the parent field.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 280

def create_device_registry request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Iot::V1::CreateDeviceRegistryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_device_registry.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Iot::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_device_registry.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_device_registry.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @device_manager_stub.call_rpc :create_device_registry, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_device(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_device(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a device.

Examples:

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::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

Overloads:

  • #delete_device(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_device via a request object, either of type Google::Cloud::Iot::V1::DeleteDeviceRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Iot::V1::DeleteDeviceRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_device(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_device via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the device. For example, projects/p0/locations/us-central1/registries/registry0/devices/device0 or projects/p0/locations/us-central1/registries/registry0/devices/{num_id}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 1007

def delete_device request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Iot::V1::DeleteDeviceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_device.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Iot::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_device.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_device.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @device_manager_stub.call_rpc :delete_device, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_device_registry(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_device_registry(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a device registry configuration.

Examples:

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::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

Overloads:

  • #delete_device_registry(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_device_registry via a request object, either of type Google::Cloud::Iot::V1::DeleteDeviceRegistryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Iot::V1::DeleteDeviceRegistryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_device_registry(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_device_registry via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the device registry. For example, projects/example-project/locations/us-central1/registries/my-registry.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 545

def delete_device_registry request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Iot::V1::DeleteDeviceRegistryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_device_registry.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Iot::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_device_registry.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_device_registry.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @device_manager_stub.call_rpc :delete_device_registry, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_device(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::Device #get_device(name: nil, field_mask: nil) ⇒ ::Google::Cloud::Iot::V1::Device

Gets details about a device.

Examples:

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::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

Overloads:

  • #get_device(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::Device

    Pass arguments to get_device via a request object, either of type GetDeviceRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Iot::V1::GetDeviceRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_device(name: nil, field_mask: nil) ⇒ ::Google::Cloud::Iot::V1::Device

    Pass arguments to get_device via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the device. For example, projects/p0/locations/us-central1/registries/registry0/devices/device0 or projects/p0/locations/us-central1/registries/registry0/devices/{num_id}.

    • field_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      The fields of the Device resource to be returned in the response. If the field mask is unset or empty, all fields are returned. Fields have to be provided in snake_case format, for example: last_heartbeat_time.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 827

def get_device request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Iot::V1::GetDeviceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_device.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Iot::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_device.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_device.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @device_manager_stub.call_rpc :get_device, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_device_registry(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::DeviceRegistry #get_device_registry(name: nil) ⇒ ::Google::Cloud::Iot::V1::DeviceRegistry

Gets a device registry configuration.

Examples:

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::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

Overloads:

  • #get_device_registry(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::DeviceRegistry

    Pass arguments to get_device_registry via a request object, either of type GetDeviceRegistryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Iot::V1::GetDeviceRegistryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_device_registry(name: nil) ⇒ ::Google::Cloud::Iot::V1::DeviceRegistry

    Pass arguments to get_device_registry via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the device registry. For example, projects/example-project/locations/us-central1/registries/my-registry.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 366

def get_device_registry request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Iot::V1::GetDeviceRegistryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_device_registry.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Iot::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_device_registry.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_device_registry.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @device_manager_stub.call_rpc :get_device_registry, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_iam_policy(request, options = nil) ⇒ ::Google::Iam::V1::Policy #get_iam_policy(resource: nil, options: nil) ⇒ ::Google::Iam::V1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Examples:

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::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

Overloads:

  • #get_iam_policy(request, options = nil) ⇒ ::Google::Iam::V1::Policy

    Pass arguments to get_iam_policy via a request object, either of type Iam::V1::GetIamPolicyRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Iam::V1::GetIamPolicyRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_iam_policy(resource: nil, options: nil) ⇒ ::Google::Iam::V1::Policy

    Pass arguments to get_iam_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • resource (::String) (defaults to: nil) —

      REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

    • options (::Google::Iam::V1::GetPolicyOptions, ::Hash) (defaults to: nil) —

      OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 1590

def get_iam_policy request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::GetIamPolicyRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_iam_policy.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Iot::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.resource
    header_params["resource"] = request.resource
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_iam_policy.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_iam_policy.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @device_manager_stub.call_rpc :get_iam_policy, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_device_config_versions(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::ListDeviceConfigVersionsResponse #list_device_config_versions(name: nil, num_versions: nil) ⇒ ::Google::Cloud::Iot::V1::ListDeviceConfigVersionsResponse

Lists the last few versions of the device configuration in descending order (i.e.: newest first).

Examples:

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::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

Overloads:

  • #list_device_config_versions(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::ListDeviceConfigVersionsResponse

    Pass arguments to list_device_config_versions via a request object, either of type ListDeviceConfigVersionsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Iot::V1::ListDeviceConfigVersionsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_device_config_versions(name: nil, num_versions: nil) ⇒ ::Google::Cloud::Iot::V1::ListDeviceConfigVersionsResponse

    Pass arguments to list_device_config_versions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the device. For example, projects/p0/locations/us-central1/registries/registry0/devices/device0 or projects/p0/locations/us-central1/registries/registry0/devices/{num_id}.

    • num_versions (::Integer) (defaults to: nil) —

      The number of versions to list. Versions are listed in decreasing order of the version number. The maximum number of versions retained is 10. If this value is zero, it will return all the versions available.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 1309

def list_device_config_versions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Iot::V1::ListDeviceConfigVersionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_device_config_versions.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Iot::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_device_config_versions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_device_config_versions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @device_manager_stub.call_rpc :list_device_config_versions, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_device_registries(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Iot::V1::DeviceRegistry> #list_device_registries(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Iot::V1::DeviceRegistry>

Lists device registries.

Examples:

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::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

Overloads:

  • #list_device_registries(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Iot::V1::DeviceRegistry>

    Pass arguments to list_device_registries via a request object, either of type ListDeviceRegistriesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Iot::V1::ListDeviceRegistriesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_device_registries(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Iot::V1::DeviceRegistry>

    Pass arguments to list_device_registries via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The project and cloud region path. For example, projects/example-project/locations/us-central1.

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of registries to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty next_page_token in the response indicates that more data is available.

    • page_token (::String) (defaults to: nil) —

      The value returned by the last ListDeviceRegistriesResponse; indicates that this is a continuation of a prior ListDeviceRegistries call and the system should return the next page of data.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 644

def list_device_registries request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Iot::V1::ListDeviceRegistriesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_device_registries.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Iot::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_device_registries.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_device_registries.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @device_manager_stub.call_rpc :list_device_registries, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @device_manager_stub, :list_device_registries, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_device_states(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::ListDeviceStatesResponse #list_device_states(name: nil, num_states: nil) ⇒ ::Google::Cloud::Iot::V1::ListDeviceStatesResponse

Lists the last few versions of the device state in descending order (i.e.: newest first).

Examples:

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::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

Overloads:

  • #list_device_states(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::ListDeviceStatesResponse

    Pass arguments to list_device_states via a request object, either of type ListDeviceStatesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Iot::V1::ListDeviceStatesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_device_states(name: nil, num_states: nil) ⇒ ::Google::Cloud::Iot::V1::ListDeviceStatesResponse

    Pass arguments to list_device_states via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the device. For example, projects/p0/locations/us-central1/registries/registry0/devices/device0 or projects/p0/locations/us-central1/registries/registry0/devices/{num_id}.

    • num_states (::Integer) (defaults to: nil) —

      The number of states to list. States are listed in descending order of update time. The maximum number of states retained is 10. If this value is zero, it will return all the states available.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 1401

def list_device_states request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Iot::V1::ListDeviceStatesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_device_states.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Iot::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_device_states.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_device_states.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @device_manager_stub.call_rpc :list_device_states, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_devices(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Iot::V1::Device> #list_devices(parent: nil, device_num_ids: nil, device_ids: nil, field_mask: nil, gateway_list_options: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Iot::V1::Device>

List devices in a device registry.

Examples:

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::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

Overloads:

  • #list_devices(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Iot::V1::Device>

    Pass arguments to list_devices via a request object, either of type ListDevicesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Iot::V1::ListDevicesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_devices(parent: nil, device_num_ids: nil, device_ids: nil, field_mask: nil, gateway_list_options: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Iot::V1::Device>

    Pass arguments to list_devices via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The device registry path. Required. For example, projects/my-project/locations/us-central1/registries/my-registry.

    • device_num_ids (::Array<::Integer>) (defaults to: nil) —

      A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.

    • device_ids (::Array<::String>) (defaults to: nil) —

      A list of device string IDs. For example, ['device0', 'device12']. If empty, this field is ignored. Maximum IDs: 10,000

    • field_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      The fields of the Device resource to be returned in the response. The fields id and num_id are always returned, along with any other fields specified in snake_case format, for example: last_heartbeat_time.

    • gateway_list_options (::Google::Cloud::Iot::V1::GatewayListOptions, ::Hash) (defaults to: nil) —

      Options related to gateways.

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of devices to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty next_page_token in the response indicates that more data is available.

    • page_token (::String) (defaults to: nil) —

      The value returned by the last ListDevicesResponse; indicates that this is a continuation of a prior ListDevices call and the system should return the next page of data.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 1119

def list_devices request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Iot::V1::ListDevicesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_devices.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Iot::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_devices.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_devices.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @device_manager_stub.call_rpc :list_devices, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @device_manager_stub, :list_devices, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#modify_cloud_to_device_config(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::DeviceConfig #modify_cloud_to_device_config(name: nil, version_to_update: nil, binary_data: nil) ⇒ ::Google::Cloud::Iot::V1::DeviceConfig

Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers. Returns the modified configuration version and its metadata.

Examples:

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::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

Overloads:

  • #modify_cloud_to_device_config(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::DeviceConfig

    Pass arguments to modify_cloud_to_device_config via a request object, either of type ModifyCloudToDeviceConfigRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Iot::V1::ModifyCloudToDeviceConfigRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #modify_cloud_to_device_config(name: nil, version_to_update: nil, binary_data: nil) ⇒ ::Google::Cloud::Iot::V1::DeviceConfig

    Pass arguments to modify_cloud_to_device_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the device. For example, projects/p0/locations/us-central1/registries/registry0/devices/device0 or projects/p0/locations/us-central1/registries/registry0/devices/{num_id}.

    • version_to_update (::Integer) (defaults to: nil) —

      The version number to update. If this value is zero, it will not check the version number of the server and will always update the current version; otherwise, this update will fail if the version number found on the server does not match this version number. This is used to support multiple simultaneous updates without losing data.

    • binary_data (::String) (defaults to: nil) —

      Required. The configuration data for the device.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 1217

def modify_cloud_to_device_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Iot::V1::ModifyCloudToDeviceConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.modify_cloud_to_device_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Iot::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.modify_cloud_to_device_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.modify_cloud_to_device_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @device_manager_stub.call_rpc :modify_cloud_to_device_config, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#send_command_to_device(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::SendCommandToDeviceResponse #send_command_to_device(name: nil, binary_data: nil, subfolder: nil) ⇒ ::Google::Cloud::Iot::V1::SendCommandToDeviceResponse

Sends a command to the specified device. In order for a device to be able to receive commands, it must: 1) be connected to Cloud IoT Core using the MQTT protocol, and 2) be subscribed to the group of MQTT topics specified by /devices/{device-id}/commands/#. This subscription will receive commands at the top-level topic /devices/{device-id}/commands as well as commands for subfolders, like /devices/{device-id}/commands/subfolder. Note that subscribing to specific subfolders is not supported. If the command could not be delivered to the device, this method will return an error; in particular, if the device is not subscribed, this method will return FAILED_PRECONDITION. Otherwise, this method will return OK. If the subscription is QoS 1, at least once delivery will be guaranteed; for QoS 0, no acknowledgment will be expected from the device.

Examples:

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::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

Overloads:

  • #send_command_to_device(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::SendCommandToDeviceResponse

    Pass arguments to send_command_to_device via a request object, either of type SendCommandToDeviceRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Iot::V1::SendCommandToDeviceRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #send_command_to_device(name: nil, binary_data: nil, subfolder: nil) ⇒ ::Google::Cloud::Iot::V1::SendCommandToDeviceResponse

    Pass arguments to send_command_to_device via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the device. For example, projects/p0/locations/us-central1/registries/registry0/devices/device0 or projects/p0/locations/us-central1/registries/registry0/devices/{num_id}.

    • binary_data (::String) (defaults to: nil) —

      Required. The command data to send to the device.

    • subfolder (::String) (defaults to: nil) —

      Optional subfolder for the command. If empty, the command will be delivered to the /devices/{device-id}/commands topic, otherwise it will be delivered to the /devices/{device-id}/commands/{subfolder} topic. Multi-level subfolders are allowed. This field must not have more than 256 characters, and must not contain any MQTT wildcards ("+" or "#") or null characters.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 1790

def send_command_to_device request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Iot::V1::SendCommandToDeviceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.send_command_to_device.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Iot::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.send_command_to_device.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.send_command_to_device.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @device_manager_stub.call_rpc :send_command_to_device, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_iam_policy(request, options = nil) ⇒ ::Google::Iam::V1::Policy #set_iam_policy(resource: nil, policy: nil, update_mask: nil) ⇒ ::Google::Iam::V1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Examples:

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::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

Overloads:

  • #set_iam_policy(request, options = nil) ⇒ ::Google::Iam::V1::Policy

    Pass arguments to set_iam_policy via a request object, either of type Iam::V1::SetIamPolicyRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Iam::V1::SetIamPolicyRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #set_iam_policy(resource: nil, policy: nil, update_mask: nil) ⇒ ::Google::Iam::V1::Policy

    Pass arguments to set_iam_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • resource (::String) (defaults to: nil) —

      REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

    • policy (::Google::Iam::V1::Policy, ::Hash) (defaults to: nil) —

      REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:

      paths: "bindings, etag"

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 1499

def set_iam_policy request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::SetIamPolicyRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.set_iam_policy.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Iot::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.resource
    header_params["resource"] = request.resource
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.set_iam_policy.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.set_iam_policy.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @device_manager_stub.call_rpc :set_iam_policy, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#test_iam_permissions(request, options = nil) ⇒ ::Google::Iam::V1::TestIamPermissionsResponse #test_iam_permissions(resource: nil, permissions: nil) ⇒ ::Google::Iam::V1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Examples:

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::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

Overloads:

  • #test_iam_permissions(request, options = nil) ⇒ ::Google::Iam::V1::TestIamPermissionsResponse

    Pass arguments to test_iam_permissions via a request object, either of type Iam::V1::TestIamPermissionsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Iam::V1::TestIamPermissionsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #test_iam_permissions(resource: nil, permissions: nil) ⇒ ::Google::Iam::V1::TestIamPermissionsResponse

    Pass arguments to test_iam_permissions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • resource (::String) (defaults to: nil) —

      REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

    • permissions (::Array<::String>) (defaults to: nil) —

      The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 1683

def test_iam_permissions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::TestIamPermissionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.test_iam_permissions.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Iot::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.resource
    header_params["resource"] = request.resource
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.test_iam_permissions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.test_iam_permissions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @device_manager_stub.call_rpc :test_iam_permissions, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#unbind_device_from_gateway(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::UnbindDeviceFromGatewayResponse #unbind_device_from_gateway(parent: nil, gateway_id: nil, device_id: nil) ⇒ ::Google::Cloud::Iot::V1::UnbindDeviceFromGatewayResponse

Deletes the association between the device and the gateway.

Examples:

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::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

Overloads:

  • #unbind_device_from_gateway(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::UnbindDeviceFromGatewayResponse

    Pass arguments to unbind_device_from_gateway via a request object, either of type UnbindDeviceFromGatewayRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Iot::V1::UnbindDeviceFromGatewayRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #unbind_device_from_gateway(parent: nil, gateway_id: nil, device_id: nil) ⇒ ::Google::Cloud::Iot::V1::UnbindDeviceFromGatewayResponse

    Pass arguments to unbind_device_from_gateway via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The name of the registry. For example, projects/example-project/locations/us-central1/registries/my-registry.

    • gateway_id (::String) (defaults to: nil) —

      Required. The value of gateway_id can be either the device numeric ID or the user-defined device identifier.

    • device_id (::String) (defaults to: nil) —

      Required. The device to disassociate from the specified gateway. The value of device_id can be either the device numeric ID or the user-defined device identifier.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 1976

def unbind_device_from_gateway request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Iot::V1::UnbindDeviceFromGatewayRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.unbind_device_from_gateway.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Iot::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.unbind_device_from_gateway.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.unbind_device_from_gateway.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @device_manager_stub.call_rpc :unbind_device_from_gateway, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


169
170
171
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 169

def universe_domain
  @device_manager_stub.universe_domain
end

#update_device(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::Device #update_device(device: nil, update_mask: nil) ⇒ ::Google::Cloud::Iot::V1::Device

Updates a device.

Examples:

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::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

Overloads:

  • #update_device(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::Device

    Pass arguments to update_device via a request object, either of type UpdateDeviceRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Iot::V1::UpdateDeviceRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_device(device: nil, update_mask: nil) ⇒ ::Google::Cloud::Iot::V1::Device

    Pass arguments to update_device via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • device (::Google::Cloud::Iot::V1::Device, ::Hash) (defaults to: nil) —

      Required. The new values for the device. The id and num_id fields must be empty, and the field name must specify the name path. For example, projects/p0/locations/us-central1/registries/registry0/devices/device0or projects/p0/locations/us-central1/registries/registry0/devices/{num_id}.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. Only updates the device fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: credentials, blocked, and metadata

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 920

def update_device request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Iot::V1::UpdateDeviceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_device.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Iot::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.device&.name
    header_params["device.name"] = request.device.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_device.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_device.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @device_manager_stub.call_rpc :update_device, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_device_registry(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::DeviceRegistry #update_device_registry(device_registry: nil, update_mask: nil) ⇒ ::Google::Cloud::Iot::V1::DeviceRegistry

Updates a device registry configuration.

Examples:

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::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

Overloads:

  • #update_device_registry(request, options = nil) ⇒ ::Google::Cloud::Iot::V1::DeviceRegistry

    Pass arguments to update_device_registry via a request object, either of type UpdateDeviceRegistryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Iot::V1::UpdateDeviceRegistryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_device_registry(device_registry: nil, update_mask: nil) ⇒ ::Google::Cloud::Iot::V1::DeviceRegistry

    Pass arguments to update_device_registry via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • device_registry (::Google::Cloud::Iot::V1::DeviceRegistry, ::Hash) (defaults to: nil) —

      Required. The new values for the device registry. The id field must be empty, and the name field must indicate the path of the resource. For example, projects/example-project/locations/us-central1/registries/my-registry.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. Only updates the device_registry fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: event_notification_config, http_config, mqtt_config, and state_notification_config.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/google/cloud/iot/v1/device_manager/client.rb', line 459

def update_device_registry request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Iot::V1::UpdateDeviceRegistryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_device_registry.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Iot::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.device_registry&.name
    header_params["device_registry.name"] = request.device_registry.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_device_registry.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_device_registry.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @device_manager_stub.call_rpc :update_device_registry, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end