Class TextFormat
java.lang.Object
com.azure.resourcemanager.datafactory.models.DatasetStorageFormat
com.azure.resourcemanager.datafactory.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.void
validate()
Validates the instance.withColumnDelimiter
(Object columnDelimiter) Set the columnDelimiter property: The column delimiter.withDeserializer
(Object deserializer) Set the deserializer property: Deserializer.withEncodingName
(Object encodingName) Set the encodingName property: The code page name of the preferred encoding.withEscapeChar
(Object escapeChar) Set the escapeChar property: The escape character.withFirstRowAsHeader
(Object firstRowAsHeader) Set the firstRowAsHeader property: When used as input, treat the first row of data as headers.withNullValue
(Object nullValue) Set the nullValue property: The null value string.withQuoteChar
(Object quoteChar) Set the quoteChar property: The quote character.withRowDelimiter
(Object rowDelimiter) Set the rowDelimiter property: The row delimiter.withSerializer
(Object serializer) Set the serializer property: Serializer.withSkipLineCount
(Object skipLineCount) Set the skipLineCount property: The number of lines/rows to be skipped when parsing text files.withTreatEmptyAsNull
(Object treatEmptyAsNull) Set the treatEmptyAsNull property: Treat empty column values in the text file as null.Methods inherited from class com.azure.resourcemanager.datafactory.models.DatasetStorageFormat
additionalProperties, deserializer, serializer, withAdditionalProperties
-
Constructor Details
-
TextFormat
public TextFormat()Creates an instance of TextFormat class.
-
-
Method Details
-
columnDelimiter
Get the columnDelimiter property: The column delimiter. Type: string (or Expression with resultType string).- Returns:
- the columnDelimiter value.
-
withColumnDelimiter
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.
-
rowDelimiter
Get the rowDelimiter property: The row delimiter. Type: string (or Expression with resultType string).- Returns:
- the rowDelimiter value.
-
withRowDelimiter
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.
-
escapeChar
Get the escapeChar property: The escape character. Type: string (or Expression with resultType string).- Returns:
- the escapeChar value.
-
withEscapeChar
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.
-
quoteChar
Get the quoteChar property: The quote character. Type: string (or Expression with resultType string).- Returns:
- the quoteChar value.
-
withQuoteChar
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.
-
nullValue
Get the nullValue property: The null value string. Type: string (or Expression with resultType string).- Returns:
- the nullValue value.
-
withNullValue
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.
-
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
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.
-
treatEmptyAsNull
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.
-
withTreatEmptyAsNull
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.
-
skipLineCount
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.
-
withSkipLineCount
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.
-
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
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.
-
withSerializer
Set the serializer property: Serializer. Type: string (or Expression with resultType string).- Overrides:
withSerializer
in classDatasetStorageFormat
- Parameters:
serializer
- the serializer value to set.- Returns:
- the DatasetStorageFormat object itself.
-
withDeserializer
Set the deserializer property: Deserializer. Type: string (or Expression with resultType string).- Overrides:
withDeserializer
in classDatasetStorageFormat
- Parameters:
deserializer
- the deserializer value to set.- Returns:
- the DatasetStorageFormat object itself.
-
validate
public void validate()Validates the instance.- Overrides:
validate
in classDatasetStorageFormat
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-