import ChangeLog from ‘../changelog/connector-http-onesignal.md’;

OneSignal

OneSignal 源连接器

描述

用于从 OneSignal 读取数据。

关键特性

选项

参数名	类型	必须	默认值	描述
url	String	是	-	HTTP 请求 URL
password	String	是	-	认证密钥用于登录
method	String	否	get	HTTP 请求方法，仅支持 GET、POST 方法
schema	Config	否	-	HTTP 和 SeaTunnel 数据结构映射。更多详情请参考 Schema 特性。
schema.fields	Config	否	-	上游数据的模式字段
format	String	否	json	上游数据的格式，现在仅支持 `json` `text`，默认 `json`。
params	Map	否	-	HTTP 参数
body	String	否	-	HTTP 请求体
json_field	Config	否	-	JSON 字段配置
content_json	String	否	-	内容 JSON 配置
poll_interval_millis	int	否	-	流模式下请求 HTTP API 的间隔（毫秒）
retry	int	否	-	如果 HTTP 请求返回 `IOException` 的最大重试次数
retry_backoff_multiplier_ms	int	否	100	HTTP 请求失败时的重试退避倍数（毫秒）
retry_backoff_max_ms	int	否	10000	HTTP 请求失败时的最大重试退避时间（毫秒）
enable_multi_lines	boolean	否	false	是否启用多行模式
common-options	config	否	-	源插件通用参数

url [String]

HTTP 请求 URL

password [String]

认证密钥用于登录，您可以在以下链接获取更多详情：

https://documentation.onesignal.com/docs/accounts-and-keys#user-auth-key

method [String]

HTTP 请求方法，仅支持 GET、POST 方法

params [Map]

HTTP 参数

body [String]

HTTP 请求体

poll_interval_millis [int]

流模式下请求 HTTP API 的间隔（毫秒）

retry [int]

如果 HTTP 请求返回 IOException 的最大重试次数

retry_backoff_multiplier_ms [int]

HTTP 请求失败时的重试退避倍数（毫秒）

retry_backoff_max_ms [int]

HTTP 请求失败时的最大重试退避时间（毫秒）

format [String]

上游数据的格式，现在仅支持 json text，默认 json。

schema [Config]

fields [Config]

上游数据的模式字段。更多详情请参考 Schema 特性。

content_json [String]

此参数可以获取一些 JSON 数据。

json_field [Config]

此参数帮助您配置模式，因此此参数必须与 schema 一起使用。

通用选项

源插件通用参数，请参考源通用选项详见。

示例

source {
  OneSignal {
    url = "https://onesignal.com/api/v1/apps"
    password = "SeaTunnel-test"
    schema = {
       fields {
         id = string
         name = string
         gcm_key = string
         chrome_key = string
         created_at = string
         updated_at = string
         players = int
         messageable_players = int
         basic_auth_key = string
       }
    }   
  }
}