doc-exports/docs/dataartsstudio/api-ref/dataartsstudio_02_0291.html
Xiong, Chen Xiao 14a6d65e8c DataArts API 20240130 version
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
2024-03-01 11:46:15 +00:00

138 lines
11 KiB
HTML

<a name="dataartsstudio_02_0291"></a><a name="dataartsstudio_02_0291"></a>
<h1 class="topictitle1">From DIS</h1>
<div id="body8662426"><div class="section" id="dataartsstudio_02_0291__en-us_topic_0108272853_section33401108172339"><h4 class="sectiontitle">Sample JSON File</h4><pre class="screen" id="dataartsstudio_02_0291__en-us_topic_0108272853_screen5166623192136">"from-config-values": {
"configs": [
{
"inputs": [
{
"name": "fromJobConfig.streamName",
"value": "cdm"
},
{
"name": "fromJobConfig.disConsumerStrategy",
"value": "FROM_LAST_STOP"
},
{
"name": "fromJobConfig.isPermanency",
"value": "true"
},
{
"name": "fromJobConfig.maxPollRecords",
"value": "100"
},
{
"name": "fromJobConfig.shardId",
"value": "0"
},
{
"name": "fromJobConfig.dataFormat",
"value": "BINARY"
},
{
"name": "fromJobConfig.separator",
"value": ","
}
],
"name": "fromJobConfig"
}
]
}</pre>
</div>
<div class="section" id="dataartsstudio_02_0291__en-us_topic_0108272853_section28186120174818"><h4 class="sectiontitle">Parameter Description</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0291__en-us_topic_0108272853_table13922888141527" frame="border" border="1" rules="all"><thead align="left"><tr id="dataartsstudio_02_0291__en-us_topic_0108272853_row229143141527"><th align="left" class="cellrowborder" valign="top" width="22.772277227722768%" id="mcps1.3.2.2.1.5.1.1"><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p66756185141527">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.8019801980198%" id="mcps1.3.2.2.1.5.1.2"><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p38541938141527">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.81188118811881%" id="mcps1.3.2.2.1.5.1.3"><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p34889279141527">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="38.6138613861386%" id="mcps1.3.2.2.1.5.1.4"><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p7459369141527">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0291__en-us_topic_0108272853_row62628929141527"><td class="cellrowborder" valign="top" width="22.772277227722768%" headers="mcps1.3.2.2.1.5.1.1 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p18560626141527">fromJobConfig.streamName</p>
</td>
<td class="cellrowborder" valign="top" width="19.8019801980198%" headers="mcps1.3.2.2.1.5.1.2 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p27015713141527">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.1.5.1.3 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p50167516142856">String</p>
</td>
<td class="cellrowborder" valign="top" width="38.6138613861386%" headers="mcps1.3.2.2.1.5.1.4 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p32605071143018">DIS stream name</p>
</td>
</tr>
<tr id="dataartsstudio_02_0291__en-us_topic_0108272853_row42094113141527"><td class="cellrowborder" valign="top" width="22.772277227722768%" headers="mcps1.3.2.2.1.5.1.1 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p26789449141527">fromJobConfig.disConsumerStrategy</p>
</td>
<td class="cellrowborder" valign="top" width="19.8019801980198%" headers="mcps1.3.2.2.1.5.1.2 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p22461756141527">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.1.5.1.3 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p7462956141527">Enumeration</p>
</td>
<td class="cellrowborder" valign="top" width="38.6138613861386%" headers="mcps1.3.2.2.1.5.1.4 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p1561824172319">Used to set the initial offset when data is pulled from DIS. The options are as follows:</p>
<ul id="dataartsstudio_02_0291__en-us_topic_0108272853_ul4823568317828"><li id="dataartsstudio_02_0291__en-us_topic_0108272853_li4691888517828"><strong id="dataartsstudio_02_0291__en-us_topic_0108272853_b842352706143841_1">LATEST</strong>: maximum offset, that is, the latest data</li><li id="dataartsstudio_02_0291__en-us_topic_0108272853_li939935101441"><strong id="dataartsstudio_02_0291__en-us_topic_0108272853_b842352706143853">FROM_LAST_STOP</strong>: data after the last stop</li><li id="dataartsstudio_02_0291__en-us_topic_0108272853_li29011737101319"><strong id="dataartsstudio_02_0291__en-us_topic_0108272853_b842352706143841_3">EARLIEST</strong>: minimum offset, that is, the earliest data</li></ul>
</td>
</tr>
<tr id="dataartsstudio_02_0291__en-us_topic_0108272853_row8336449141527"><td class="cellrowborder" valign="top" width="22.772277227722768%" headers="mcps1.3.2.2.1.5.1.1 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p29681527141527">fromJobConfig.isPermanency</p>
</td>
<td class="cellrowborder" valign="top" width="19.8019801980198%" headers="mcps1.3.2.2.1.5.1.2 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p55393515141527">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.1.5.1.3 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p8057768172040">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="38.6138613861386%" headers="mcps1.3.2.2.1.5.1.4 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p31296545154541">Whether to run permanently</p>
</td>
</tr>
<tr id="dataartsstudio_02_0291__en-us_topic_0108272853_row3034171115124"><td class="cellrowborder" valign="top" width="22.772277227722768%" headers="mcps1.3.2.2.1.5.1.1 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p3395516415124">fromJobConfig.maxPollRecords</p>
</td>
<td class="cellrowborder" valign="top" width="19.8019801980198%" headers="mcps1.3.2.2.1.5.1.2 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p6601372415124">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.1.5.1.3 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p4551140015124">String</p>
</td>
<td class="cellrowborder" valign="top" width="38.6138613861386%" headers="mcps1.3.2.2.1.5.1.4 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p6254480915124">Maximum number of requests that can be sent to DIS each time</p>
</td>
</tr>
<tr id="dataartsstudio_02_0291__en-us_topic_0108272853_row4065400315124"><td class="cellrowborder" valign="top" width="22.772277227722768%" headers="mcps1.3.2.2.1.5.1.1 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p2824781215124">fromJobConfig.shardId</p>
</td>
<td class="cellrowborder" valign="top" width="19.8019801980198%" headers="mcps1.3.2.2.1.5.1.2 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p637144815124">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.1.5.1.3 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p4632524315124">String</p>
</td>
<td class="cellrowborder" valign="top" width="38.6138613861386%" headers="mcps1.3.2.2.1.5.1.4 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p6135724015124">ID of the DIS partition. You can enter multiple partition IDs, which are separated by commas (,).</p>
</td>
</tr>
<tr id="dataartsstudio_02_0291__en-us_topic_0108272853_row177282453112"><td class="cellrowborder" valign="top" width="22.772277227722768%" headers="mcps1.3.2.2.1.5.1.1 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p17565527611">fromJobConfig.dataFormat</p>
</td>
<td class="cellrowborder" valign="top" width="19.8019801980198%" headers="mcps1.3.2.2.1.5.1.2 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p165651821569">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.1.5.1.3 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p3565025614">Enumeration</p>
</td>
<td class="cellrowborder" valign="top" width="38.6138613861386%" headers="mcps1.3.2.2.1.5.1.4 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p111321138622">Format used for parsing data. The options are as follows:</p>
<ul id="dataartsstudio_02_0291__en-us_topic_0108272853_ul59573391929"><li id="dataartsstudio_02_0291__en-us_topic_0108272853_li169571839927"><strong id="dataartsstudio_02_0291__en-us_topic_0108272853_b10893924344">BINARY</strong>: Data is transferred without being parsed, which is applicable to file migration.</li><li id="dataartsstudio_02_0291__en-us_topic_0108272853_li1085014450210"><strong id="dataartsstudio_02_0291__en-us_topic_0108272853_b886418571956">CSV</strong>: Source data will be migrated after being parsed in CSV format.</li></ul>
</td>
</tr>
<tr id="dataartsstudio_02_0291__en-us_topic_0108272853_row4268185173352"><td class="cellrowborder" valign="top" width="22.772277227722768%" headers="mcps1.3.2.2.1.5.1.1 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p10178715173352">fromJobConfig.separator</p>
</td>
<td class="cellrowborder" valign="top" width="19.8019801980198%" headers="mcps1.3.2.2.1.5.1.2 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p19169610173352">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.1.5.1.3 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p9234573173352">String</p>
</td>
<td class="cellrowborder" valign="top" width="38.6138613861386%" headers="mcps1.3.2.2.1.5.1.4 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p9802957173352">Field delimiter</p>
</td>
</tr>
<tr id="dataartsstudio_02_0291__en-us_topic_0108272853_row8201182620484"><td class="cellrowborder" valign="top" width="22.772277227722768%" headers="mcps1.3.2.2.1.5.1.1 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p2020117268481">fromJobConfig.appName</p>
</td>
<td class="cellrowborder" valign="top" width="19.8019801980198%" headers="mcps1.3.2.2.1.5.1.2 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p13201126194815">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.81188118811881%" headers="mcps1.3.2.2.1.5.1.3 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p1420162613485">String</p>
</td>
<td class="cellrowborder" valign="top" width="38.6138613861386%" headers="mcps1.3.2.2.1.5.1.4 "><p id="dataartsstudio_02_0291__en-us_topic_0108272853_p32011926114812">Unique identifier of the consumer application</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="source_job_parameters.html">Source Job Parameters</a></div>
</div>
</div>