XmlReadSettings Class

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

public final class XmlReadSettings
extends FormatReadSettings

Xml read settings.

Constructor Summary

Constructor Description
XmlReadSettings()

Creates an instance of XmlReadSettings class.

Method Summary

Modifier and Type Method and Description
static XmlReadSettings fromJson(JsonReader jsonReader)

Reads an instance of XmlReadSettings from the JsonReader.
CompressionReadSettings getCompressionProperties()

Get the compressionProperties property: Compression settings.
Object getDetectDataType()

Get the detectDataType property: Indicates whether type detection is enabled when reading the xml files.
Object getNamespacePrefixes()

Get the namespacePrefixes property: Namespace uri to prefix mappings to override the prefixes in column names when namespace is enabled, if no prefix is defined for a namespace uri, the prefix of xml element/attribute name in the xml data file will be used.
Object getNamespaces()

Get the namespaces property: Indicates whether namespace is enabled when reading the xml files.
String getType()

Get the type property: The read setting type.
Object getValidationMode()

Get the validationMode property: Indicates what validation method is used when reading the xml files.
XmlReadSettings setCompressionProperties(CompressionReadSettings compressionProperties)

Set the compressionProperties property: Compression settings.
XmlReadSettings setDetectDataType(Object detectDataType)

Set the detectDataType property: Indicates whether type detection is enabled when reading the xml files.
XmlReadSettings setNamespacePrefixes(Object namespacePrefixes)

Set the namespacePrefixes property: Namespace uri to prefix mappings to override the prefixes in column names when namespace is enabled, if no prefix is defined for a namespace uri, the prefix of xml element/attribute name in the xml data file will be used.
XmlReadSettings setNamespaces(Object namespaces)

Set the namespaces property: Indicates whether namespace is enabled when reading the xml files.
XmlReadSettings setValidationMode(Object validationMode)

Set the validationMode property: Indicates what validation method is used when reading the xml files.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from FormatReadSettings

fromJson getAdditionalProperties getType setAdditionalProperties toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

XmlReadSettings

public XmlReadSettings()

Creates an instance of XmlReadSettings class.

Method Details

fromJson

public static XmlReadSettings fromJson(JsonReader jsonReader)

Reads an instance of XmlReadSettings from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getCompressionProperties

public CompressionReadSettings getCompressionProperties()

Get the compressionProperties property: Compression settings.

Returns:

the compressionProperties value.

getDetectDataType

public Object getDetectDataType()

Get the detectDataType property: Indicates whether type detection is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean).

Returns:

the detectDataType value.

getNamespacePrefixes

public Object getNamespacePrefixes()

Get the namespacePrefixes property: Namespace uri to prefix mappings to override the prefixes in column names when namespace is enabled, if no prefix is defined for a namespace uri, the prefix of xml element/attribute name in the xml data file will be used. Example: "{"http://www.example.com/xml":"prefix"}" Type: object (or Expression with resultType object).

Returns:

the namespacePrefixes value.

getNamespaces

public Object getNamespaces()

Get the namespaces property: Indicates whether namespace is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean).

Returns:

the namespaces value.

getType

public String getType()

Get the type property: The read setting type.

Overrides:

XmlReadSettings.getType()

Returns:

the type value.

getValidationMode

public Object getValidationMode()

Get the validationMode property: Indicates what validation method is used when reading the xml files. Allowed values: 'none', 'xsd', or 'dtd'. Type: string (or Expression with resultType string).

Returns:

the validationMode value.

setCompressionProperties

public XmlReadSettings setCompressionProperties(CompressionReadSettings compressionProperties)

Set the compressionProperties property: Compression settings.

Parameters:

compressionProperties - the compressionProperties value to set.

Returns:

the XmlReadSettings object itself.

setDetectDataType

public XmlReadSettings setDetectDataType(Object detectDataType)

Set the detectDataType property: Indicates whether type detection is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean).

Parameters:

detectDataType - the detectDataType value to set.

Returns:

the XmlReadSettings object itself.

setNamespacePrefixes

public XmlReadSettings setNamespacePrefixes(Object namespacePrefixes)

Set the namespacePrefixes property: Namespace uri to prefix mappings to override the prefixes in column names when namespace is enabled, if no prefix is defined for a namespace uri, the prefix of xml element/attribute name in the xml data file will be used. Example: "{"http://www.example.com/xml":"prefix"}" Type: object (or Expression with resultType object).

Parameters:

namespacePrefixes - the namespacePrefixes value to set.

Returns:

the XmlReadSettings object itself.

setNamespaces

public XmlReadSettings setNamespaces(Object namespaces)

Set the namespaces property: Indicates whether namespace is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean).

Parameters:

namespaces - the namespaces value to set.

Returns:

the XmlReadSettings object itself.

setValidationMode

public XmlReadSettings setValidationMode(Object validationMode)

Set the validationMode property: Indicates what validation method is used when reading the xml files. Allowed values: 'none', 'xsd', or 'dtd'. Type: string (or Expression with resultType string).

Parameters:

validationMode - the validationMode value to set.

Returns:

the XmlReadSettings object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

XmlReadSettings.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to