Class: Google::Cloud::Iot::V1::DeviceRegistry

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/iot/v1/resources.rb

Overview

A container for a group of devices.

Instance Attribute Summary collapse

Instance Attribute Details

#credentials ⇒ ::Array<::Google::Cloud::Iot::V1::RegistryCredential>

Returns 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.

Returns:

  • (::Array<::Google::Cloud::Iot::V1::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.



211
212
213
214
 
# File 'proto_docs/google/cloud/iot/v1/resources.rb', line 211

class DeviceRegistry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#event_notification_configs ⇒ ::Array<::Google::Cloud::Iot::V1::EventNotificationConfig>

Returns 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.

Returns:

  • (::Array<::Google::Cloud::Iot::V1::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.



211
212
213
214
 
# File 'proto_docs/google/cloud/iot/v1/resources.rb', line 211

class DeviceRegistry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#http_config ⇒ ::Google::Cloud::Iot::V1::HttpConfig

Returns The DeviceService (HTTP) configuration for this device registry.

Returns:



211
212
213
214
 
# File 'proto_docs/google/cloud/iot/v1/resources.rb', line 211

class DeviceRegistry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#id ⇒ ::String

Returns The identifier of this device registry. For example, myRegistry.

Returns:

  • (::String) —

    The identifier of this device registry. For example, myRegistry.



211
212
213
214
 
# File 'proto_docs/google/cloud/iot/v1/resources.rb', line 211

class DeviceRegistry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#log_level ⇒ ::Google::Cloud::Iot::V1::LogLevel

Returns Beta Feature

The default logging verbosity for activity from devices in this registry. The verbosity level can be overridden by Device.log_level.

Returns:

  • (::Google::Cloud::Iot::V1::LogLevel) —

    Beta Feature

    The default logging verbosity for activity from devices in this registry. The verbosity level can be overridden by Device.log_level.



211
212
213
214
 
# File 'proto_docs/google/cloud/iot/v1/resources.rb', line 211

class DeviceRegistry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#mqtt_config ⇒ ::Google::Cloud::Iot::V1::MqttConfig

Returns The MQTT configuration for this device registry.

Returns:



211
212
213
214
 
# File 'proto_docs/google/cloud/iot/v1/resources.rb', line 211

class DeviceRegistry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns The resource path name. For example, projects/example-project/locations/us-central1/registries/my-registry.

Returns:

  • (::String) —

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



211
212
213
214
 
# File 'proto_docs/google/cloud/iot/v1/resources.rb', line 211

class DeviceRegistry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#state_notification_config ⇒ ::Google::Cloud::Iot::V1::StateNotificationConfig

Returns The configuration for notification of new states received from the device. State updates are guaranteed to be stored in the state history, but notifications to Cloud Pub/Sub are not guaranteed. For example, if permissions are misconfigured or the specified topic doesn't exist, no notification will be published but the state will still be stored in Cloud IoT Core.

Returns:

  • (::Google::Cloud::Iot::V1::StateNotificationConfig) —

    The configuration for notification of new states received from the device. State updates are guaranteed to be stored in the state history, but notifications to Cloud Pub/Sub are not guaranteed. For example, if permissions are misconfigured or the specified topic doesn't exist, no notification will be published but the state will still be stored in Cloud IoT Core.



211
212
213
214
 
# File 'proto_docs/google/cloud/iot/v1/resources.rb', line 211

class DeviceRegistry
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end