Pod Configuration

Type: object

Parameters for configuring the execution run of a UDMIS pod

 No Additional Properties

root include
Type: string

root base
Type: object

Parameters to define pod base parameters

 No Additional Properties

root base udmi_prefix
Type: string

prefix for udmi namespacing

root base failure_rate
Type: number

chance of random failure in various bits of the system

root flow_defaults
Type: object

Parameters to define a message endpoint

 No Additional Properties

root flow_defaults name
Type: string

Friendly name for this flow (debugging and diagnostics)

root flow_defaults protocol
Type: enum (of string)

Must be one of:

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

root flow_defaults transport
Type: enum (of string)

Must be one of:

  • "ssl"
  • "tcp"

root flow_defaults hostname
Type: string

root flow_defaults payload
Type: string

Simple payload template for simple injection use cases

root flow_defaults error
Type: string

Error message container for capturing errors during parsing/handling

root flow_defaults port
Type: integer

root flow_defaults config_sync_sec
Type: integer

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

root flow_defaults client_id
Type: string

root flow_defaults topic_prefix
Type: string

Prefix for message topics

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

root flow_defaults recv_id
Type: string

Id for the receiving message channel

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

root flow_defaults send_id
Type: string

Id for the sending messages channel

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

root flow_defaults side_id
Type: string

Id for a side-car message channel

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

root flow_defaults gatewayId
Type: string

root flow_defaults deviceId
Type: string

root flow_defaults enabled
Type: string

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

root flow_defaults noConfigAck
Type: boolean

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

root flow_defaults capacity
Type: integer

Queue capacity for limiting pipes

root flow_defaults publish_delay_sec
Type: integer

Artifical publish delay for testing

root flow_defaults periodic_sec
Type: integer

Rate for periodic task execution

root flow_defaults keyBytes
Type: object

root flow_defaults algorithm
Type: string

root flow_defaults auth_provider
Type: object
No Additional Properties

root flow_defaults auth_provider basic
Type: object
No Additional Properties

root flow_defaults auth_provider jwt
Type: object
No Additional Properties

root flow_defaults generation
Type: string

The timestamp of the endpoint generation
Example:

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

root crons
Type: object

All property whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
root crons configuration_endpoint.json
Type: object

Parameters to define a message endpoint

 No Additional Properties

root crons Endpoint Configuration name
Type: string

Friendly name for this flow (debugging and diagnostics)

root crons Endpoint Configuration protocol
Type: enum (of string)

Must be one of:

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

root crons Endpoint Configuration transport
Type: enum (of string)

Must be one of:

  • "ssl"
  • "tcp"

root crons Endpoint Configuration payload
Type: string

Simple payload template for simple injection use cases

root crons Endpoint Configuration error
Type: string

Error message container for capturing errors during parsing/handling

root crons Endpoint Configuration port
Type: integer

root crons Endpoint Configuration config_sync_sec
Type: integer

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

root crons Endpoint Configuration topic_prefix
Type: string

Prefix for message topics

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

root crons Endpoint Configuration recv_id
Type: string

Id for the receiving message channel

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

root crons Endpoint Configuration send_id
Type: string

Id for the sending messages channel

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

root crons Endpoint Configuration side_id
Type: string

Id for a side-car message channel

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

root crons Endpoint Configuration enabled
Type: string

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

root crons Endpoint Configuration noConfigAck
Type: boolean

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

root crons Endpoint Configuration capacity
Type: integer

Queue capacity for limiting pipes

root crons Endpoint Configuration publish_delay_sec
Type: integer

Artifical publish delay for testing

root crons Endpoint Configuration periodic_sec
Type: integer

Rate for periodic task execution

root crons Endpoint Configuration auth_provider
Type: object
No Additional Properties

root crons Endpoint Configuration auth_provider basic
Type: object
No Additional Properties

root crons Endpoint Configuration auth_provider jwt
Type: object
No Additional Properties

root crons Endpoint Configuration generation
Type: string

The timestamp of the endpoint generation
Example:

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

root flows
Type: object

All property whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
root flows configuration_endpoint.json
Type: object

Parameters to define a message endpoint

 No Additional Properties

root flows Endpoint Configuration name
Type: string

Friendly name for this flow (debugging and diagnostics)

root flows Endpoint Configuration protocol
Type: enum (of string)

Must be one of:

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

root flows Endpoint Configuration transport
Type: enum (of string)

Must be one of:

  • "ssl"
  • "tcp"

root flows Endpoint Configuration payload
Type: string

Simple payload template for simple injection use cases

root flows Endpoint Configuration error
Type: string

Error message container for capturing errors during parsing/handling

root flows Endpoint Configuration port
Type: integer

root flows Endpoint Configuration config_sync_sec
Type: integer

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

root flows Endpoint Configuration topic_prefix
Type: string

Prefix for message topics

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

root flows Endpoint Configuration recv_id
Type: string

Id for the receiving message channel

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

root flows Endpoint Configuration send_id
Type: string

Id for the sending messages channel

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

root flows Endpoint Configuration side_id
Type: string

Id for a side-car message channel

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

root flows Endpoint Configuration enabled
Type: string

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

root flows Endpoint Configuration noConfigAck
Type: boolean

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

root flows Endpoint Configuration capacity
Type: integer

Queue capacity for limiting pipes

root flows Endpoint Configuration publish_delay_sec
Type: integer

Artifical publish delay for testing

root flows Endpoint Configuration periodic_sec
Type: integer

Rate for periodic task execution

root flows Endpoint Configuration auth_provider
Type: object
No Additional Properties

root flows Endpoint Configuration auth_provider basic
Type: object
No Additional Properties

root flows Endpoint Configuration auth_provider jwt
Type: object
No Additional Properties

root flows Endpoint Configuration generation
Type: string

The timestamp of the endpoint generation
Example:

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

root bridges
Type: object

All property whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z][a-z0-9]*(_[a-z0-9]+)*$
root bridges configuration_pod_bridge.json
Type: object

Parameters to define a bridge between message domains

 No Additional Properties

root bridges Bridge Pod Configuration from
Type: object

Parameters to define a message endpoint

 No Additional Properties

root bridges Bridge Pod Configuration from name
Type: string

Friendly name for this flow (debugging and diagnostics)

root bridges Bridge Pod Configuration from protocol
Type: enum (of string)

Must be one of:

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

root bridges Bridge Pod Configuration from transport
Type: enum (of string)

Must be one of:

  • "ssl"
  • "tcp"

root bridges Bridge Pod Configuration from payload
Type: string

Simple payload template for simple injection use cases

root bridges Bridge Pod Configuration from error
Type: string

Error message container for capturing errors during parsing/handling

root bridges Bridge Pod Configuration from config_sync_sec
Type: integer

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

root bridges Bridge Pod Configuration from topic_prefix
Type: string

Prefix for message topics

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

root bridges Bridge Pod Configuration from recv_id
Type: string

Id for the receiving message channel

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

root bridges Bridge Pod Configuration from send_id
Type: string

Id for the sending messages channel

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

root bridges Bridge Pod Configuration from side_id
Type: string

Id for a side-car message channel

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

root bridges Bridge Pod Configuration from enabled
Type: string

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

root bridges Bridge Pod Configuration from noConfigAck
Type: boolean

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

root bridges Bridge Pod Configuration from capacity
Type: integer

Queue capacity for limiting pipes

root bridges Bridge Pod Configuration from publish_delay_sec
Type: integer

Artifical publish delay for testing

root bridges Bridge Pod Configuration from periodic_sec
Type: integer

Rate for periodic task execution

root bridges Bridge Pod Configuration from auth_provider
Type: object
No Additional Properties

root bridges Bridge Pod Configuration from auth_provider jwt
Type: object
No Additional Properties

root bridges Bridge Pod Configuration from generation
Type: string

The timestamp of the endpoint generation
Example:

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

root bridges Bridge Pod Configuration morf
Type: object

Parameters to define a message endpoint

 No Additional Properties

root bridges Bridge Pod Configuration morf name
Type: string

Friendly name for this flow (debugging and diagnostics)

root bridges Bridge Pod Configuration morf protocol
Type: enum (of string)

Must be one of:

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

root bridges Bridge Pod Configuration morf transport
Type: enum (of string)

Must be one of:

  • "ssl"
  • "tcp"

root bridges Bridge Pod Configuration morf payload
Type: string

Simple payload template for simple injection use cases

root bridges Bridge Pod Configuration morf error
Type: string

Error message container for capturing errors during parsing/handling

root bridges Bridge Pod Configuration morf config_sync_sec
Type: integer

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

root bridges Bridge Pod Configuration morf topic_prefix
Type: string

Prefix for message topics

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

root bridges Bridge Pod Configuration morf recv_id
Type: string

Id for the receiving message channel

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

root bridges Bridge Pod Configuration morf send_id
Type: string

Id for the sending messages channel

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

root bridges Bridge Pod Configuration morf side_id
Type: string

Id for a side-car message channel

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

root bridges Bridge Pod Configuration morf enabled
Type: string

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

root bridges Bridge Pod Configuration morf noConfigAck
Type: boolean

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

root bridges Bridge Pod Configuration morf capacity
Type: integer

Queue capacity for limiting pipes

root bridges Bridge Pod Configuration morf publish_delay_sec
Type: integer

Artifical publish delay for testing

root bridges Bridge Pod Configuration morf periodic_sec
Type: integer

Rate for periodic task execution

root bridges Bridge Pod Configuration morf auth_provider
Type: object
No Additional Properties

root bridges Bridge Pod Configuration morf auth_provider jwt
Type: object
No Additional Properties

root bridges Bridge Pod Configuration morf generation
Type: string

The timestamp of the endpoint generation
Example:

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

root iot_access
Type: object
No Additional Properties

All property whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z]+$
root iot_access access_iot.json
Type: object
No Additional Properties

root iot_access Iot Access name
Type: string

root iot_access Iot Access provider
Type: enum (of string)

Must be one of:

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

root iot_access Iot Access project_id
Type: string

root iot_access Iot Access profile_sec
Type: integer

root iot_access Iot Access options
Type: string

root iot_data
Type: object
No Additional Properties

All property whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^[a-z]+$
root iot_data access_iot.json
Type: object
No Additional Properties

root iot_data Iot Access name
Type: string

root iot_data Iot Access provider
Type: enum (of string)

Must be one of:

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

root iot_data Iot Access project_id
Type: string

root iot_data Iot Access profile_sec
Type: integer

root iot_data Iot Access options
Type: string