Device (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.Device

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Device
extends com.google.api.client.json.GenericJson
```
The device resource.
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

Device()

Constructors
Constructor and Description
`Device()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Device`	`clone()`
`Boolean`	`getBlocked()` If a device is blocked, connections or requests from this device will fail.
`DeviceConfig`	`getConfig()` The most recent device configuration, which is eventually sent from Cloud IoT Core to the device.
`List<DeviceCredential>`	`getCredentials()` The credentials used to authenticate this device.
`GatewayConfig`	`getGatewayConfig()` Gateway-related configuration and state.
`String`	`getId()` The user-defined device identifier.
`String`	`getLastConfigAckTime()` [Output only] The last time a cloud-to-device config version acknowledgment was received from the device.
`String`	`getLastConfigSendTime()` [Output only] The last time a cloud-to-device config version was sent to the device.
`Status`	`getLastErrorStatus()` [Output only] The error message of the most recent error, such as a failure to publish to Cloud Pub/Sub.
`String`	`getLastErrorTime()` [Output only] The time the most recent error occurred, such as a failure to publish to Cloud Pub/Sub.
`String`	`getLastEventTime()` [Output only] The last time a telemetry event was received.
`String`	`getLastHeartbeatTime()` [Output only] The last time an MQTT `PINGREQ` was received.
`String`	`getLastStateTime()` [Output only] The last time a state event was received.
`String`	`getLogLevel()` Beta Feature The logging verbosity for device activity.
`Map<String,String>`	`getMetadata()` The metadata key-value pairs assigned to the device.
`String`	`getName()` The resource path name.
`BigInteger`	`getNumId()` [Output only] A server-defined unique numeric ID for the device.
`DeviceState`	`getState()` [Output only] The state most recently received from the device.
`Device`	`set(String fieldName, Object value)`
`Device`	`setBlocked(Boolean blocked)` If a device is blocked, connections or requests from this device will fail.
`Device`	`setConfig(DeviceConfig config)` The most recent device configuration, which is eventually sent from Cloud IoT Core to the device.
`Device`	`setCredentials(List<DeviceCredential> credentials)` The credentials used to authenticate this device.
`Device`	`setGatewayConfig(GatewayConfig gatewayConfig)` Gateway-related configuration and state.
`Device`	`setId(String id)` The user-defined device identifier.
`Device`	`setLastConfigAckTime(String lastConfigAckTime)` [Output only] The last time a cloud-to-device config version acknowledgment was received from the device.
`Device`	`setLastConfigSendTime(String lastConfigSendTime)` [Output only] The last time a cloud-to-device config version was sent to the device.
`Device`	`setLastErrorStatus(Status lastErrorStatus)` [Output only] The error message of the most recent error, such as a failure to publish to Cloud Pub/Sub.
`Device`	`setLastErrorTime(String lastErrorTime)` [Output only] The time the most recent error occurred, such as a failure to publish to Cloud Pub/Sub.
`Device`	`setLastEventTime(String lastEventTime)` [Output only] The last time a telemetry event was received.
`Device`	`setLastHeartbeatTime(String lastHeartbeatTime)` [Output only] The last time an MQTT `PINGREQ` was received.
`Device`	`setLastStateTime(String lastStateTime)` [Output only] The last time a state event was received.
`Device`	`setLogLevel(String logLevel)` Beta Feature The logging verbosity for device activity.
`Device`	`setMetadata(Map<String,String> metadata)` The metadata key-value pairs assigned to the device.
`Device`	`setName(String name)` The resource path name.
`Device`	`setNumId(BigInteger numId)` [Output only] A server-defined unique numeric ID for the device.
`Device`	`setState(DeviceState state)` [Output only] The state most recently 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
  - Device
```
public Device()
```
- Method Detail
  - getBlocked
```
public Boolean getBlocked()
```
    If a device is blocked, connections or requests from this device will fail. Can be used to temporarily prevent the device from connecting if, for example, the sensor is generating bad data and needs maintenance.
    
    Returns:
    
    value or null for none
  - setBlocked
```
public Device setBlocked(Boolean blocked)
```
    If a device is blocked, connections or requests from this device will fail. Can be used to temporarily prevent the device from connecting if, for example, the sensor is generating bad data and needs maintenance.
    
    Parameters:
    
    blocked - blocked or null for none
  - getConfig
```
public DeviceConfig getConfig()
```
    The most recent device configuration, which is eventually sent from Cloud IoT Core to the device. If not present on creation, the configuration will be initialized with an empty payload and version value of `1`. To update this field after creation, use the `DeviceManager.ModifyCloudToDeviceConfig` method.
    
    Returns:
    
    value or null for none
  - setConfig
```
public Device setConfig(DeviceConfig config)
```
    The most recent device configuration, which is eventually sent from Cloud IoT Core to the device. If not present on creation, the configuration will be initialized with an empty payload and version value of `1`. To update this field after creation, use the `DeviceManager.ModifyCloudToDeviceConfig` method.
    
    Parameters:
    
    config - config or null for none
  - getCredentials
```
public List<DeviceCredential> getCredentials()
```
    The credentials used to authenticate this device. To allow credential rotation without interruption, multiple device credentials can be bound to this device. No more than 3 credentials can be bound to a single device at a time. When new credentials are added to a device, they are verified against the registry credentials. For details, see the description of the `DeviceRegistry.credentials` field.
    
    Returns:
    
    value or null for none
  - setCredentials
```
public Device setCredentials(List<DeviceCredential> credentials)
```
    The credentials used to authenticate this device. To allow credential rotation without interruption, multiple device credentials can be bound to this device. No more than 3 credentials can be bound to a single device at a time. When new credentials are added to a device, they are verified against the registry credentials. For details, see the description of the `DeviceRegistry.credentials` field.
    
    Parameters:
    
    credentials - credentials or null for none
  - getGatewayConfig
```
public GatewayConfig getGatewayConfig()
```
    Gateway-related configuration and state.
    
    Returns:
    
    value or null for none
  - setGatewayConfig
```
public Device setGatewayConfig(GatewayConfig gatewayConfig)
```
    Gateway-related configuration and state.
    
    Parameters:
    
    gatewayConfig - gatewayConfig or null for none
  - getId
```
public String getId()
```
    The user-defined device identifier. The device ID must be unique within a device registry.
    
    Returns:
    
    value or null for none
  - setId
```
public Device setId(String id)
```
    The user-defined device identifier. The device ID must be unique within a device registry.
    
    Parameters:
    
    id - id or null for none
  - getLastConfigAckTime
```
public String getLastConfigAckTime()
```
    [Output only] The last time a cloud-to-device config version acknowledgment was received from the device. This field is only for configurations sent through MQTT.
    
    Returns:
    
    value or null for none
  - setLastConfigAckTime
```
public Device setLastConfigAckTime(String lastConfigAckTime)
```
    [Output only] The last time a cloud-to-device config version acknowledgment was received from the device. This field is only for configurations sent through MQTT.
    
    Parameters:
    
    lastConfigAckTime - lastConfigAckTime or null for none
  - getLastConfigSendTime
```
public String getLastConfigSendTime()
```
    [Output only] The last time a cloud-to-device config version was sent to the device.
    
    Returns:
    
    value or null for none
  - setLastConfigSendTime
```
public Device setLastConfigSendTime(String lastConfigSendTime)
```
    [Output only] The last time a cloud-to-device config version was sent to the device.
    
    Parameters:
    
    lastConfigSendTime - lastConfigSendTime or null for none
  - getLastErrorStatus
```
public Status getLastErrorStatus()
```
    [Output only] The error message of the most recent error, such as a failure to publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this field. If no errors have occurred, this field has an empty message and the status code 0 == OK. Otherwise, this field is expected to have a status code other than OK.
    
    Returns:
    
    value or null for none
  - setLastErrorStatus
```
public Device setLastErrorStatus(Status lastErrorStatus)
```
    [Output only] The error message of the most recent error, such as a failure to publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this field. If no errors have occurred, this field has an empty message and the status code 0 == OK. Otherwise, this field is expected to have a status code other than OK.
    
    Parameters:
    
    lastErrorStatus - lastErrorStatus or null for none
  - getLastErrorTime
```
public String getLastErrorTime()
```
    [Output only] The time the most recent error occurred, such as a failure to publish to Cloud Pub/Sub. This field is the timestamp of 'last_error_status'.
    
    Returns:
    
    value or null for none
  - setLastErrorTime
```
public Device setLastErrorTime(String lastErrorTime)
```
    [Output only] The time the most recent error occurred, such as a failure to publish to Cloud Pub/Sub. This field is the timestamp of 'last_error_status'.
    
    Parameters:
    
    lastErrorTime - lastErrorTime or null for none
  - getLastEventTime
```
public String getLastEventTime()
```
    [Output only] The last time a telemetry event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes.
    
    Returns:
    
    value or null for none
  - setLastEventTime
```
public Device setLastEventTime(String lastEventTime)
```
    [Output only] The last time a telemetry event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes.
    
    Parameters:
    
    lastEventTime - lastEventTime or null for none
  - getLastHeartbeatTime
```
public String getLastHeartbeatTime()
```
    [Output only] The last time an MQTT `PINGREQ` was received. This field applies only to devices connecting through MQTT. MQTT clients usually only send `PINGREQ` messages if the connection is idle, and no other messages have been sent. Timestamps are periodically collected and written to storage; they may be stale by a few minutes.
    
    Returns:
    
    value or null for none
  - setLastHeartbeatTime
```
public Device setLastHeartbeatTime(String lastHeartbeatTime)
```
    [Output only] The last time an MQTT `PINGREQ` was received. This field applies only to devices connecting through MQTT. MQTT clients usually only send `PINGREQ` messages if the connection is idle, and no other messages have been sent. Timestamps are periodically collected and written to storage; they may be stale by a few minutes.
    
    Parameters:
    
    lastHeartbeatTime - lastHeartbeatTime or null for none
  - getLastStateTime
```
public String getLastStateTime()
```
    [Output only] The last time a state event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes.
    
    Returns:
    
    value or null for none
  - setLastStateTime
```
public Device setLastStateTime(String lastStateTime)
```
    [Output only] The last time a state event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes.
    
    Parameters:
    
    lastStateTime - lastStateTime or null for none
  - getLogLevel
```
public String getLogLevel()
```
    **Beta Feature** The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used.
    
    Returns:
    
    value or null for none
  - setLogLevel
```
public Device setLogLevel(String logLevel)
```
    **Beta Feature** The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used.
    
    Parameters:
    
    logLevel - logLevel or null for none
  - getMetadata
```
public Map<String,String> getMetadata()
```
    The metadata key-value pairs assigned to the device. This metadata is not interpreted or indexed by Cloud IoT Core. It can be used to add contextual information for the device. Keys must conform to the regular expression a-zA-Z+ and be less than 128 bytes in length. Values are free-form strings. Each value must be less than or equal to 32 KB in size. The total size of all keys and values must be less than 256 KB, and the maximum number of key-value pairs is 500.
    
    Returns:
    
    value or null for none
  - setMetadata
```
public Device setMetadata(Map<String,String> metadata)
```
    The metadata key-value pairs assigned to the device. This metadata is not interpreted or indexed by Cloud IoT Core. It can be used to add contextual information for the device. Keys must conform to the regular expression a-zA-Z+ and be less than 128 bytes in length. Values are free-form strings. Each value must be less than or equal to 32 KB in size. The total size of all keys and values must be less than 256 KB, and the maximum number of key-value pairs is 500.
    
    Parameters:
    
    metadata - metadata or null for none
  - getName
```
public String getName()
```
    The resource path name. For example, `projects/p1/locations/us- central1/registries/registry0/devices/dev0` or `projects/p1/locations/us- central1/registries/registry0/devices/{num_id}`. When `name` is populated as a response from the service, it always ends in the device numeric ID.
    
    Returns:
    
    value or null for none
  - setName
```
public Device setName(String name)
```
    The resource path name. For example, `projects/p1/locations/us- central1/registries/registry0/devices/dev0` or `projects/p1/locations/us- central1/registries/registry0/devices/{num_id}`. When `name` is populated as a response from the service, it always ends in the device numeric ID.
    
    Parameters:
    
    name - name or null for none
  - getNumId
```
public BigInteger getNumId()
```
    [Output only] A server-defined unique numeric ID for the device. This is a more compact way to identify devices, and it is globally unique.
    
    Returns:
    
    value or null for none
  - setNumId
```
public Device setNumId(BigInteger numId)
```
    [Output only] A server-defined unique numeric ID for the device. This is a more compact way to identify devices, and it is globally unique.
    
    Parameters:
    
    numId - numId or null for none
  - getState
```
public DeviceState getState()
```
    [Output only] The state most recently received from the device. If no state has been reported, this field is not present.
    
    Returns:
    
    value or null for none
  - setState
```
public Device setState(DeviceState state)
```
    [Output only] The state most recently received from the device. If no state has been reported, this field is not present.
    
    Parameters:
    
    state - state or null for none
  - set
```
public Device set(String fieldName,
                  Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Device clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Device

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

Device

Method Detail

getBlocked

setBlocked

getConfig

setConfig

getCredentials

setCredentials

getGatewayConfig

setGatewayConfig

getId

setId

getLastConfigAckTime

setLastConfigAckTime

getLastConfigSendTime

setLastConfigSendTime

getLastErrorStatus

setLastErrorStatus

getLastErrorTime

setLastErrorTime

getLastEventTime

setLastEventTime

getLastHeartbeatTime

setLastHeartbeatTime

getLastStateTime

setLastStateTime

getLogLevel

setLogLevel

getMetadata

setMetadata

getName

setName

getNumId

setNumId

getState

setState

set

clone