XmlSource Class

public final class XmlSource
extends CopySource

A copy activity Xml source.

Constructor Summary

Constructor Description
XmlSource()

Creates an instance of XmlSource 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.

XmlReadSettings formatSettings()

Get the formatSettings property: Xml format settings.

static XmlSource fromJson(JsonReader jsonReader)

Reads an instance of XmlSource from the JsonReader.

StoreReadSettings storeSettings()

Get the storeSettings property: Xml store settings.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: Copy source type.

void validate()

Validates the instance.

XmlSource withAdditionalColumns(Object additionalColumns)

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

XmlSource withDisableMetricsCollection(Object disableMetricsCollection)

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

XmlSource withFormatSettings(XmlReadSettings formatSettings)

Set the formatSettings property: Xml format settings.

XmlSource withMaxConcurrentConnections(Object maxConcurrentConnections)

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

XmlSource withSourceRetryCount(Object sourceRetryCount)

Set the sourceRetryCount property: Source retry count.

XmlSource withSourceRetryWait(Object sourceRetryWait)

Set the sourceRetryWait property: Source retry wait.

XmlSource withStoreSettings(StoreReadSettings storeSettings)

Set the storeSettings property: Xml store settings.

Methods inherited from CopySource

Methods inherited from java.lang.Object

Constructor Details

XmlSource

public XmlSource()

Creates an instance of XmlSource 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.

formatSettings

public XmlReadSettings formatSettings()

Get the formatSettings property: Xml format settings.

Returns:

the formatSettings value.

fromJson

public static XmlSource fromJson(JsonReader jsonReader)

Reads an instance of XmlSource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of XmlSource 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 XmlSource.

storeSettings

public StoreReadSettings storeSettings()

Get the storeSettings property: Xml store settings.

Returns:

the storeSettings value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

XmlSource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Copy source type.

Overrides:

XmlSource.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

XmlSource.validate()

withAdditionalColumns

public XmlSource 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 XmlSource object itself.

withDisableMetricsCollection

public XmlSource 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:

XmlSource.withDisableMetricsCollection(Object disableMetricsCollection)

Parameters:

disableMetricsCollection

withFormatSettings

public XmlSource withFormatSettings(XmlReadSettings formatSettings)

Set the formatSettings property: Xml format settings.

Parameters:

formatSettings - the formatSettings value to set.

Returns:

the XmlSource object itself.

withMaxConcurrentConnections

public XmlSource 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:

XmlSource.withMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

withSourceRetryCount

public XmlSource withSourceRetryCount(Object sourceRetryCount)

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

Overrides:

XmlSource.withSourceRetryCount(Object sourceRetryCount)

Parameters:

sourceRetryCount

withSourceRetryWait

public XmlSource 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:

XmlSource.withSourceRetryWait(Object sourceRetryWait)

Parameters:

sourceRetryWait

withStoreSettings

public XmlSource withStoreSettings(StoreReadSettings storeSettings)

Set the storeSettings property: Xml store settings.

Parameters:

storeSettings - the storeSettings value to set.

Returns:

the XmlSource object itself.

Applies to