Class TextFormat
- java.lang.Object
-
- com.azure.resourcemanager.datafactory.models.DatasetStorageFormat
-
- com.azure.resourcemanager.datafactory.models.TextFormat
-
public final class TextFormat extends DatasetStorageFormat
The data stored in text format.
-
-
Constructor Summary
Constructors Constructor Description TextFormat()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
columnDelimiter()
Get the columnDelimiter property: The column delimiter.Object
encodingName()
Get the encodingName property: The code page name of the preferred encoding.Object
escapeChar()
Get the escapeChar property: The escape character.Object
firstRowAsHeader()
Get the firstRowAsHeader property: When used as input, treat the first row of data as headers.Object
nullValue()
Get the nullValue property: The null value string.Object
quoteChar()
Get the quoteChar property: The quote character.Object
rowDelimiter()
Get the rowDelimiter property: The row delimiter.Object
skipLineCount()
Get the skipLineCount property: The number of lines/rows to be skipped when parsing text files.Object
treatEmptyAsNull()
Get the treatEmptyAsNull property: Treat empty column values in the text file as null.void
validate()
Validates the instance.TextFormat
withColumnDelimiter(Object columnDelimiter)
Set the columnDelimiter property: The column delimiter.TextFormat
withDeserializer(Object deserializer)
Set the deserializer property: Deserializer.TextFormat
withEncodingName(Object encodingName)
Set the encodingName property: The code page name of the preferred encoding.TextFormat
withEscapeChar(Object escapeChar)
Set the escapeChar property: The escape character.TextFormat
withFirstRowAsHeader(Object firstRowAsHeader)
Set the firstRowAsHeader property: When used as input, treat the first row of data as headers.TextFormat
withNullValue(Object nullValue)
Set the nullValue property: The null value string.TextFormat
withQuoteChar(Object quoteChar)
Set the quoteChar property: The quote character.TextFormat
withRowDelimiter(Object rowDelimiter)
Set the rowDelimiter property: The row delimiter.TextFormat
withSerializer(Object serializer)
Set the serializer property: Serializer.TextFormat
withSkipLineCount(Object skipLineCount)
Set the skipLineCount property: The number of lines/rows to be skipped when parsing text files.TextFormat
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
-
-
-
-
Method Detail
-
columnDelimiter
public Object columnDelimiter()
Get the columnDelimiter property: The column delimiter. Type: string (or Expression with resultType string).- Returns:
- the columnDelimiter value.
-
withColumnDelimiter
public TextFormat 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 TextFormat 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 TextFormat 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 TextFormat 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 TextFormat 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 TextFormat 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 TextFormat 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 TextFormat 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 TextFormat 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 TextFormat 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 TextFormat 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 TextFormat object itself.
-
treatEmptyAsNull
public Object 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
public TextFormat withTreatEmptyAsNull(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.
-
skipLineCount
public Object 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
public TextFormat withSkipLineCount(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.
-
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 TextFormat 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 TextFormat object itself.
-
withSerializer
public TextFormat withSerializer(Object serializer)
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
public TextFormat withDeserializer(Object deserializer)
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.
-
-