Package com.azure.analytics.synapse.artifacts.models

Class DelimitedTextDataset

  • public class DelimitedTextDataset
extends Dataset
    Delimited text dataset.

    • Constructor Detail

      • DelimitedTextDataset

        public DelimitedTextDataset()

    • Method Detail

      • getLocation

        public DatasetLocation getLocation()
        Get the location property: The location of the delimited text storage.
        Returns:
        the location value.

      • setLocation

        public DelimitedTextDataset setLocation​(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.

      • getColumnDelimiter

        public Object getColumnDelimiter()
        Get the columnDelimiter property: The column delimiter. Type: string (or Expression with resultType string).
        Returns:
        the columnDelimiter value.

      • setColumnDelimiter

        public DelimitedTextDataset setColumnDelimiter​(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.

      • getRowDelimiter

        public Object getRowDelimiter()
        Get the rowDelimiter property: The row delimiter. Type: string (or Expression with resultType string).
        Returns:
        the rowDelimiter value.

      • setRowDelimiter

        public DelimitedTextDataset setRowDelimiter​(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.

      • getEncodingName

        public Object getEncodingName()
        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.

      • setEncodingName

        public DelimitedTextDataset setEncodingName​(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.

      • getCompressionCodec

        public Object getCompressionCodec()
        Get the compressionCodec property: The data compressionCodec. Type: string (or Expression with resultType string).
        Returns:
        the compressionCodec value.

      • setCompressionCodec

        public DelimitedTextDataset setCompressionCodec​(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.

      • getCompressionLevel

        public Object getCompressionLevel()
        Get the compressionLevel property: The data compression method used for DelimitedText.
        Returns:
        the compressionLevel value.

      • setCompressionLevel

        public DelimitedTextDataset setCompressionLevel​(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.

      • getQuoteChar

        public Object getQuoteChar()
        Get the quoteChar property: The quote character. Type: string (or Expression with resultType string).
        Returns:
        the quoteChar value.

      • setQuoteChar

        public DelimitedTextDataset setQuoteChar​(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.

      • getEscapeChar

        public Object getEscapeChar()
        Get the escapeChar property: The escape character. Type: string (or Expression with resultType string).
        Returns:
        the escapeChar value.

      • setEscapeChar

        public DelimitedTextDataset setEscapeChar​(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.

      • getFirstRowAsHeader

        public Object getFirstRowAsHeader()
        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.

      • setFirstRowAsHeader

        public DelimitedTextDataset setFirstRowAsHeader​(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.

      • getNullValue

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

      • setNullValue

        public DelimitedTextDataset setNullValue​(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.

      • setDescription

        public DelimitedTextDataset setDescription​(String description)
        Set the description property: Dataset description.
        Overrides:
        setDescription in class Dataset
        Parameters:
        description - the description value to set.
        Returns:
        the Dataset object itself.

      • setStructure

        public DelimitedTextDataset setStructure​(Object structure)
        Set the structure property: Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
        Overrides:
        setStructure in class Dataset
        Parameters:
        structure - the structure value to set.
        Returns:
        the Dataset object itself.

      • setSchema

        public DelimitedTextDataset setSchema​(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:
        setSchema in class Dataset
        Parameters:
        schema - the schema value to set.
        Returns:
        the Dataset object itself.

      • setAnnotations

        public DelimitedTextDataset setAnnotations​(List<Object> annotations)
        Set the annotations property: List of tags that can be used for describing the Dataset.
        Overrides:
        setAnnotations in class Dataset
        Parameters:
        annotations - the annotations value to set.
        Returns:
        the Dataset object itself.

      • setFolder

        public DelimitedTextDataset setFolder​(DatasetFolder folder)
        Set the folder property: The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
        Overrides:
        setFolder in class Dataset
        Parameters:
        folder - the folder value to set.
        Returns:
        the Dataset object itself.