DelimitedTextDataset Class

Definition

Delimited text dataset.

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

Constructors

DelimitedTextDataset(DataFactoryLinkedServiceReference)

Initializes a new instance of DelimitedTextDataset.

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 DataFactoryDatasetProperties)
Annotations

List of tags that can be used for describing the Dataset.

To assign an object to the element 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 DataFactoryDatasetProperties)
ColumnDelimiter

The column delimiter. Type: string (or Expression with resultType string).

CompressionCodec

The data compressionCodec. Type: string (or Expression with resultType string).

CompressionLevel

The data compression method used for DelimitedText.

DataLocation

The location of the delimited text storage. Please note DatasetLocation 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 AmazonS3CompatibleLocation, AmazonS3Location, AzureBlobFSLocation, AzureBlobStorageLocation, AzureDataLakeStoreLocation, AzureFileStorageLocation, FileServerLocation, FtpServerLocation, GoogleCloudStorageLocation, HdfsLocation, HttpServerLocation, LakeHouseLocation, OracleCloudStorageLocation and SftpLocation.

Description

Dataset description.

(Inherited from DataFactoryDatasetProperties)
EncodingName

The code page name of the preferred encoding. If miss, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).

EscapeChar

The escape character. Type: string (or Expression with resultType string).

FirstRowAsHeader

When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).

FolderName

The name of the folder that this Dataset is in.

(Inherited from DataFactoryDatasetProperties)
LinkedServiceName

Linked service reference.

(Inherited from DataFactoryDatasetProperties)
NullValue

The null value string. Type: string (or Expression with resultType string).

Parameters

Parameters for dataset.

(Inherited from DataFactoryDatasetProperties)
QuoteChar

The quote character. Type: string (or Expression with resultType string).

RowDelimiter

The row delimiter. Type: string (or Expression with resultType string).

Schema

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

(Inherited from DataFactoryDatasetProperties)
Structure

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

(Inherited from DataFactoryDatasetProperties)

Methods

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

Explicit Interface Implementations

IJsonModel<DataFactoryDatasetProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from DataFactoryDatasetProperties)
IJsonModel<DelimitedTextDataset>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<DelimitedTextDataset>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<DataFactoryDatasetProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from DataFactoryDatasetProperties)
IPersistableModel<DelimitedTextDataset>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<DelimitedTextDataset>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<DelimitedTextDataset>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to