DeviceRegistry (Cloud IoT API v1-rev20230328-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.cloudiot.v1.model.DeviceRegistry

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class DeviceRegistry
extends com.google.api.client.json.GenericJson
```
A container for a group of devices.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud IoT API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

DeviceRegistry()

Constructors
Constructor and Description
`DeviceRegistry()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DeviceRegistry`	`clone()`
`List<RegistryCredential>`	`getCredentials()` The credentials used to verify the device credentials.
`List<EventNotificationConfig>`	`getEventNotificationConfigs()` The configuration for notification of telemetry events received from the device.
`HttpConfig`	`getHttpConfig()` The DeviceService (HTTP) configuration for this device registry.
`String`	`getId()` The identifier of this device registry.
`String`	`getLogLevel()` Beta Feature The default logging verbosity for activity from devices in this registry.
`MqttConfig`	`getMqttConfig()` The MQTT configuration for this device registry.
`String`	`getName()` The resource path name.
`StateNotificationConfig`	`getStateNotificationConfig()` The configuration for notification of new states received from the device.
`DeviceRegistry`	`set(String fieldName, Object value)`
`DeviceRegistry`	`setCredentials(List<RegistryCredential> credentials)` The credentials used to verify the device credentials.
`DeviceRegistry`	`setEventNotificationConfigs(List<EventNotificationConfig> eventNotificationConfigs)` The configuration for notification of telemetry events received from the device.
`DeviceRegistry`	`setHttpConfig(HttpConfig httpConfig)` The DeviceService (HTTP) configuration for this device registry.
`DeviceRegistry`	`setId(String id)` The identifier of this device registry.
`DeviceRegistry`	`setLogLevel(String logLevel)` Beta Feature The default logging verbosity for activity from devices in this registry.
`DeviceRegistry`	`setMqttConfig(MqttConfig mqttConfig)` The MQTT configuration for this device registry.
`DeviceRegistry`	`setName(String name)` The resource path name.
`DeviceRegistry`	`setStateNotificationConfig(StateNotificationConfig stateNotificationConfig)` The configuration for notification of new states received from the device.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - DeviceRegistry
```
public DeviceRegistry()
```
- Method Detail
  - getCredentials
```
public List<RegistryCredential> getCredentials()
```
    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:
    
    value or null for none
  - setCredentials
```
public DeviceRegistry setCredentials(List<RegistryCredential> credentials)
```
    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.
    
    Parameters:
    
    credentials - credentials or null for none
  - getEventNotificationConfigs
```
public List<EventNotificationConfig> getEventNotificationConfigs()
```
    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:
    
    value or null for none
  - setEventNotificationConfigs
```
public DeviceRegistry setEventNotificationConfigs(List<EventNotificationConfig> eventNotificationConfigs)
```
    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.
    
    Parameters:
    
    eventNotificationConfigs - eventNotificationConfigs or null for none
  - getHttpConfig
```
public HttpConfig getHttpConfig()
```
    The DeviceService (HTTP) configuration for this device registry.
    
    Returns:
    
    value or null for none
  - setHttpConfig
```
public DeviceRegistry setHttpConfig(HttpConfig httpConfig)
```
    The DeviceService (HTTP) configuration for this device registry.
    
    Parameters:
    
    httpConfig - httpConfig or null for none
  - getId
```
public String getId()
```
    The identifier of this device registry. For example, `myRegistry`.
    
    Returns:
    
    value or null for none
  - setId
```
public DeviceRegistry setId(String id)
```
    The identifier of this device registry. For example, `myRegistry`.
    
    Parameters:
    
    id - id or null for none
  - getLogLevel
```
public String getLogLevel()
```
    **Beta Feature** The default logging verbosity for activity from devices in this registry. The verbosity level can be overridden by Device.log_level.
    
    Returns:
    
    value or null for none
  - setLogLevel
```
public DeviceRegistry setLogLevel(String logLevel)
```
    **Beta Feature** The default logging verbosity for activity from devices in this registry. The verbosity level can be overridden by Device.log_level.
    
    Parameters:
    
    logLevel - logLevel or null for none
  - getMqttConfig
```
public MqttConfig getMqttConfig()
```
    The MQTT configuration for this device registry.
    
    Returns:
    
    value or null for none
  - setMqttConfig
```
public DeviceRegistry setMqttConfig(MqttConfig mqttConfig)
```
    The MQTT configuration for this device registry.
    
    Parameters:
    
    mqttConfig - mqttConfig or null for none
  - getName
```
public String getName()
```
    The resource path name. For example, `projects/example-project/locations/us-central1/registries /my-registry`.
    
    Returns:
    
    value or null for none
  - setName
```
public DeviceRegistry setName(String name)
```
    The resource path name. For example, `projects/example-project/locations/us-central1/registries /my-registry`.
    
    Parameters:
    
    name - name or null for none
  - getStateNotificationConfig
```
public StateNotificationConfig getStateNotificationConfig()
```
    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:
    
    value or null for none
  - setStateNotificationConfig
```
public DeviceRegistry setStateNotificationConfig(StateNotificationConfig 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.
    
    Parameters:
    
    stateNotificationConfig - stateNotificationConfig or null for none
  - set
```
public DeviceRegistry set(String fieldName,
                          Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public DeviceRegistry clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class DeviceRegistry

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

DeviceRegistry

Method Detail

getCredentials

setCredentials

getEventNotificationConfigs

setEventNotificationConfigs

getHttpConfig

setHttpConfig

getId

setId

getLogLevel

setLogLevel

getMqttConfig

setMqttConfig

getName

setName

getStateNotificationConfig

setStateNotificationConfig

set

clone