Class: Google::Apis::CloudiotV1::DeviceRegistry
- Inherits:
-
Object
- Object
- Google::Apis::CloudiotV1::DeviceRegistry
- Defined in:
- generated/google/apis/cloudiot_v1/classes.rb,
generated/google/apis/cloudiot_v1/representations.rb,
generated/google/apis/cloudiot_v1/representations.rb
Overview
A container for a group of devices.
Instance Attribute Summary collapse
-
#credentials ⇒ Array<Google::Apis::CloudiotV1::RegistryCredential>
The credentials used to verify the device credentials.
-
#event_notification_configs ⇒ Array<Google::Apis::CloudiotV1::EventNotificationConfig>
The configuration for notification of telemetry events received from the device.
-
#http_config ⇒ Google::Apis::CloudiotV1::HttpConfig
The configuration of the HTTP bridge for a device registry.
-
#id ⇒ String
The identifier of this device registry.
-
#mqtt_config ⇒ Google::Apis::CloudiotV1::MqttConfig
The configuration of MQTT for a device registry.
-
#name ⇒ String
The resource path name.
-
#state_notification_config ⇒ Google::Apis::CloudiotV1::StateNotificationConfig
The configuration for notification of new states received from the device.
Instance Method Summary collapse
-
#initialize(**args) ⇒ DeviceRegistry
constructor
A new instance of DeviceRegistry.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ DeviceRegistry
Returns a new instance of DeviceRegistry
375 376 377 |
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 375 def initialize(**args) update!(**args) end |
Instance Attribute Details
#credentials ⇒ Array<Google::Apis::CloudiotV1::RegistryCredential>
The credentials used to verify the device credentials. No more than 10
credentials can be bound to a single registry at a time. The verification
process occurs at the time of device creation or update. If this field is
empty, no verification is performed. Otherwise, the credentials of a newly
created device or added credentials of an updated device should be signed
with one of these registry credentials.
Note, however, that existing devices will never be affected by
modifications to this list of credentials: after a device has been
successfully created in a registry, it should be able to connect even if
its registry credentials are revoked, deleted, or modified.
Corresponds to the JSON property credentials
334 335 336 |
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 334 def credentials @credentials end |
#event_notification_configs ⇒ Array<Google::Apis::CloudiotV1::EventNotificationConfig>
The configuration for notification of telemetry events received from the
device. All telemetry events that were successfully published by the
device and acknowledged by Cloud IoT Core are guaranteed to be
delivered to Cloud Pub/Sub. If multiple configurations match a message,
only the first matching configuration is used. If you try to publish a
device telemetry event using MQTT without specifying a Cloud Pub/Sub topic
for the device's registry, the connection closes automatically. If you try
to do so using an HTTP connection, an error is returned. Up to 10
configurations may be provided.
Corresponds to the JSON property eventNotificationConfigs
347 348 349 |
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 347 def event_notification_configs @event_notification_configs end |
#http_config ⇒ Google::Apis::CloudiotV1::HttpConfig
The configuration of the HTTP bridge for a device registry.
Corresponds to the JSON property httpConfig
352 353 354 |
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 352 def http_config @http_config end |
#id ⇒ String
The identifier of this device registry. For example, myRegistry
.
Corresponds to the JSON property id
357 358 359 |
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 357 def id @id end |
#mqtt_config ⇒ Google::Apis::CloudiotV1::MqttConfig
The configuration of MQTT for a device registry.
Corresponds to the JSON property mqttConfig
362 363 364 |
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 362 def mqtt_config @mqtt_config end |
#name ⇒ String
The resource path name. For example,
projects/example-project/locations/us-central1/registries/my-registry
.
Corresponds to the JSON property name
368 369 370 |
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 368 def name @name end |
#state_notification_config ⇒ Google::Apis::CloudiotV1::StateNotificationConfig
The configuration for notification of new states received from the device.
Corresponds to the JSON property stateNotificationConfig
373 374 375 |
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 373 def state_notification_config @state_notification_config end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
380 381 382 383 384 385 386 387 388 |
# File 'generated/google/apis/cloudiot_v1/classes.rb', line 380 def update!(**args) @credentials = args[:credentials] if args.key?(:credentials) @event_notification_configs = args[:event_notification_configs] if args.key?(:event_notification_configs) @http_config = args[:http_config] if args.key?(:http_config) @id = args[:id] if args.key?(:id) @mqtt_config = args[:mqtt_config] if args.key?(:mqtt_config) @name = args[:name] if args.key?(:name) @state_notification_config = args[:state_notification_config] if args.key?(:state_notification_config) end |