Page Comparison

Resource: Device

...

JSON representation

Code Block { "id": string, "name": string, "numId": string, "credentials": [ { object(DeviceCredential) } ], "lastHeartbeatTime": string, "lastEventTime": string, "lastStateTime": string, "lastConfigAckTime": string, "lastConfigSendTime": string, "blocked": boolean, "lastErrorTime": string, "lastErrorStatus": { object(Status) }, "config": { object(DeviceConfig) }, "state": { object(DeviceState) }, "logLevel": enum(LogLevel), "metadata": { string: string, ... }, "gatewayConfig": { object(GatewayConfig) } }

Fields
id	string The user-defined permanent device identifier. The device ID must be unique within a device registry. 3-255 characters. Start with a letter. You can also include numbers and these characters: + . % - _ ~
name	string The resource path name. For example, projects/p1/locations/us-central1/registries/registry0/devices/dev0 or projects/p1/locations/us-central1/registries/registry0/devices/{numId}. When name is populated as a response from the service, it always ends in the

device

device’s numeric ID.
numId	string [Output only]

A

The device’s server-defined unique numeric ID

for the device

. This is a more compact way to identify devices

,

and

it

is globally unique.
credentials[]	object(DeviceCredential) The credentials used to authenticate this device.

To allow credential rotation without interruption, multiple

Multiple device credentials can be bound to this device

. No more than 3

to allow credential rotation without interruption. At most, three 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

field’s description.
lastHeartbeatTime	string (Timestamp format) [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. A timestamp in RFC3339 UTC

"

Zulu

"

format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
lastEventTime	string (Timestamp format) [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. A timestamp in RFC3339 UTC

"

Zulu

"

format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
lastStateTime	string (Timestamp format) [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. A timestamp in RFC3339 UTC

"

Zulu

"

format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
lastConfigAckTime	string (Timestamp format) [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. A timestamp in RFC3339 UTC

"

Zulu

"

format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
lastConfigSendTime	string (Timestamp format) [Output only] The last time a cloud-to-device config version was sent to the device. A timestamp in RFC3339 UTC

"

Zulu

"

format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
blocked	boolean 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.
lastErrorTime	string (Timestamp format) [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

'lastErrorStatus' timestamp. A timestamp in RFC3339 UTC

"

Zulu

"

format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
lastErrorStatus	object(Status) [Output only] The

error message of the

most recent error’s error message, such as a failure to publish to Cloud Pub/Sub.

'lastErrorTime

‘lastErrorTime' is

the

this field’s 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.
config	object(DeviceConfig) The most recent device configuration, which is eventually sent from

Cloud

ClearBlade IoT Core to the device. If not present on creation, the configuration will be initialized with an empty payload and 1 version value

of 1

. To update this field after creation, use the DeviceManager.ModifyCloudToDeviceConfig method.
state	object(DeviceState) [Output only] The state most recently received from the device. If no state has been reported, this field is not present.
logLevel	enum(LogLevel) The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used.
metadata	map (key: string, value: string) The metadata key-value pairs assigned to the device. This metadata is not interpreted or indexed by

Cloud

ClearBlade IoT Core. It can be used to add the device’s contextual information

for the device.

Keys must conform to the regular expression [a-zA-Z][a-zA-Z0-9-_.+~%]+ 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. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

gatewayConfig

object(GatewayConfig) Gateway-related configuration and state.

DeviceCredential

A server-stored device credential used for authentication.

{
  "expirationTime": string,
  "publicKey": {
    object(PublicKeyCredential)
  }
}

PublicKeyCredential

A public key format and data.

{
  "format": enum(PublicKeyFormat),
  "key": string
}

PublicKeyFormat

The public key’s supported formats for the public key.

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs , RPC, and RPC gRPC APIs. It is used by gRPC. The error model is designed to be:

• Simple to use and understand for understood by most users

• Flexible enough to meet unexpected needs

...

The Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of a google.rpc.Code enum value, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is neededrequired, put the localized message it in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a A predefined set of error detail types in the package google.rpc that can be used for common error conditions.

Language mapping

The Status message is the error model’s logical representation of the error model, but it is not necessarily the actual wire format. When the The Status message is can be mapped differently when exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some Java exceptions in Java, but more likely mapped to some C error codes in C.

Other uses

The error model and the Status message can be used in a variety of various environments, either with or without APIs, to provide a consistent developer experience across different environments.

Example uses of this error model This error model’s example uses include:

• Partial errors. If a service needs to return partial errors them to the client, it may embed the Status in the normal response to indicate the partial errorsthem.

• Workflow errors. A typical workflow has multiple steps. Each step may have a an error reporting Status message for error reporting.

• Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.

• Asynchronous operations. If an API call embeds calls asynchronous operation operations results in its response, the status of those operations should be represented directly using the Status message.

• Logging. If some API errors are stored in logs, the Status message Status could be used directly after any stripping needed for security/privacy reasons.

{
  "code": number,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}

GatewayConfig

Gateway-related configuration and state.

{
  "gatewayType": enum(GatewayType),
  "gatewayAuthMethod": enum(GatewayAuthMethod),
  "lastAccessedGatewayId": string,
  "lastAccessedGatewayTime": string
}

GatewayType

Gateway type.

GatewayAuthMethod

The gateway authorization/authentication method. This setting determines how Cloud ClearBlade IoT Core authorizes/authenticate authenticates devices to access the gateway.