ExcelSource Class

public final class ExcelSource
extends CopySource

A copy activity excel source.

Constructor Summary

Constructor Description
ExcelSource()

Creates an instance of ExcelSource class.

Method Summary

Modifier and Type Method and Description
Object additionalColumns()

Get the additionalColumns property: Specifies the additional columns to be added to source data.

static ExcelSource fromJson(JsonReader jsonReader)

Reads an instance of ExcelSource from the JsonReader.

StoreReadSettings storeSettings()

Get the storeSettings property: Excel store settings.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: Copy source type.

void validate()

Validates the instance.

ExcelSource withAdditionalColumns(Object additionalColumns)

Set the additionalColumns property: Specifies the additional columns to be added to source data.

ExcelSource withDisableMetricsCollection(Object disableMetricsCollection)

Set the disableMetricsCollection property: If true, disable data store metrics collection.

ExcelSource withMaxConcurrentConnections(Object maxConcurrentConnections)

Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.

ExcelSource withSourceRetryCount(Object sourceRetryCount)

Set the sourceRetryCount property: Source retry count.

ExcelSource withSourceRetryWait(Object sourceRetryWait)

Set the sourceRetryWait property: Source retry wait.

ExcelSource withStoreSettings(StoreReadSettings storeSettings)

Set the storeSettings property: Excel store settings.

Methods inherited from CopySource

Methods inherited from java.lang.Object

Constructor Details

ExcelSource

public ExcelSource()

Creates an instance of ExcelSource class.

Method Details

additionalColumns

public Object additionalColumns()

Get the additionalColumns property: Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Returns:

the additionalColumns value.

fromJson

public static ExcelSource fromJson(JsonReader jsonReader)

Reads an instance of ExcelSource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ExcelSource if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the ExcelSource.

storeSettings

public StoreReadSettings storeSettings()

Get the storeSettings property: Excel store settings.

Returns:

the storeSettings value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ExcelSource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Copy source type.

Overrides:

ExcelSource.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

ExcelSource.validate()

withAdditionalColumns

public ExcelSource withAdditionalColumns(Object additionalColumns)

Set the additionalColumns property: Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

Parameters:

additionalColumns - the additionalColumns value to set.

Returns:

the ExcelSource object itself.

withDisableMetricsCollection

public ExcelSource withDisableMetricsCollection(Object disableMetricsCollection)

Set the disableMetricsCollection property: If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).

Overrides:

ExcelSource.withDisableMetricsCollection(Object disableMetricsCollection)

Parameters:

disableMetricsCollection

withMaxConcurrentConnections

public ExcelSource withMaxConcurrentConnections(Object maxConcurrentConnections)

Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).

Overrides:

ExcelSource.withMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

withSourceRetryCount

public ExcelSource withSourceRetryCount(Object sourceRetryCount)

Set the sourceRetryCount property: Source retry count. Type: integer (or Expression with resultType integer).

Overrides:

ExcelSource.withSourceRetryCount(Object sourceRetryCount)

Parameters:

sourceRetryCount

withSourceRetryWait

public ExcelSource withSourceRetryWait(Object sourceRetryWait)

Set the sourceRetryWait property: Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Overrides:

ExcelSource.withSourceRetryWait(Object sourceRetryWait)

Parameters:

sourceRetryWait

withStoreSettings

public ExcelSource withStoreSettings(StoreReadSettings storeSettings)

Set the storeSettings property: Excel store settings.

Parameters:

storeSettings - the storeSettings value to set.

Returns:

the ExcelSource object itself.

Applies to