Cloud IoT V1 API - Class Google::Cloud::Iot::V1::DeviceRegistry (v0.9.1)

Reference documentation and code samples for the Cloud IoT V1 API class Google::Cloud::Iot::V1::DeviceRegistry.

A container for a group of devices.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#credentials

def credentials() -> ::Array<::Google::Cloud::Iot::V1::RegistryCredential>
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.

#credentials=

def credentials=(value) -> ::Array<::Google::Cloud::Iot::V1::RegistryCredential>
Parameter
  • value (::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.

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.

#event_notification_configs

def event_notification_configs() -> ::Array<::Google::Cloud::Iot::V1::EventNotificationConfig>
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.

#event_notification_configs=

def event_notification_configs=(value) -> ::Array<::Google::Cloud::Iot::V1::EventNotificationConfig>
Parameter
  • value (::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.
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.

#http_config

def http_config() -> ::Google::Cloud::Iot::V1::HttpConfig
Returns

#http_config=

def http_config=(value) -> ::Google::Cloud::Iot::V1::HttpConfig
Parameter
Returns

#id

def id() -> ::String
Returns
  • (::String) — The identifier of this device registry. For example, myRegistry.

#id=

def id=(value) -> ::String
Parameter
  • value (::String) — The identifier of this device registry. For example, myRegistry.
Returns
  • (::String) — The identifier of this device registry. For example, myRegistry.

#log_level

def log_level() -> ::Google::Cloud::Iot::V1::LogLevel
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.

#log_level=

def log_level=(value) -> ::Google::Cloud::Iot::V1::LogLevel
Parameter
  • value (::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.

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.

#mqtt_config

def mqtt_config() -> ::Google::Cloud::Iot::V1::MqttConfig
Returns

#mqtt_config=

def mqtt_config=(value) -> ::Google::Cloud::Iot::V1::MqttConfig
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — The resource path name. For example, projects/example-project/locations/us-central1/registries/my-registry.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — 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.

#state_notification_config

def state_notification_config() -> ::Google::Cloud::Iot::V1::StateNotificationConfig
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.

#state_notification_config=

def state_notification_config=(value) -> ::Google::Cloud::Iot::V1::StateNotificationConfig
Parameter
  • value (::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.
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.