PLUGINSPLUGIN-SINGERTASKSTAPSIO.KESTRA.PLUGIN.SINGER.TAPS.NETSUITE

​Netsuite

Netsuite Netsuite

yaml
type: "io.kestra.plugin.singer.taps.Netsuite"

A Singer tap to fetch data from a Netsuite account.

Full documentation can be found here

Properties

accountId

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

Your account Id.

This can be found under Setup -> Company -> Company Information. Look for Account Id. Note _SB is for Sandbox account.

consumerKey

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

Your consumer key for token based authentication consumer key for SOAP connection

Visit this page for details.

consumerSecret

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

Your consumer secret for token based authentication consumer key for SOAP connection.

Visit this page for details.

exitOnFailed

  • Type: boolean
  • Dynamic: ❌
  • Required: ✔️
  • Default: true

Exit if any non true return value

This tells bash that it should exit the script if any statement returns a non-true return value. The benefit of using -e is that it prevents errors snowballing into serious issues when they could have been caught earlier.

interpreter

  • Type: string
  • Dynamic: ❌
  • Required: ✔️
  • Default: /bin/sh
  • Min length: 1

Interpreter to used

isSandbox

  • Type: boolean
  • Dynamic: ✔️
  • Required: ✔️

Is this sandbox account

This should always be set to true if you are connecting Production account of NetSuite. Set it to false if you want to connect to SandBox account.

pythonPath

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Default: python
  • Min length: 1

The python interpreter to use

Set the python interpreter path to use

raw

  • Type: boolean
  • Dynamic: ❌
  • Required: ✔️
  • Default: true

Send singer as raw data

Using raw data can be used with any singer target, otherwise, schemas and records will be output in kestra storage format.

runner

  • Type: string
  • Dynamic: ❌
  • Required: ✔️
  • Default: PROCESS
  • Possible Values:
    • PROCESS
    • DOCKER

Runner to use

selectFieldsByDefault

  • Type: boolean
  • Dynamic: ✔️
  • Required: ✔️

Behaviour when new fields are discovered

When new fields are discovered in NetSuite objects, the select_fields_by_default key describes whether or not the tap will select those fields by default.

startDate

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

Determines how much historical data will be extracted.

Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

stateName

  • Type: string
  • Dynamic: ❌
  • Required: ✔️
  • Default: singer-state

The name of singer state file

streamsConfigurations

The list of stream configurations

tokenKey

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

Your token key for token based authentication consumer key for SOAP connection.

Visit this page for details.

tokenSecret

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

our token secret for token based authentication consumer key for SOAP connection.

Visit this page for details.

warningOnStdErr

  • Type: boolean
  • Dynamic: ❌
  • Required: ✔️
  • Default: true

Use WARNING state if any stdErr is sent

args

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

Python command args

Arguments list to pass to main python script

command

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Override default singer command

dockerOptions

Docker options when using runner DOCKER

env

  • Type: object
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

Additional environments variable to add for current process.

files

🔒 Deprecated

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

The list of files that will be uploaded to internal storage,

use outputFiles property instead

inputFiles

  • Type: object
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

Input files are extra files that will be available in the script working directory.

You can define the files as map or a JSON string.Each file can be defined inlined or can reference a file from Kestra's internal storage.

interpreterArgs

  • Type: array
  • SubType: string
  • Dynamic: ❌
  • Required: ❌
  • Default: [-c]

Interpreter args used

outputDirs

  • Type: array
  • SubType: string
  • Dynamic: ❌
  • Required: ❌

Output dirs list that will be uploaded to internal storage

List of key that will generate temporary directories. On the command, just can use with special variable named outputDirs.key. If you add a files with ["myDir"], you can use the special vars echo 1 >> {[ outputDirs.myDir }}/file1.txt and echo 2 >> {[ outputDirs.myDir }}/file2.txt and both files will be uploaded to internal storage. Then you can used them on others tasks using null

outputFiles

  • Type: array
  • SubType: string
  • Dynamic: ❌
  • Required: ❌

Output file list that will be uploaded to internal storage

List of key that will generate temporary files. On the command, just can use with special variable named outputFiles.key. If you add a files with ["first"], you can use the special vars echo 1 >> {[ outputFiles.first }} and you used on others tasks using null

outputsFiles

🔒 Deprecated

  • Type: array
  • SubType: string
  • Dynamic: ❌
  • Required: ❌

Deprecated Output file

use outputFiles

pipPackages

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

Override default pip packages to use a specific version

requirements

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

Requirements are python dependencies to add to the python execution process

Python dependencies list to setup in the virtualenv, in the same format than requirements.txt

Outputs

count

  • Type: object
  • SubType: integer

Counter of streams

raw

  • Type: string
  • SubType: string

Raw singer streams

Json multiline file with raw singer format that can be passed to a target

schemas

  • Type: object
  • SubType: string

Map of schemas captured

Key is stream name, value is uri of the schema file on ion kestra storage

state

  • Type: string

Uri of the state file

streams

  • Type: object
  • SubType: string

Map of stream captured

Key is stream name, value is uri of the stream file on ion kestra storage

Definitions

DockerOptions-Memory

kernelMemory

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The maximum amount of kernel memory the container can use.

The minimum allowed value is 4m. Because kernel memory cannot be swapped out, a container which is starved of kernel memory may block host machine resources, which can have side effects on the host machine and on other containers. See --kernel-memory details.

memory

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The maximum amount of memory the container can use.

That is, you must set the value to at least 6 megabytes.

memoryReservation

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Allows you to specify a soft limit smaller than --memory which is activated when Docker detects contention or low memory on the host machine.

If you use memoryReservation, it must be set lower than memory for it to take precedence. Because it is a soft limit, it does not guarantee that the container doesn’t exceed the limit.

memorySwap

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The amount of memory this container is allowed to swap to disk

If memory and memorySwap are set to the same value, this prevents containers from using any swap. This is because memorySwap is the amount of combined memory and swap that can be used, while memory is only the amount of physical memory that can be used.

memorySwappiness

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The amount of memory this container is allowed to swap to disk

By default, the host kernel can swap out a percentage of anonymous pages used by a container. You can set memorySwappiness to a value between 0 and 100, to tune this percentage.

oomKillDisable

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌

By default, if an out-of-memory (OOM) error occurs, the kernel kills processes in a container.

To change this behavior, use the oomKillDisable option. Only disable the OOM killer on containers where you have also set the memory option. If the memory flag is not set, the host can run out of memory and the kernel may need to kill the host system’s processes to free memory.

DockerOptions

image

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

Docker image to use

cpu

Limits cpu usage.

By default, each container’s access to the host machine’s CPU cycles is unlimited. You can set various constraints to limit a given container’s access to the host machine’s CPU cycles.

deviceRequests

A list of request for devices to be sent to device drivers

dockerConfig

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Docker config file

Full file that can be used to configure private registries, ...

dockerHost

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Docker api uri

entryPoint

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

Docker entrypoint to use

extraHosts

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

Docker extra host to use

memory

Limits memory usage.

Docker can enforce hard memory limits, which allow the container to use no more than a given amount of user or system memory, or soft limits, which allow the container to use as much memory as it needs unless certain conditions are met, such as when the kernel detects low memory or contention on the host machine. Some of these options have different effects when used alone or when more than one option is set.

networkMode

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Docker network mode to use

pullImage

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌
  • Default: true

Is a pull of image must be done before starting the container

Mostly used for local image with registry

user

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Docker user to use

volumes

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

List of volumes to mount

Must be a valid mount expression as string, example : /home/user:/app

Volumes mount are disabled by default for security reasons, you must enabled on server configuration with kestra.tasks.scripts.docker.volume-enabled to true

DockerOptions-Cpu

cpus

  • Type: integer
  • Dynamic: ❓
  • Required: ❌

Specify how much of the available CPU resources a container can use.

For instance, if the host machine has two CPUs and you set cpus:"1.5", the container is guaranteed at most one and a half of the CPUs

StreamsConfiguration

propertiesPattern

  • Type: array
  • SubType: string
  • Dynamic: ❓
  • Required: ❌

replicationKeys

  • Type: string
  • Dynamic: ❓
  • Required: ❌

replicationMethod

  • Type: string
  • Dynamic: ❓
  • Required: ❌
  • Possible Values:
    • FULL_TABLE
    • INCREMENTAL
    • LOG_BASED

selected

  • Type: boolean
  • Dynamic: ❓
  • Required: ❌
  • Default: true

stream

  • Type: string
  • Dynamic: ❓
  • Required: ❌

DockerOptions-DeviceRequest

capabilities

  • Type: array
  • SubType: array
  • Dynamic: ❓
  • Required: ❌

A list of capabilities; an OR list of AND lists of capabilities.

count

  • Type: integer
  • Dynamic: ❓
  • Required: ❌

A request for devices to be sent to device drivers

deviceIds

  • Type: array
  • SubType: string
  • Dynamic: ❓
  • Required: ❌

A request for devices to be sent to device drivers

driver

  • Type: string
  • Dynamic: ❓
  • Required: ❌

A request for devices to be sent to device drivers

options

  • Type: object
  • SubType: string
  • Dynamic: ❓
  • Required: ❌

Driver-specific options, specified as a key/value pairs.

These options are passed directly to the driver.