DelimitedTextDataset Class

public final class DelimitedTextDataset
extends Dataset

Delimited text dataset.

Constructor Summary

Constructor Description
DelimitedTextDataset()

Creates an instance of DelimitedTextDataset class.

Method Summary

Modifier and Type Method and Description
Object columnDelimiter()

Get the columnDelimiter property: The column delimiter.

Object compressionCodec()

Get the compressionCodec property: The data compressionCodec.

Object compressionLevel()

Get the compressionLevel property: The data compression method used for DelimitedText.

Object encodingName()

Get the encodingName property: The code page name of the preferred encoding.

Object escapeChar()

Get the escapeChar property: The escape character.

Object firstRowAsHeader()

Get the firstRowAsHeader property: When used as input, treat the first row of data as headers.

DatasetLocation location()

Get the location property: The location of the delimited text storage.

Object nullValue()

Get the nullValue property: The null value string.

Object quoteChar()

Get the quoteChar property: The quote character.

Object rowDelimiter()

Get the rowDelimiter property: The row delimiter.

String type()

Get the type property: Type of dataset.

void validate()

Validates the instance.

DelimitedTextDataset withAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the Dataset.

DelimitedTextDataset withColumnDelimiter(Object columnDelimiter)

Set the columnDelimiter property: The column delimiter.

DelimitedTextDataset withCompressionCodec(Object compressionCodec)

Set the compressionCodec property: The data compressionCodec.

DelimitedTextDataset withCompressionLevel(Object compressionLevel)

Set the compressionLevel property: The data compression method used for DelimitedText.

DelimitedTextDataset withDescription(String description)

Set the description property: Dataset description.

DelimitedTextDataset withEncodingName(Object encodingName)

Set the encodingName property: The code page name of the preferred encoding.

DelimitedTextDataset withEscapeChar(Object escapeChar)

Set the escapeChar property: The escape character.

DelimitedTextDataset withFirstRowAsHeader(Object firstRowAsHeader)

Set the firstRowAsHeader property: When used as input, treat the first row of data as headers.

DelimitedTextDataset withFolder(DatasetFolder folder)

Set the folder property: The folder that this Dataset is in.

DelimitedTextDataset withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

DelimitedTextDataset withLocation(DatasetLocation location)

Set the location property: The location of the delimited text storage.

DelimitedTextDataset withNullValue(Object nullValue)

Set the nullValue property: The null value string.

DelimitedTextDataset withParameters(Map<String,ParameterSpecification> parameters)

Set the parameters property: Parameters for dataset.

DelimitedTextDataset withQuoteChar(Object quoteChar)

Set the quoteChar property: The quote character.

DelimitedTextDataset withRowDelimiter(Object rowDelimiter)

Set the rowDelimiter property: The row delimiter.

DelimitedTextDataset withSchema(Object schema)

Set the schema property: Columns that define the physical type schema of the dataset.

DelimitedTextDataset withStructure(Object structure)

Set the structure property: Columns that define the structure of the dataset.

Methods inherited from Dataset

Methods inherited from java.lang.Object

Constructor Details

DelimitedTextDataset

public DelimitedTextDataset()

Creates an instance of DelimitedTextDataset class.

Method Details

columnDelimiter

public Object columnDelimiter()

Get the columnDelimiter property: The column delimiter. Type: string (or Expression with resultType string).

Returns:

the columnDelimiter value.

compressionCodec

public Object compressionCodec()

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

Returns:

the compressionCodec value.

compressionLevel

public Object compressionLevel()

Get the compressionLevel property: The data compression method used for DelimitedText.

Returns:

the compressionLevel value.

encodingName

public Object encodingName()

Get the encodingName property: 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).

Returns:

the encodingName value.

escapeChar

public Object escapeChar()

Get the escapeChar property: The escape character. Type: string (or Expression with resultType string).

Returns:

the escapeChar value.

firstRowAsHeader

public Object firstRowAsHeader()

Get the firstRowAsHeader property: 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).

Returns:

the firstRowAsHeader value.

location

public DatasetLocation location()

Get the location property: The location of the delimited text storage.

Returns:

the location value.

nullValue

public Object nullValue()

Get the nullValue property: The null value string. Type: string (or Expression with resultType string).

Returns:

the nullValue value.

quoteChar

public Object quoteChar()

Get the quoteChar property: The quote character. Type: string (or Expression with resultType string).

Returns:

the quoteChar value.

rowDelimiter

public Object rowDelimiter()

Get the rowDelimiter property: The row delimiter. Type: string (or Expression with resultType string).

Returns:

the rowDelimiter value.

type

public String type()

Get the type property: Type of dataset.

Overrides:

DelimitedTextDataset.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

DelimitedTextDataset.validate()

withAnnotations

public DelimitedTextDataset withAnnotations(List annotations)

Set the annotations property: List of tags that can be used for describing the Dataset.

Overrides:

DelimitedTextDataset.withAnnotations(List<Object> annotations)

Parameters:

annotations

withColumnDelimiter

public DelimitedTextDataset withColumnDelimiter(Object columnDelimiter)

Set the columnDelimiter property: The column delimiter. Type: string (or Expression with resultType string).

Parameters:

columnDelimiter - the columnDelimiter value to set.

Returns:

the DelimitedTextDataset object itself.

withCompressionCodec

public DelimitedTextDataset withCompressionCodec(Object compressionCodec)

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

Parameters:

compressionCodec - the compressionCodec value to set.

Returns:

the DelimitedTextDataset object itself.

withCompressionLevel

public DelimitedTextDataset withCompressionLevel(Object compressionLevel)

Set the compressionLevel property: The data compression method used for DelimitedText.

Parameters:

compressionLevel - the compressionLevel value to set.

Returns:

the DelimitedTextDataset object itself.

withDescription

public DelimitedTextDataset withDescription(String description)

Set the description property: Dataset description.

Overrides:

DelimitedTextDataset.withDescription(String description)

Parameters:

description

withEncodingName

public DelimitedTextDataset withEncodingName(Object encodingName)

Set the encodingName property: 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).

Parameters:

encodingName - the encodingName value to set.

Returns:

the DelimitedTextDataset object itself.

withEscapeChar

public DelimitedTextDataset withEscapeChar(Object escapeChar)

Set the escapeChar property: The escape character. Type: string (or Expression with resultType string).

Parameters:

escapeChar - the escapeChar value to set.

Returns:

the DelimitedTextDataset object itself.

withFirstRowAsHeader

public DelimitedTextDataset withFirstRowAsHeader(Object firstRowAsHeader)

Set the firstRowAsHeader property: 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).

Parameters:

firstRowAsHeader - the firstRowAsHeader value to set.

Returns:

the DelimitedTextDataset object itself.

withFolder

public DelimitedTextDataset withFolder(DatasetFolder folder)

Set the folder property: The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

Overrides:

DelimitedTextDataset.withFolder(DatasetFolder folder)

Parameters:

folder

withLinkedServiceName

public DelimitedTextDataset withLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

DelimitedTextDataset.withLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

withLocation

public DelimitedTextDataset withLocation(DatasetLocation location)

Set the location property: The location of the delimited text storage.

Parameters:

location - the location value to set.

Returns:

the DelimitedTextDataset object itself.

withNullValue

public DelimitedTextDataset withNullValue(Object nullValue)

Set the nullValue property: The null value string. Type: string (or Expression with resultType string).

Parameters:

nullValue - the nullValue value to set.

Returns:

the DelimitedTextDataset object itself.

withParameters

public DelimitedTextDataset withParameters(Map parameters)

Set the parameters property: Parameters for dataset.

Overrides:

DelimitedTextDataset.withParameters(Map<String,ParameterSpecification> parameters)

Parameters:

parameters

withQuoteChar

public DelimitedTextDataset withQuoteChar(Object quoteChar)

Set the quoteChar property: The quote character. Type: string (or Expression with resultType string).

Parameters:

quoteChar - the quoteChar value to set.

Returns:

the DelimitedTextDataset object itself.

withRowDelimiter

public DelimitedTextDataset withRowDelimiter(Object rowDelimiter)

Set the rowDelimiter property: The row delimiter. Type: string (or Expression with resultType string).

Parameters:

rowDelimiter - the rowDelimiter value to set.

Returns:

the DelimitedTextDataset object itself.

withSchema

public DelimitedTextDataset withSchema(Object schema)

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

Overrides:

DelimitedTextDataset.withSchema(Object schema)

Parameters:

schema

withStructure

public DelimitedTextDataset withStructure(Object structure)

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

Overrides:

DelimitedTextDataset.withStructure(Object structure)

Parameters:

structure

Applies to