ExcelSource Class

Package:
com.azure.analytics.synapse.artifacts.models
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17

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
static ExcelSource fromJson(JsonReader jsonReader)

Reads an instance of ExcelSource from the JsonReader.
Object getAdditionalColumns()

Get the additionalColumns property: Specifies the additional columns to be added to source data.
StoreReadSettings getStoreSettings()

Get the storeSettings property: Excel store settings.
String getType()

Get the type property: Copy source type.
ExcelSource setAdditionalColumns(Object additionalColumns)

Set the additionalColumns property: Specifies the additional columns to be added to source data.
ExcelSource setMaxConcurrentConnections(Object maxConcurrentConnections)

Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.
ExcelSource setSourceRetryCount(Object sourceRetryCount)

Set the sourceRetryCount property: Source retry count.
ExcelSource setSourceRetryWait(Object sourceRetryWait)

Set the sourceRetryWait property: Source retry wait.
ExcelSource setStoreSettings(StoreReadSettings storeSettings)

Set the storeSettings property: Excel store settings.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from CopySource

fromJson getAdditionalProperties getMaxConcurrentConnections getSourceRetryCount getSourceRetryWait getType setAdditionalProperties setMaxConcurrentConnections setSourceRetryCount setSourceRetryWait toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ExcelSource

public ExcelSource()

Creates an instance of ExcelSource class.

Method Details

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.

getAdditionalColumns

public Object getAdditionalColumns()

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.

getStoreSettings

public StoreReadSettings getStoreSettings()

Get the storeSettings property: Excel store settings.

Returns:

the storeSettings value.

getType

public String getType()

Get the type property: Copy source type.

Overrides:

ExcelSource.getType()

Returns:

the type value.

setAdditionalColumns

public ExcelSource setAdditionalColumns(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.

setMaxConcurrentConnections

public ExcelSource setMaxConcurrentConnections(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.setMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

setSourceRetryCount

public ExcelSource setSourceRetryCount(Object sourceRetryCount)

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

Overrides:

ExcelSource.setSourceRetryCount(Object sourceRetryCount)

Parameters:

sourceRetryCount

setSourceRetryWait

public ExcelSource setSourceRetryWait(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.setSourceRetryWait(Object sourceRetryWait)

Parameters:

sourceRetryWait

setStoreSettings

public ExcelSource setStoreSettings(StoreReadSettings storeSettings)

Set the storeSettings property: Excel store settings.

Parameters:

storeSettings - the storeSettings value to set.

Returns:

the ExcelSource object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ExcelSource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to