Endpoint Configuration

Type: object

Parameters to define a message endpoint

 No Additional Properties

root name
Type: string

Friendly name for this flow (debugging and diagnostics)

root protocol
Type: enum (of string)

Must be one of:

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

root transport
Type: enum (of string)

Must be one of:

  • "ssl"
  • "tcp"

root hostname
Type: string

root payload
Type: string

Simple payload template for simple injection use cases

root error
Type: string

Error message container for capturing errors during parsing/handling

root port
Type: integer

root config_sync_sec
Type: integer

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

root client_id
Type: string

root topic_prefix
Type: string

Prefix for message topics

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

root recv_id
Type: string

Id for the receiving message channel

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

root send_id
Type: string

Id for the sending messages channel

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

root side_id
Type: string

Id for a side-car message channel

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

root gatewayId
Type: string

root deviceId
Type: string

root enabled
Type: string

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

root noConfigAck
Type: boolean

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

root capacity
Type: integer

Queue capacity for limiting pipes

root publish_delay_sec
Type: integer

Artifical publish delay for testing

root periodic_sec
Type: integer

Rate for periodic task execution

root keyBytes
Type: object

root algorithm
Type: string

root auth_provider
Type: object
No Additional Properties

root auth_provider basic
Type: object
No Additional Properties

root auth_provider basic username
Type: string

root auth_provider basic password
Type: string

root auth_provider jwt
Type: object
No Additional Properties

root auth_provider jwt audience
Type: string

root generation
Type: string

The timestamp of the endpoint generation
Example:

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