Share via


XmlReadSettings Class

Definition

Xml read settings.

public class XmlReadSettings : Azure.ResourceManager.DataFactory.Models.FormatReadSettings, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.XmlReadSettings>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.XmlReadSettings>
public class XmlReadSettings : Azure.ResourceManager.DataFactory.Models.FormatReadSettings
type XmlReadSettings = class
    inherit FormatReadSettings
    interface IJsonModel<XmlReadSettings>
    interface IPersistableModel<XmlReadSettings>
type XmlReadSettings = class
    inherit FormatReadSettings
Public Class XmlReadSettings
Inherits FormatReadSettings
Implements IJsonModel(Of XmlReadSettings), IPersistableModel(Of XmlReadSettings)
Public Class XmlReadSettings
Inherits FormatReadSettings
Inheritance
XmlReadSettings
Implements

Constructors

XmlReadSettings()

Initializes a new instance of XmlReadSettings.

Properties

AdditionalProperties

Additional Properties

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from FormatReadSettings)
CompressionProperties

Compression settings. Please note CompressionReadSettings is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include TarGzipReadSettings, TarReadSettings and ZipDeflateReadSettings.

DetectDataType

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

NamespacePrefixes

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).

Namespaces

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

ValidationMode

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

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from FormatReadSettings)

Explicit Interface Implementations

IJsonModel<FormatReadSettings>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from FormatReadSettings)
IJsonModel<FormatReadSettings>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from FormatReadSettings)
IJsonModel<XmlReadSettings>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<XmlReadSettings>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<FormatReadSettings>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from FormatReadSettings)
IPersistableModel<FormatReadSettings>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from FormatReadSettings)
IPersistableModel<FormatReadSettings>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from FormatReadSettings)
IPersistableModel<XmlReadSettings>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<XmlReadSettings>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<XmlReadSettings>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to