com.belladati.sdk.dataset.source

Interface DataSourcePendingImport

All Superinterfaces:

DataSourceImportBase, IdElement

public interface DataSourcePendingImport
extends DataSourceImportBase

An import configuration from a data source to a data set being created by the client.

Author:

Chris Hennigfeld

Method Summary

Methods

Modifier and Type	Method and Description
OverwritePolicy	getOverwritePolicy() Returns the overwrite policy set for this import.
void	post() Submits this import configuration to the server, triggering an import.
DataSourcePendingImport	setOverwritePolicy(OverwritePolicy policy) Sets the overwrite policy to use during this import.
DataSourcePendingImport	setRepeatInterval(ImportIntervalUnit unit, int factor) Sets the interval at which this import is repeated.
com.fasterxml.jackson.databind.JsonNode	toJson() Returns a JSON representation of this pending import to send to the server.

Methods inherited from interface com.belladati.sdk.dataset.source.DataSourceImportBase

getRepeatInterval, isOverwriting

Methods inherited from interface com.belladati.sdk.util.IdElement

getId

Method Detail

setOverwritePolicy

DataSourcePendingImport setOverwritePolicy(OverwritePolicy policy)
                                           throws IllegalStateException

Sets the overwrite policy to use during this import. If none is set, OverwritePolicy.deleteNone() is used.

Parameters:

policy - the overwrite policy to use

Returns:

this import, to allow chaining

Throws:

IllegalStateException - if the import has already been posted to the server

getOverwritePolicy

OverwritePolicy getOverwritePolicy()

Returns the overwrite policy set for this import.

Returns:

the overwrite policy set for this import

setRepeatInterval

DataSourcePendingImport setRepeatInterval(ImportIntervalUnit unit,
                                        int factor)
                                          throws IllegalStateException

Sets the interval at which this import is repeated. By default, the import isn't repeated.

Pass a unit of null or set the factor to 0 or a negative number to clear the interval.

This method has no corresponding getter. Call DataSourceImportBase.getRepeatInterval() instead to retrieve the resulting interval.

Parameters:

unit - time unit for the interval

factor - interval length will be factor * unit

Returns:

this import, to allow chaining

Throws:

IllegalStateException - if the import has already been posted to the server

post

void post()
          throws NotFoundException,
                 IllegalStateException

Submits this import configuration to the server, triggering an import. After submission, all setter methods will throw IllegalStateExceptions.

Throws:

NotFoundException - if the data source for this import configuration doesn't exist on the server

IllegalStateException - if the import has already been posted to the server

toJson

com.fasterxml.jackson.databind.JsonNode toJson()

Returns a JSON representation of this pending import to send to the server. Used by the SDK internally.

Returns:

a JSON representation of this pending import