Class TextFormat
java.lang.Object
com.azure.analytics.synapse.artifacts.models.DatasetStorageFormat
com.azure.analytics.synapse.artifacts.models.TextFormat
The data stored in text format.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the columnDelimiter property: The column delimiter.Get the encodingName property: The code page name of the preferred encoding.Get the escapeChar property: The escape character.Get the firstRowAsHeader property: When used as input, treat the first row of data as headers.Get the nullValue property: The null value string.Get the quoteChar property: The quote character.Get the rowDelimiter property: The row delimiter.Get the skipLineCount property: The number of lines/rows to be skipped when parsing text files.Get the treatEmptyAsNull property: Treat empty column values in the text file as null.setColumnDelimiter
(Object columnDelimiter) Set the columnDelimiter property: The column delimiter.setDeserializer
(Object deserializer) Set the deserializer property: Deserializer.setEncodingName
(Object encodingName) Set the encodingName property: The code page name of the preferred encoding.setEscapeChar
(Object escapeChar) Set the escapeChar property: The escape character.setFirstRowAsHeader
(Object firstRowAsHeader) Set the firstRowAsHeader property: When used as input, treat the first row of data as headers.setNullValue
(Object nullValue) Set the nullValue property: The null value string.setQuoteChar
(Object quoteChar) Set the quoteChar property: The quote character.setRowDelimiter
(Object rowDelimiter) Set the rowDelimiter property: The row delimiter.setSerializer
(Object serializer) Set the serializer property: Serializer.setSkipLineCount
(Object skipLineCount) Set the skipLineCount property: The number of lines/rows to be skipped when parsing text files.setTreatEmptyAsNull
(Object treatEmptyAsNull) Set the treatEmptyAsNull property: Treat empty column values in the text file as null.Methods inherited from class com.azure.analytics.synapse.artifacts.models.DatasetStorageFormat
getAdditionalProperties, getDeserializer, getSerializer, setAdditionalProperties
-
Constructor Details
-
TextFormat
public TextFormat()
-
-
Method Details
-
getColumnDelimiter
Get the columnDelimiter property: The column delimiter. Type: string (or Expression with resultType string).- Returns:
- the columnDelimiter value.
-
setColumnDelimiter
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
Get the rowDelimiter property: The row delimiter. Type: string (or Expression with resultType string).- Returns:
- the rowDelimiter value.
-
setRowDelimiter
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
Get the escapeChar property: The escape character. Type: string (or Expression with resultType string).- Returns:
- the escapeChar value.
-
setEscapeChar
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
Get the quoteChar property: The quote character. Type: string (or Expression with resultType string).- Returns:
- the quoteChar value.
-
setQuoteChar
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
Get the nullValue property: The null value string. Type: string (or Expression with resultType string).- Returns:
- the nullValue value.
-
setNullValue
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
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
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
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
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
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
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
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
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
Set the serializer property: Serializer. Type: string (or Expression with resultType string).- Overrides:
setSerializer
in classDatasetStorageFormat
- Parameters:
serializer
- the serializer value to set.- Returns:
- the DatasetStorageFormat object itself.
-
setDeserializer
Set the deserializer property: Deserializer. Type: string (or Expression with resultType string).- Overrides:
setDeserializer
in classDatasetStorageFormat
- Parameters:
deserializer
- the deserializer value to set.- Returns:
- the DatasetStorageFormat object itself.
-