REST API Reference

Back Next

Configuration information in the config array for ADLS Gen2 as a target

The response returns only the fields that you entered in the request.

If the request is successful, the response returns the following fields:

Key	Type	Description
writeStrategy	String	The action to take when a file exists in the ADLS Gen2 storage.
rolloverSize *	Integer	Target file size, in KB, at which to trigger rollover. Applies to a Rollover write strategy.
rolloverEvents *	Integer	Number of events or messages to accumulate before a rollover. Applies to a Rollover write strategy.
rolloverTime *	Integer	Length of time, in milliseconds, after which to trigger a rollover. Applies to a Rollover write strategy.
filesystemNameOverride	String	Overrides the default file system name provided in the connection. This file system name is used write to a file at run time.
directoryOverride	String	Overrides the default directory path. The ADLS Gen2 directory path to write data to. If left blank, the default directory path is used.
compressionFormat	String	Compression format to use before the streaming ingestion task writes data to the target file.
File Name/Expression	String	ADLS Gen2 file name or a regular expression.
* Enter a value for at least one of the fields.

If the request is unsuccessful, the response includes a reason for the failure.

POST response example

If the request is successful, you might receive a response similar to the following example in a

Success

node:

{
  "Success": {
    "name": "flatfile to adls",
    "description": "flatfile to adls",
    "runtimeId": "01000025000000000003",
    "locationId": "5sJ0JDyJyWLlrosS5qJjsQ",
    "currentVersion": "2",
    "messageFormat": "binary",
    "nodes": [
      {
        "name": "flatfile to adls_source",
        "type": "source",
        "connectionId": "012MGS0B00000000002N",
        "transformationType": "",
        "config": [
          {
            "key": "File",
            "value": "logfile"
          },
          {
            "key": "initialPosition",
            "value": "Current Time"
          },
          {
            "key": "rolloverPattern",
            "value": "test"
          },
          {
            "key": "tailingMode",
            "value": "Single file"
          }
        ]
      },
      {
        "name": "flatfile to adls_target",
        "type": "target",
        "connectionId": "012MGS0B00000000003D",
        "transformationType": "",
        "config": [
          {
            "key": "writeStrategy",
            "value": "Rollover"
          },
          {
            "key": "filesystemNameOverride",
            "value": "test"
          },
          {
            "key": "File Name/Expression",
            "value": "test"
          },
          {
            "key": "compressionFormat",
            "value": "NONE"
          },
          {
            "key": "directoryOverride",
            "value": "/test"
          },
          {
            "key": "interimDirectory",
            "value": "/home/agent/test"
          },
          {
            "key": "rolloverSize",
            "value": 1024
          },
          {
            "key": "rolloverEvents",
            "value": 100
          },
          {
            "key": "rolloverTime",
            "value": 300000
          }
        ]
      }
    ]
  }
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Configuration information in the config array for ADLS Gen2 as a target

Configuration information in the config array for ADLS Gen2 as a target

POST response example