Device Persistent

Type: object

Device persistent data

root endpoint
Type: object

Parameters to define a message endpoint

 No Additional Properties

root endpoint name
Type: string

Friendly name for this flow (debugging and diagnostics)

root endpoint protocol
Type: enum (of string)

Must be one of:

  • "local"
  • "pubsub"
  • "file"
  • "trace"
  • "mqtt"

root endpoint transport
Type: enum (of string)

Must be one of:

  • "ssl"
  • "tcp"

root endpoint hostname
Type: string

root endpoint payload
Type: string

Simple payload template for simple injection use cases

root endpoint error
Type: string

Error message container for capturing errors during parsing/handling

root endpoint port
Type: integer

root endpoint config_sync_sec
Type: integer

Delay waiting for config message on start, 0 for default, <0 to disable

root endpoint client_id
Type: string

root endpoint topic_prefix
Type: string

Prefix for message topics

Must match regular expression: ^[-_/a-zA-Z0-9]+$

root endpoint recv_id
Type: string

Id for the receiving message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$

root endpoint send_id
Type: string

Id for the sending messages channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$

root endpoint side_id
Type: string

Id for a side-car message channel

Must match regular expression: ^[-_/a-zA-Z0-9#]+$

root endpoint gatewayId
Type: string

root endpoint deviceId
Type: string

root endpoint enabled
Type: string

Indicator if this endpoint should be active (null or non-empty)

root endpoint noConfigAck
Type: boolean

True if config messages should not be acked (lower QOS)

root endpoint capacity
Type: integer

Queue capacity for limiting pipes

root endpoint publish_delay_sec
Type: integer

Artifical publish delay for testing

root endpoint periodic_sec
Type: integer

Rate for periodic task execution

root endpoint keyBytes
Type: object

root endpoint algorithm
Type: string

root endpoint auth_provider
Type: object
No Additional Properties

root endpoint auth_provider basic
Type: object
No Additional Properties

root endpoint auth_provider jwt
Type: object
No Additional Properties

root endpoint auth_provider jwt audience
Type: string

root endpoint generation
Type: string

The timestamp of the endpoint generation
Example:

"2019-01-17T14:02:29.364Z"

root restart_count
Type: integer

Additional Properties of any type are allowed.

root additionalProperties
Type: object