com.datasift.client.push.connectors

Class SFTP

java.lang.Object

com.datasift.client.push.connectors.BaseConnector<SFTP>

com.datasift.client.push.connectors.SFTP

All Implemented Interfaces:

PushConnector<SFTP>

public class SFTP
extends BaseConnector<SFTP>

Official docs

Author:

Courtney Robinson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SFTP.SFTPFormat

Field Summary

Fields inherited from class com.datasift.client.push.connectors.BaseConnector

params, PREFIX, required

Constructor Summary

Constructors

Constructor and Description
SFTP()

Method Summary

Methods

Modifier and Type	Method and Description
SFTP	auth(String username, String password) Sets the authentication information that should be used for the connector
SFTP	compression(String format)
SFTP	deliveryFrequency(int freq) The minimum number of seconds you want DataSift to wait before sending data again: 10 (10 seconds) 30 (30 seconds) 60 (1 minute) 120 (2 minutes) 300 (5 minutes) In reality, a stream might not have data available after the wait.
SFTP	directory(String directory) A directory on the server
SFTP	filePrefix(String prefix) An optional prefix to the filename.
SFTP	format(SFTP.SFTPFormat format) The output format for your data: json_meta - The current default format, where each payload contains a full JSON document.
SFTP	gzip()
SFTP	host(String host)
SFTP	markInProgress(boolean trueOrFalse) This enables you to see which files are being written and which are complete.
SFTP	maxSize(int max) The maximum amount of data that DataSift will send in a single batch: 102400 (100KB) 256000 (250KB) 512000 (500KB) 1048576 (1MB) 2097152 (2MB) 5242880 (5MB) 10485760 (10MB) 20971520 (20MB) 52428800 (50MB) 104857600 (100MB) 209715200 (200MB)
SFTP	password(String password)
SFTP	port(int host)
SFTP	url(String host, int port) Simple calls host(String).port(int) for convenience
SFTP	username(String username)

Methods inherited from class com.datasift.client.push.connectors.BaseConnector

exists, fromMap, parameters, putAll, setParam, setup, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SFTP

public SFTP()

Method Detail

url

public SFTP url(String host,
       int port)

Simple calls host(String).port(int) for convenience

Parameters:

host - the host of the server

port - the port on which the connection will be attempted

Returns:

this

host

public SFTP host(String host)

Parameters:

host - The host name of your CouchDB installation.

Returns:

this

port

public SFTP port(int host)

Parameters:

host - You can specify a port or accept the default.

Returns:

this

directory

public SFTP directory(String directory)

A directory on the server

Returns:

this

deliveryFrequency

public SFTP deliveryFrequency(int freq)

The minimum number of seconds you want DataSift to wait before sending data again:

10 (10 seconds)

30 (30 seconds)

60 (1 minute)

120 (2 minutes)

300 (5 minutes)

In reality, a stream might not have data available after the wait. Typically this happens in streams that have very tight filtering constraints, so the wait time might be longer than you specify. If your system is capable of handling large amounts of incoming data, we recommend you use continuous delivery:

0 (continuous delivery)

Returns:

this

maxSize

public SFTP maxSize(int max)

The maximum amount of data that DataSift will send in a single batch: 102400 (100KB) 256000 (250KB) 512000 (500KB) 1048576 (1MB) 2097152 (2MB) 5242880 (5MB) 10485760 (10MB) 20971520 (20MB) 52428800 (50MB) 104857600 (100MB) 209715200 (200MB)

Returns:

this

filePrefix

public SFTP filePrefix(String prefix)

An optional prefix to the filename. Each time Datasift delivers a file, it constructs a name in this format: file_prefix + subscription id + timestamp.json

Returns:

this

auth

public SFTP auth(String username,
        String password)

Sets the authentication information that should be used for the connector

Parameters:

username - the username

password - the password

Returns:

this

username

public SFTP username(String username)

Parameters:

username - he username for authorization.

Returns:

this

password

public SFTP password(String password)

Parameters:

password - The password for authorization.

Returns:

this

markInProgress

public SFTP markInProgress(boolean trueOrFalse)

This enables you to see which files are being written and which are complete. Possible values are:

true

false

If you omit this parameter, it defaults to false. If you set it to true, we append ".part" to the filename while we're writing to it. Once the transfer is complete, we remove ".part".

Returns:

this

gzip

public SFTP gzip()

compression

public SFTP compression(String format)

format

public SFTP format(SFTP.SFTPFormat format)

The output format for your data:

json_meta - The current default format, where each payload contains a full JSON document. It contains metadata and an "interactions" property that has an array of interactions.

json_array - The payload is a full JSON document, but just has an array of interactions.

json_new_line - The payload is NOT a full JSON document. Each interaction is flattened and separated by a line break. If you omit this parameter or set it to json_meta, your output consists of JSON metadata followed by a JSON array of interactions (wrapped in square brackets and separated by commas). Take a look at our Sample Output for File-Based Connectors page. If you select json_array, DataSift omits the metadata and sends just the array of interactions. If you select json_new_line, DataSift omits the metadata and sends each interaction as a single JSON object.

Returns:

this