Skip to main content

Connections

timeplus

Commentary​

added in 0.1.15

Experimental support for TimePlus. Data is written through its webhook API. Streams must already exist before producing data into them. baseUrl is your geo instance and org ID.

Examples​

Configuring the connection​

{
    "connections": {
        "timeplus-staging": {
            "kind": "timeplus",
            "connectionConfigs": {
                "baseUrl": "https://us.timeplus.cloud/my-org-id",
                "apiKey": "my-api-key"
            }
        }
    }
}

Specification​

Connection JSON schema​

{
    "type": "object",
    "properties": {
        "kind": {
            "type": "string",
            "const": "timeplus"
        },
        "connectionConfigs": {
            "type": "object",
            "properties": {
                "baseUrl": {
                    "type": "string"
                },
                "apiKey": {
                    "type": "string"
                }
            },
            "required": [
                "baseUrl",
                "apiKey"
            ]
        }
    },
    "required": [
        "connectionConfigs"
    ]
}

Generator JSON schema​

{
    "type": "object",
    "properties": {
        "connection": {
            "type": "string"
        },
        "name": {
            "type": "string"
        },
        "stream": {
            "type": "string"
        },
        "row": {
            "type": "object"
        },
        "localConfigs": {
            "type": "object",
            "properties": {
                "throttleMs": {
                    "oneOf": [
                        {
                            "type": "number",
                            "minimum": 0
                        },
                        {
                            "type": "object"
                        }
                    ]
                },
                "maxEvents": {
                    "oneOf": [
                        {
                            "type": "integer",
                            "minimum": 0
                        },
                        {
                            "type": "object",
                            "properties": {
                                "_gen": {
                                    "type": "string"
                                }
                            },
                            "required": [
                                "_gen"
                            ]
                        }
                    ]
                },
                "discard": {
                    "type": "object",
                    "properties": {
                        "rate": {
                            "type": "number",
                            "minimum": 0,
                            "maximum": 1
                        }
                    },
                    "required": [
                        "rate"
                    ]
                },
                "repeat": {
                    "type": "object",
                    "properties": {
                        "rate": {
                            "type": "number",
                            "minimum": 0,
                            "maximum": 1
                        },
                        "times": {
                            "oneOf": [
                                {
                                    "type": "integer",
                                    "minimum": 0
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "_gen": {
                                            "type": "string"
                                        }
                                    },
                                    "required": [
                                        "_gen"
                                    ]
                                }
                            ]
                        }
                    },
                    "required": [
                        "rate",
                        "times"
                    ]
                },
                "maxHistoryEvents": {
                    "type": "integer",
                    "minimum": 0
                },
                "maxMs": {
                    "type": "integer",
                    "minimum": 0
                },
                "time": {
                    "type": "integer"
                },
                "events": {
                    "type": "object",
                    "properties": {
                        "exactly": {
                            "oneOf": [
                                {
                                    "type": "integer",
                                    "minimum": 0
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "_gen": {
                                            "type": "string"
                                        }
                                    },
                                    "required": [
                                        "_gen"
                                    ]
                                }
                            ]
                        }
                    }
                },
                "delay": {
                    "type": "object",
                    "properties": {
                        "rate": {
                            "type": "number",
                            "minimum": 0,
                            "maximum": 1
                        },
                        "ms": {
                            "oneOf": [
                                {
                                    "type": "integer",
                                    "minimum": 0
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "_gen": {
                                            "type": "string"
                                        }
                                    },
                                    "required": [
                                        "_gen"
                                    ]
                                }
                            ]
                        }
                    },
                    "required": [
                        "rate",
                        "ms"
                    ]
                },
                "history": {
                    "type": "object",
                    "properties": {
                        "events": {
                            "type": "object",
                            "properties": {
                                "max": {
                                    "type": "integer",
                                    "minimum": 0
                                }
                            }
                        }
                    }
                },
                "throttle": {
                    "type": "object",
                    "properties": {
                        "ms": {
                            "oneOf": [
                                {
                                    "type": "number",
                                    "minimum": 0
                                },
                                {
                                    "type": "object"
                                }
                            ]
                        }
                    }
                },
                "timeMultiplier": {
                    "oneOf": [
                        {
                            "type": "number"
                        },
                        {
                            "type": "object",
                            "properties": {
                                "_gen": {
                                    "type": "string"
                                }
                            },
                            "required": [
                                "_gen"
                            ]
                        }
                    ]
                }
            }
        }
    },
    "required": [
        "stream",
        "row"
    ]
}