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

Class TextFormat

java.lang.Object
com.azure.analytics.synapse.artifacts.models.DatasetStorageFormat
com.azure.analytics.synapse.artifacts.models.TextFormat
public final class TextFormat extends DatasetStorageFormat
The data stored in text format.

  • Constructor Details

    • TextFormat

      public TextFormat()

  • Method Details

    • getColumnDelimiter

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

    • setColumnDelimiter

      public TextFormat 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 TextFormat 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 TextFormat 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 TextFormat 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 TextFormat 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 TextFormat 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 TextFormat 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 TextFormat 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 TextFormat 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 TextFormat 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 TextFormat 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 TextFormat object itself.

    • getTreatEmptyAsNull

      public Object getTreatEmptyAsNull()
      Get the treatEmptyAsNull property: Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean).
      Returns:
      the treatEmptyAsNull value.

    • setTreatEmptyAsNull

      public TextFormat setTreatEmptyAsNull(Object treatEmptyAsNull)
      Set the treatEmptyAsNull property: Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean).
      Parameters:
      treatEmptyAsNull - the treatEmptyAsNull value to set.
      Returns:
      the TextFormat object itself.

    • getSkipLineCount

      public Object getSkipLineCount()
      Get the skipLineCount property: The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer).
      Returns:
      the skipLineCount value.

    • setSkipLineCount

      public TextFormat setSkipLineCount(Object skipLineCount)
      Set the skipLineCount property: The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer).
      Parameters:
      skipLineCount - the skipLineCount value to set.
      Returns:
      the TextFormat 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 TextFormat 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 TextFormat object itself.

    • setSerializer

      public TextFormat setSerializer(Object serializer)
      Set the serializer property: Serializer. Type: string (or Expression with resultType string).
      Overrides:
      setSerializer in class DatasetStorageFormat
      Parameters:
      serializer - the serializer value to set.
      Returns:
      the DatasetStorageFormat object itself.

    • setDeserializer

      public TextFormat setDeserializer(Object deserializer)
      Set the deserializer property: Deserializer. Type: string (or Expression with resultType string).
      Overrides:
      setDeserializer in class DatasetStorageFormat
      Parameters:
      deserializer - the deserializer value to set.
      Returns:
      the DatasetStorageFormat object itself.