docs/en/connector-v2/source/OneSignal.md - seatunnel - Git at Google

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

 # OneSignal

 > OneSignal source connector

 ## Description

 Used to read data from OneSignal.

 ## Key features

 - [x] [batch](../../concept/connector-v2-features.md)
 - [ ] [stream](../../concept/connector-v2-features.md)
 - [ ] [exactly-once](../../concept/connector-v2-features.md)
 - [ ] [column projection](../../concept/connector-v2-features.md)
 - [ ] [parallelism](../../concept/connector-v2-features.md)
 - [ ] [support user-defined split](../../concept/connector-v2-features.md)

 ## Options

 |            name             |  type   | required | default value |
 |-----------------------------|---------|----------|---------------|
 | url                         | String  | Yes      | -             |
 | password                    | String  | Yes      | -             |
 | method                      | String  | No       | get           |
 | schema                      | Config  | No       | -             |
 | schema.fields               | Config  | No       | -             |
 | format                      | String  | No       | json          |
 | params                      | Map     | No       | -             |
 | body                        | String  | No       | -             |
 | json_field                  | Config  | No       | -             |
 | content_json                | String  | No       | -             |
 | poll_interval_millis        | int     | No       | -             |
 | retry                       | int     | No       | -             |
 | retry_backoff_multiplier_ms | int     | No       | 100           |
 | retry_backoff_max_ms        | int     | No       | 10000         |
 | enable_multi_lines          | boolean | No       | false         |
 | common-options              | config  | No       | -             |

 ### url [String]

 http request url

 ### password [String]

 Auth key for login, you can get more detail at this link:

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

 ### method [String]

 http request method, only supports GET, POST method

 ### params [Map]

 http params

 ### body [String]

 http body

 ### poll_interval_millis [int]

 request http api interval(millis) in stream mode

 ### retry [int]

 The max retry times if request http return to `IOException`

 ### retry_backoff_multiplier_ms [int]

 The retry-backoff times(millis) multiplier if request http failed

 ### retry_backoff_max_ms [int]

 The maximum retry-backoff times(millis) if request http failed

 ### format [String]

 the format of upstream data, now only support `json` `text`, default `json`.

 when you assign format is `json`, you should also assign schema option, for example:

 upstream data is the following:

 ```json
 {
   "code": 200,
   "data": "get success",
   "success": true
 }
 ```

 you should assign schema as the following:

 ```hocon

 schema {
     fields {
         code = int
         data = string
         success = boolean
     }
 }

 ```

 connector will generate data as the following:

 | code |    data     | success |
 |------|-------------|---------|
 | 200  | get success | true    |

 when you assign format is `text`, connector will do nothing for upstream data, for example:

 upstream data is the following:

 ```json
 {
   "code": 200,
   "data": "get success",
   "success": true
 }
 ```

 connector will generate data as the following:

 |                         content                          |
 |----------------------------------------------------------|
 | {"code":  200, "data":  "get success", "success":  true} |

 ### schema [Config]

 #### fields [Config]

 the schema fields of upstream data

 ### content_json [String]

 This parameter can get some json data.If you only need the data in the 'book' section, configure `content_field = "$.store.book.*"`.

 If your return data looks something like this.

 ```json
 {
   "store": {
     "book": [
       {
         "category": "reference",
         "author": "Nigel Rees",
         "title": "Sayings of the Century",
         "price": 8.95
       },
       {
         "category": "fiction",
         "author": "Evelyn Waugh",
         "title": "Sword of Honour",
         "price": 12.99
       }
     ],
     "bicycle": {
       "color": "red",
       "price": 19.95
     }
   },
   "expensive": 10
 }
 ```

 You can configure `content_field = "$.store.book.*"` and the result returned looks like this:

 ```json
 [
   {
     "category": "reference",
     "author": "Nigel Rees",
     "title": "Sayings of the Century",
     "price": 8.95
   },
   {
     "category": "fiction",
     "author": "Evelyn Waugh",
     "title": "Sword of Honour",
     "price": 12.99
   }
 ]
 ```

 Then you can get the desired result with a simpler schema,like

 ```hocon
 Http {
   url = "http://mockserver:1080/contentjson/mock"
   method = "GET"
   format = "json"
   content_field = "$.store.book.*"
   schema = {
     fields {
       category = string
       author = string
       title = string
       price = string
     }
   }
 }
 ```

 Here is an example:

 - Test data can be found at this link [mockserver-config.json](../../../../seatunnel-e2e/seatunnel-connector-v2-e2e/connector-http-e2e/src/test/resources/mockserver-config.json)
 - See this link for task configuration [http_contentjson_to_assert.conf](../../../../seatunnel-e2e/seatunnel-connector-v2-e2e/connector-http-e2e/src/test/resources/http_contentjson_to_assert.conf).

 ### json_field [Config]

 This parameter helps you configure the schema,so this parameter must be used with schema.

 If your data looks something like this:

 ```json
 {
   "store": {
     "book": [
       {
         "category": "reference",
         "author": "Nigel Rees",
         "title": "Sayings of the Century",
         "price": 8.95
       },
       {
         "category": "fiction",
         "author": "Evelyn Waugh",
         "title": "Sword of Honour",
         "price": 12.99
       }
     ],
     "bicycle": {
       "color": "red",
       "price": 19.95
     }
   },
   "expensive": 10
 }
 ```

 You can get the contents of 'book' by configuring the task as follows:

 ```hocon
 source {
   Http {
     url = "http://mockserver:1080/jsonpath/mock"
     method = "GET"
     format = "json"
     json_field = {
       category = "$.store.book[*].category"
       author = "$.store.book[*].author"
       title = "$.store.book[*].title"
       price = "$.store.book[*].price"
     }
     schema = {
       fields {
         category = string
         author = string
         title = string
         price = string
       }
     }
   }
 }
 ```

 - Test data can be found at this link [mockserver-config.json](../../../../seatunnel-e2e/seatunnel-connector-v2-e2e/connector-http-e2e/src/test/resources/mockserver-config.json)
 - See this link for task configuration [http_jsonpath_to_assert.conf](../../../../seatunnel-e2e/seatunnel-connector-v2-e2e/connector-http-e2e/src/test/resources/http_jsonpath_to_assert.conf).

 ### common options

 Source plugin common parameters, please refer to [Source Common Options](../source-common-options.md) for details

 ## Example

 ```hocon

 OneSignal {
     url = "https://onesignal.com/api/v1/apps"
     password = "SeaTunnel-test"
     schema = {
        fields {
          id = string
          name = string
          gcm_key = string
          chrome_key = string
          chrome_web_key = string
          chrome_web_origin = string
          chrome_web_gcm_sender_id = string
          chrome_web_default_notification_icon = string
          chrome_web_sub_domain = string
          apns_env = string
          apns_certificates = string
          apns_p8 = string
          apns_team_id = string
          apns_key_id = string
          apns_bundle_id = string
          safari_apns_certificate = string
          safari_site_origin = string
          safari_push_id = string
          safari_icon_16_16 = string
          safari_icon_32_32 = string
          safari_icon_64_64 = string
          safari_icon_128_128 = string
          safari_icon_256_256 = string
          site_name = string
          created_at = string
          updated_at = string
          players = int
          messageable_players = int
          basic_auth_key = string
          additional_data_is_root_payload = string
        }
     }
 }
 ```

 ## Changelog

 <ChangeLog />
	import ChangeLog from '../changelog/connector-http-onesignal.md';

	# OneSignal

	> OneSignal source connector

	## Description

	Used to read data from OneSignal.

	## Key features

	- [x] [batch](../../concept/connector-v2-features.md)
	- [ ] [stream](../../concept/connector-v2-features.md)
	- [ ] [exactly-once](../../concept/connector-v2-features.md)
	- [ ] [column projection](../../concept/connector-v2-features.md)
	- [ ] [parallelism](../../concept/connector-v2-features.md)
	- [ ] [support user-defined split](../../concept/connector-v2-features.md)

	## Options

	\| name \| type \| required \| default value \|
	\|-----------------------------\|---------\|----------\|---------------\|
	\| url \| String \| Yes \| - \|
	\| password \| String \| Yes \| - \|
	\| method \| String \| No \| get \|
	\| schema \| Config \| No \| - \|
	\| schema.fields \| Config \| No \| - \|
	\| format \| String \| No \| json \|
	\| params \| Map \| No \| - \|
	\| body \| String \| No \| - \|
	\| json_field \| Config \| No \| - \|
	\| content_json \| String \| No \| - \|
	\| poll_interval_millis \| int \| No \| - \|
	\| retry \| int \| No \| - \|
	\| retry_backoff_multiplier_ms \| int \| No \| 100 \|
	\| retry_backoff_max_ms \| int \| No \| 10000 \|
	\| enable_multi_lines \| boolean \| No \| false \|
	\| common-options \| config \| No \| - \|

	### url [String]

	http request url

	### password [String]

	Auth key for login, you can get more detail at this link:

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

	### method [String]

	http request method, only supports GET, POST method

	### params [Map]

	http params

	### body [String]

	http body

	### poll_interval_millis [int]

	request http api interval(millis) in stream mode

	### retry [int]

	The max retry times if request http return to `IOException`

	### retry_backoff_multiplier_ms [int]

	The retry-backoff times(millis) multiplier if request http failed

	### retry_backoff_max_ms [int]

	The maximum retry-backoff times(millis) if request http failed

	### format [String]

	the format of upstream data, now only support `json` `text`, default `json`.

	when you assign format is `json`, you should also assign schema option, for example:

	upstream data is the following:

	```json
	{
	"code": 200,
	"data": "get success",
	"success": true
	}
	```

	you should assign schema as the following:

	```hocon

	schema {
	fields {
	code = int
	data = string
	success = boolean
	}
	}

	```

	connector will generate data as the following:

	\| code \| data \| success \|
	\|------\|-------------\|---------\|
	\| 200 \| get success \| true \|

	when you assign format is `text`, connector will do nothing for upstream data, for example:

	upstream data is the following:

	```json
	{
	"code": 200,
	"data": "get success",
	"success": true
	}
	```

	connector will generate data as the following:

	\| content \|
	\|----------------------------------------------------------\|
	\| {"code": 200, "data": "get success", "success": true} \|

	### schema [Config]

	#### fields [Config]

	the schema fields of upstream data

	### content_json [String]

	This parameter can get some json data.If you only need the data in the 'book' section, configure `content_field = "$.store.book.*"`.

	If your return data looks something like this.

	```json
	{
	"store": {
	"book": [
	{
	"category": "reference",
	"author": "Nigel Rees",
	"title": "Sayings of the Century",
	"price": 8.95
	},
	{
	"category": "fiction",
	"author": "Evelyn Waugh",
	"title": "Sword of Honour",
	"price": 12.99
	}
	],
	"bicycle": {
	"color": "red",
	"price": 19.95
	}
	},
	"expensive": 10
	}
	```

	You can configure `content_field = "$.store.book.*"` and the result returned looks like this:

	```json
	[
	{
	"category": "reference",
	"author": "Nigel Rees",
	"title": "Sayings of the Century",
	"price": 8.95
	},
	{
	"category": "fiction",
	"author": "Evelyn Waugh",
	"title": "Sword of Honour",
	"price": 12.99
	}
	]
	```

	Then you can get the desired result with a simpler schema,like

	```hocon
	Http {
	url = "http://mockserver:1080/contentjson/mock"
	method = "GET"
	format = "json"
	content_field = "$.store.book.*"
	schema = {
	fields {
	category = string
	author = string
	title = string
	price = string
	}
	}
	}
	```

	Here is an example:

	- Test data can be found at this link [mockserver-config.json](../../../../seatunnel-e2e/seatunnel-connector-v2-e2e/connector-http-e2e/src/test/resources/mockserver-config.json)
	- See this link for task configuration [http_contentjson_to_assert.conf](../../../../seatunnel-e2e/seatunnel-connector-v2-e2e/connector-http-e2e/src/test/resources/http_contentjson_to_assert.conf).

	### json_field [Config]

	This parameter helps you configure the schema,so this parameter must be used with schema.

	If your data looks something like this:

	```json
	{
	"store": {
	"book": [
	{
	"category": "reference",
	"author": "Nigel Rees",
	"title": "Sayings of the Century",
	"price": 8.95
	},
	{
	"category": "fiction",
	"author": "Evelyn Waugh",
	"title": "Sword of Honour",
	"price": 12.99
	}
	],
	"bicycle": {
	"color": "red",
	"price": 19.95
	}
	},
	"expensive": 10
	}
	```

	You can get the contents of 'book' by configuring the task as follows:

	```hocon
	source {
	Http {
	url = "http://mockserver:1080/jsonpath/mock"
	method = "GET"
	format = "json"
	json_field = {
	category = "$.store.book[*].category"
	author = "$.store.book[*].author"
	title = "$.store.book[*].title"
	price = "$.store.book[*].price"
	}
	schema = {
	fields {
	category = string
	author = string
	title = string
	price = string
	}
	}
	}
	}
	```

	- Test data can be found at this link [mockserver-config.json](../../../../seatunnel-e2e/seatunnel-connector-v2-e2e/connector-http-e2e/src/test/resources/mockserver-config.json)
	- See this link for task configuration [http_jsonpath_to_assert.conf](../../../../seatunnel-e2e/seatunnel-connector-v2-e2e/connector-http-e2e/src/test/resources/http_jsonpath_to_assert.conf).

	### common options

	Source plugin common parameters, please refer to [Source Common Options](../source-common-options.md) for details

	## Example

	```hocon

	OneSignal {
	url = "https://onesignal.com/api/v1/apps"
	password = "SeaTunnel-test"
	schema = {
	fields {
	id = string
	name = string
	gcm_key = string
	chrome_key = string
	chrome_web_key = string
	chrome_web_origin = string
	chrome_web_gcm_sender_id = string
	chrome_web_default_notification_icon = string
	chrome_web_sub_domain = string
	apns_env = string
	apns_certificates = string
	apns_p8 = string
	apns_team_id = string
	apns_key_id = string
	apns_bundle_id = string
	safari_apns_certificate = string
	safari_site_origin = string
	safari_push_id = string
	safari_icon_16_16 = string
	safari_icon_32_32 = string
	safari_icon_64_64 = string
	safari_icon_128_128 = string
	safari_icon_256_256 = string
	site_name = string
	created_at = string
	updated_at = string
	players = int
	messageable_players = int
	basic_auth_key = string
	additional_data_is_root_payload = string
	}
	}
	}
	```

	## Changelog

	<ChangeLog />