Interface Route

interface Route {
    createdAt?: Date;
    dbConfig?: RouteDatabaseConfig;
    hubId: string;
    id: string;
    name: string;
    restConfig?: RouteRestConfig;
    s3Config?: RouteS3Config;
    topic: string;
    type: RouteRouteType;
    updatedAt?: Date;
}

Properties

createdAt? dbConfig? hubId id name restConfig? s3Config? topic type updatedAt?

Properties

OptionalcreatedAt

createdAt?: Date

Date at which the route was created.

OptionaldbConfig

dbConfig?: RouteDatabaseConfig

When using Database Route, DB-specific configuration fields.

One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set.

hubId

hubId: string

Hub ID of the route.

id

id: string

Route ID.

name

name: string

Route name.

OptionalrestConfig

restConfig?: RouteRestConfig

When using Rest Route, Rest-specific configuration fields.

One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set.

Optionals3Config

s3Config?: RouteS3Config

When using Amazon S3 Routes, Amazon S3-specific configuration fields.

One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set.

topic

topic: string

Topic the route subscribes to. It must be a valid MQTT topic and up to 65535 characters.

type

type: RouteRouteType

Route type.

OptionalupdatedAt

updatedAt?: Date

Date at which the route was last updated.

Settings

On This Page

Properties