Class DelimitedTextDataset


  • public final class DelimitedTextDataset
    extends Dataset
    Delimited text dataset.
    • Constructor Detail

      • DelimitedTextDataset

        public DelimitedTextDataset()
    • Method Detail

      • withDescription

        public DelimitedTextDataset withDescription​(String description)
        Set the description property: Dataset description.
        Overrides:
        withDescription in class Dataset
        Parameters:
        description - the description value to set.
        Returns:
        the Dataset object itself.
      • 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:
        withStructure in class Dataset
        Parameters:
        structure - the structure value to set.
        Returns:
        the Dataset 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:
        withSchema in class Dataset
        Parameters:
        schema - the schema value to set.
        Returns:
        the Dataset object itself.
      • withAnnotations

        public DelimitedTextDataset withAnnotations​(List<Object> annotations)
        Set the annotations property: List of tags that can be used for describing the Dataset.
        Overrides:
        withAnnotations in class Dataset
        Parameters:
        annotations - the annotations value to set.
        Returns:
        the Dataset 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:
        withFolder in class Dataset
        Parameters:
        folder - the folder value to set.
        Returns:
        the Dataset object itself.
      • location

        public DatasetLocation location()
        Get the location property: The location of the delimited text storage.
        Returns:
        the location value.
      • 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.
      • columnDelimiter

        public Object columnDelimiter()
        Get the columnDelimiter property: The column delimiter. Type: string (or Expression with resultType string).
        Returns:
        the columnDelimiter value.
      • 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.
      • rowDelimiter

        public Object rowDelimiter()
        Get the rowDelimiter property: The row delimiter. Type: string (or Expression with resultType string).
        Returns:
        the rowDelimiter value.
      • 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.
      • 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.
      • 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.
      • compressionCodec

        public Object compressionCodec()
        Get the compressionCodec property: The data compressionCodec. Type: string (or Expression with resultType string).
        Returns:
        the compressionCodec value.
      • 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.
      • compressionLevel

        public Object compressionLevel()
        Get the compressionLevel property: The data compression method used for DelimitedText.
        Returns:
        the compressionLevel value.
      • 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.
      • quoteChar

        public Object quoteChar()
        Get the quoteChar property: The quote character. Type: string (or Expression with resultType string).
        Returns:
        the quoteChar value.
      • 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.
      • escapeChar

        public Object escapeChar()
        Get the escapeChar property: The escape character. Type: string (or Expression with resultType string).
        Returns:
        the escapeChar value.
      • 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.
      • 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.
      • 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.
      • nullValue

        public Object nullValue()
        Get the nullValue property: The null value string. Type: string (or Expression with resultType string).
        Returns:
        the nullValue value.
      • 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.