projects.locations.registries.devices
- Aaron Allsbrook
- Jeff Slavin (Unlicensed)
- Clark Bynum
Resource: Device
JSON representation |
|---|
{
"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 | |
|---|---|
|
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: + . % - _ ~ |
|
The resource path name. For example, |
|
[Output only] The device’s server-defined unique numeric ID. This is a more compact way to identify devices and is globally unique. |
| object(DeviceCredential) The credentials used to authenticate this device. Multiple device credentials can be bound to this device 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 |
|
[Output only] The last time an MQTT A timestamp in RFC3339 UTC Zulu format, accurate to nanoseconds. Example: |
|
[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: |
|
[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: |
|
[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: |
|
[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: |
|
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. |
|
[Output only] The time the most recent error occurred, such as a failure to publish to Cloud Pub/Sub. This field is the 'lastErrorStatus' timestamp. A timestamp in RFC3339 UTC Zulu format, accurate to nanoseconds. Example: |
| object(Status) [Output only] The most recent error’s error message, such as a failure to publish to Cloud Pub/Sub. ‘lastErrorTime' is this field’s timestamp. 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. |
| object(DeviceConfig) The most recent device configuration, which is eventually sent from ClearBlade IoT Core to the device. If not present on creation, the configuration will be initialized with an empty payload and |
| object(DeviceState) [Output only] The state most recently received from the device. If no state has been reported, this field is not present. |
| enum(LogLevel) The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used. |
|
The metadata key-value pairs assigned to the device. This metadata is not interpreted or indexed by ClearBlade IoT Core. It can be used to add the device’s contextual information 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 |
| object(GatewayConfig) Gateway-related configuration and state. |
DeviceCredential
A server-stored device credential used for authentication.
JSON representation |
|---|
{
"expirationTime": string,
"publicKey": {
object(PublicKeyCredential)
}
} |
Fields | |
|---|---|
|
[Optional] The time at which this credential becomes invalid. This credential will be ignored for new client authentication requests after this timestamp; however, it will not be automatically deleted. A timestamp in RFC3339 UTC Zulu format, accurate to nanoseconds. Example: |
| object(PublicKeyCredential) A public key used to verify the signature of JSON Web Tokens (JWTs). When adding a new device credential via device creation or modifications, this public key credential may be required to be signed by one of the registry-level certificates. More specifically, if the registry contains at least one certificate, one of them must sign any new device credential. As a result, only X.509 certificates are accepted as device credentials when the registry contains certificates. However, self-signed certificates and public keys will be accepted if the registry does not contain a certificate. New device credentials must be different from every registry-level certificate. |
PublicKeyCredential
A public key format and data.
JSON representation |
|---|
{
"format": enum(PublicKeyFormat),
"key": string
} |
Fields | |
|---|---|
| enum(PublicKeyFormat) The key format. |
|
The key data. |
PublicKeyFormat
The public key’s supported formats.
Enums | |
|---|---|
| The format has not been specified. This is an invalid default value and must not be used. |
| An RSA public key encoded in base64 and wrapped by |
| As RSA_PEM, but wrapped in an X.509v3 certificate (RFC5280), encoded in base64, and wrapped by |
| The public key for the ECDSA algorithm using P-256 and SHA-256, encoded in base64, and wrapped by |
| As ES256_PEM, but wrapped in an X.509v3 certificate (RFC5280), encoded in base64, and wrapped by |
Status
The Status type defines a logical error model suitable for programming environments, including REST, RPC, and gRPC APIs. The error model is designed to be:
Simple to use and understood by most users
Flexible enough to meet unexpected needs
Overview
The Status message contains three pieces of data: error code, error message, and error details. The error code should be 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 required, put it in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. A predefined set of error detail types in the package google.rpc can be used for common error conditions.
Language mapping
The Status message is the error model’s logical representation, but it is not necessarily the actual wire format. The Status message can be mapped differently when exposed in different client libraries and wire protocols. For example, it will likely be mapped to some Java exceptions but more likely mapped to some C error codes.
Other uses
The error model and the Status message can be used in various environments, with or without APIs, to provide a consistent developer experience across different environments.
This error model’s example uses include:
Partial errors. If a service needs to return them to the client, it may embed the
Statusin the normal response to indicate them.Workflow errors. A typical workflow has multiple steps. Each step may have an error reporting
Statusmessage.Batch operations. If a client uses batch request and batch response, the
Statusmessage should be used directly inside batch response, one for each error sub-response.Asynchronous operations. If an API calls asynchronous operations results in its response, the status of those operations should be represented directly using the
Statusmessage.Logging. If some API errors are stored in logs, the
Statusmessage could be used directly after any stripping needed for security/privacy reasons.
JSON representation |
|---|
Fields | |
|---|---|
|
The status code, which should be a |
|
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the |
|
A list of messages that carry the error details. There is a common set of message types for APIs to use. An object containing arbitrary type fields. An additional field |
GatewayConfig
Gateway-related configuration and state.
JSON representation |
|---|
Fields | |
|---|---|
| enum(GatewayType) Indicates whether the device is a gateway. |
| enum(GatewayAuthMethod) Indicates how to authorize and authenticate devices to access the gateway. |
|
[Output only] The gateway ID the device accessed most recently. |
|
[Output only] The most recent time the device accessed the gateway specified in A timestamp in RFC3339 UTC Zulu format, accurate to nanoseconds. Example: |
GatewayType
Gateway type.
Enums | |
|---|---|
| If unspecified, the device is a non-gateway device. |
| The device is a gateway. |
| The device is not a gateway. |
GatewayAuthMethod
The gateway authorization/authentication method. This setting determines how ClearBlade IoT Core authorizes/authenticates devices to access the gateway.
Enums | |
|---|---|
| No authentication/authorization method specified. No devices are allowed to access the gateway. |
| The device is authenticated through the gateway association only, and device credentials are ignored even if provided. |
| The device is authenticated through its credentials, and the gateway association is not checked. |
| The device is authenticated through device credentials and gateway association. The device must be bound to the gateway and provide its credentials. |
Methods | |
|---|---|
Creates a device in a device registry. | |
Deletes a device. | |
Gets a device’s details. | |
List devices in a device registry. | |
Modifies the device configuration, which is eventually sent from the ClearBlade IoT Core servers. | |
Updates a device. | |
Sends a command to the specified device. | |