Get the specified writesettings object.
The writesettings
values allow you to specify aspects of the publication of results to the specified path
location.
NOTE: |
NOTE: To specify multiple outputs, you can include additional |
These settings correspond to values that you can apply through the UI. For UI information, see Run Job Page.
Version: v4
Request Type: GET
Endpoint:
/v4/writesettings/<id> |
Request URI - Example:
/v4/writesettings/6/ |
Query parameter reference:
The following query parameters can be submitted with this endpoint:
For more information, see API Common Query Parameters v4.
Request Body:
Empty.
Response Status Code - Success: 200 - OK
Response Body Example:
{ "delim": ",", "id": 6, "path": "hdfs://hadoop:50070/trifacta/queryResults/admin@example.com/POS_r01.pqt", "action": "create", "format": "pqt", "compression": "none", "header": false, "asSingleFile": false, "prefix": null, "suffix": "_increment", "hasQuotes": false, "createdAt": "2018-11-07T23:47:15.144Z", "updatedAt": "2018-11-07T23:47:15.144Z", "creator": { "id": 1 }, "updater": { "id": 1 }, "outputObject": { "id": 5 } } |
Property | Description | |
---|---|---|
delim | The delimiter between field values in an output row | |
id | Internal identifier of the writesettings object | |
path | (required) The fully qualified path to the output location where to write the results | |
action | (required) If the output file or directory exists, you can specify one of the following actions:
| |
format | (required) Output format for the results. Specify one of the following values:
| |
compression | (optional) For
| |
header | (optional) For csv results with action set to create or append , this value determines if a header row with column names is inserted at the top of the results. Default is false . | |
asSingleFile | (optional) For csv and json results, this value determines if the results are concatenated into a single file or stored as multiple files. Default is false . | |
prefix |
| |
suffix |
| |
hasQuotes | If true , each field in the output is wrapped in double-quotes. | |
createdAt | Timestamp for when the writesettings object was created | |
updatedAt | Timestamp for when the writesettings object was last updated | |
creator.id | Internal identifier of the user who created the object | |
updater.id | Internal identifier of the user who last updated the object | |
outputObject.id | If specified, this value is the internal identifier of the outputobject with which this writesettings object is associated. |