CsvFormatAttribute¶

class oci.data_integration.models.CsvFormatAttribute(**kwargs)¶

Bases: oci.data_integration.models.abstract_format_attribute.AbstractFormatAttribute

The CSV format attribute.

Attributes

`MODEL_TYPE_AVRO_FORMAT`	str(object=’’) -> str
`MODEL_TYPE_CSV_FORMAT`	str(object=’’) -> str
`MODEL_TYPE_JSON_FORMAT`	str(object=’’) -> str
`delimiter`	Gets the delimiter of this CsvFormatAttribute.
`encoding`	Gets the encoding of this CsvFormatAttribute.
`escape_character`	Gets the escape_character of this CsvFormatAttribute.
`has_header`	Gets the has_header of this CsvFormatAttribute.
`is_file_pattern`	Gets the is_file_pattern of this AbstractFormatAttribute.
`model_type`	[Required] Gets the model_type of this AbstractFormatAttribute.
`quote_character`	Gets the quote_character of this CsvFormatAttribute.
`timestamp_format`	Gets the timestamp_format of this CsvFormatAttribute.

Methods

`__init__`(**kwargs)	Initializes a new CsvFormatAttribute object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

MODEL_TYPE_AVRO_FORMAT = 'AVRO_FORMAT'¶

MODEL_TYPE_CSV_FORMAT = 'CSV_FORMAT'¶

MODEL_TYPE_JSON_FORMAT = 'JSON_FORMAT'¶

__init__(**kwargs)¶

Initializes a new CsvFormatAttribute object with values from keyword arguments. The default value of the model_type attribute of this class is CSV_FORMAT and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

model_type (str) – The value to assign to the model_type property of this CsvFormatAttribute. Allowed values for this property are: “JSON_FORMAT”, “CSV_FORMAT”, “AVRO_FORMAT”
is_file_pattern (bool) – The value to assign to the is_file_pattern property of this CsvFormatAttribute.
encoding (str) – The value to assign to the encoding property of this CsvFormatAttribute.
escape_character (str) – The value to assign to the escape_character property of this CsvFormatAttribute.
delimiter (str) – The value to assign to the delimiter property of this CsvFormatAttribute.
quote_character (str) – The value to assign to the quote_character property of this CsvFormatAttribute.
has_header (bool) – The value to assign to the has_header property of this CsvFormatAttribute.
timestamp_format (str) – The value to assign to the timestamp_format property of this CsvFormatAttribute.

delimiter¶

Gets the delimiter of this CsvFormatAttribute. The delimiter for the CSV format.

Returns:	The delimiter of this CsvFormatAttribute.
Return type:	str

encoding¶

Gets the encoding of this CsvFormatAttribute. The encoding for the file.

Returns:	The encoding of this CsvFormatAttribute.
Return type:	str

escape_character¶

Gets the escape_character of this CsvFormatAttribute. The escape character for the CSV format.

Returns:	The escape_character of this CsvFormatAttribute.
Return type:	str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

has_header¶

Gets the has_header of this CsvFormatAttribute. Defines whether the file has a header row.

Returns:	The has_header of this CsvFormatAttribute.
Return type:	bool

is_file_pattern¶

Gets the is_file_pattern of this AbstractFormatAttribute. Defines whether a file pattern is supported.

Returns:	The is_file_pattern of this AbstractFormatAttribute.
Return type:	bool

model_type¶

[Required] Gets the model_type of this AbstractFormatAttribute. The type of the format attribute.

Allowed values for this property are: “JSON_FORMAT”, “CSV_FORMAT”, “AVRO_FORMAT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The model_type of this AbstractFormatAttribute.
Return type:	str

quote_character¶

Gets the quote_character of this CsvFormatAttribute. The quote character for the CSV format.

Returns:	The quote_character of this CsvFormatAttribute.
Return type:	str

timestamp_format¶

Gets the timestamp_format of this CsvFormatAttribute. Format for timestamp information.

Returns:	The timestamp_format of this CsvFormatAttribute.
Return type:	str