Execution Configuration

Type: object

Parameters for configuring the execution run of a UDMI tool

 No Additional Properties

root registry_id
Type: string

root cloud_region
Type: string

root site_name
Type: string

root update_topic
Type: string

root feed_name
Type: string

root reflect_region
Type: string

root site_model
Type: string

root src_file
Type: string

root registry_suffix
Type: string

root shard_count
Type: integer

root shard_index
Type: integer

root device_id
Type: string

root iot_provider
Type: enum (of string)

Must be one of:

  • "local"
  • "dynamic"
  • "implicit"
  • "pubsub"
  • "mqtt"
  • "gbos"
  • "gref"
  • "etcd"
  • "jwt"
  • "clearblade"

root reflector_endpoint
Type: object

Parameters to define a message endpoint

 No Additional Properties

root reflector_endpoint name
Type: string

Friendly name for this flow (debugging and diagnostics)

root reflector_endpoint protocol
Type: enum (of string)

Must be one of:

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

root reflector_endpoint transport
Type: enum (of string)

Must be one of:

  • "ssl"
  • "tcp"

root reflector_endpoint hostname
Type: string

root reflector_endpoint payload
Type: string

Simple payload template for simple injection use cases

root reflector_endpoint error
Type: string

Error message container for capturing errors during parsing/handling

root reflector_endpoint port
Type: integer

root reflector_endpoint config_sync_sec
Type: integer

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

root reflector_endpoint client_id
Type: string

root reflector_endpoint topic_prefix
Type: string

Prefix for message topics

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

root reflector_endpoint recv_id
Type: string

Id for the receiving message channel

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

root reflector_endpoint send_id
Type: string

Id for the sending messages channel

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

root reflector_endpoint side_id
Type: string

Id for a side-car message channel

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

root reflector_endpoint gatewayId
Type: string

root reflector_endpoint deviceId
Type: string

root reflector_endpoint enabled
Type: string

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

root reflector_endpoint noConfigAck
Type: boolean

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

root reflector_endpoint capacity
Type: integer

Queue capacity for limiting pipes

root reflector_endpoint publish_delay_sec
Type: integer

Artifical publish delay for testing

root reflector_endpoint periodic_sec
Type: integer

Rate for periodic task execution

root reflector_endpoint keyBytes
Type: object

root reflector_endpoint algorithm
Type: string

root reflector_endpoint auth_provider
Type: object
No Additional Properties

root reflector_endpoint auth_provider basic
Type: object
No Additional Properties

root reflector_endpoint auth_provider jwt
Type: object
No Additional Properties

root reflector_endpoint generation
Type: string

The timestamp of the endpoint generation
Example:

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

root device_endpoint
Type: object

Parameters to define a message endpoint

 No Additional Properties

root device_endpoint name
Type: string

Friendly name for this flow (debugging and diagnostics)

root device_endpoint protocol
Type: enum (of string)

Must be one of:

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

root device_endpoint transport
Type: enum (of string)

Must be one of:

  • "ssl"
  • "tcp"

root device_endpoint hostname
Type: string

root device_endpoint payload
Type: string

Simple payload template for simple injection use cases

root device_endpoint error
Type: string

Error message container for capturing errors during parsing/handling

root device_endpoint port
Type: integer

root device_endpoint config_sync_sec
Type: integer

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

root device_endpoint client_id
Type: string

root device_endpoint topic_prefix
Type: string

Prefix for message topics

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

root device_endpoint recv_id
Type: string

Id for the receiving message channel

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

root device_endpoint send_id
Type: string

Id for the sending messages channel

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

root device_endpoint side_id
Type: string

Id for a side-car message channel

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

root device_endpoint gatewayId
Type: string

root device_endpoint deviceId
Type: string

root device_endpoint enabled
Type: string

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

root device_endpoint noConfigAck
Type: boolean

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

root device_endpoint capacity
Type: integer

Queue capacity for limiting pipes

root device_endpoint publish_delay_sec
Type: integer

Artifical publish delay for testing

root device_endpoint periodic_sec
Type: integer

Rate for periodic task execution

root device_endpoint keyBytes
Type: object

root device_endpoint algorithm
Type: string

root device_endpoint auth_provider
Type: object
No Additional Properties

root device_endpoint auth_provider basic
Type: object
No Additional Properties

root device_endpoint auth_provider jwt
Type: object
No Additional Properties

root device_endpoint generation
Type: string

The timestamp of the endpoint generation
Example:

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

root project_id
Type: string

root user_name
Type: string

root udmi_namespace
Type: string

root bridge_host
Type: string

root key_file
Type: string

root serial_no
Type: string

root log_level
Type: string

root min_stage
Type: string

root udmi_version
Type: string

Semantic tagged version of udmis install

root udmi_commit
Type: string

Commit hash of this udmis install

root udmi_ref
Type: string

Complete reference of udmis install

root udmi_timever
Type: string

Timestamp version id of udmis install

root enforce_version
Type: boolean

root udmi_root
Type: string

root update_to
Type: string

Optional version for a udmis update trigger

root alt_project
Type: string

root alt_registry
Type: string

root block_unknown
Type: boolean

root sequences
Type: array of string

Each item of this array must be:

root sequences sequences items
Type: string