JsonFormatAttribute¶

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

Bases: oci.data_integration.models.abstract_format_attribute.AbstractFormatAttribute

The JSON file format attribute.

Attributes

`MODEL_TYPE_AVRO_FORMAT`	str(object=’’) -> str
`MODEL_TYPE_CSV_FORMAT`	str(object=’’) -> str
`MODEL_TYPE_JSON_FORMAT`	str(object=’’) -> str
`encoding`	Gets the encoding of this JsonFormatAttribute.
`is_file_pattern`	Gets the is_file_pattern of this AbstractFormatAttribute.
`model_type`	[Required] Gets the model_type of this AbstractFormatAttribute.
`sample_entity_data`	Gets the sample_entity_data of this JsonFormatAttribute.

Methods

`__init__`(**kwargs)	Initializes a new JsonFormatAttribute 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 JsonFormatAttribute object with values from keyword arguments. The default value of the model_type attribute of this class is JSON_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 JsonFormatAttribute. 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 JsonFormatAttribute.
encoding (str) – The value to assign to the encoding property of this JsonFormatAttribute.
sample_entity_data (str) – The value to assign to the sample_entity_data property of this JsonFormatAttribute.

encoding¶

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

Returns:	The encoding of this JsonFormatAttribute.
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.

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

sample_entity_data¶

Gets the sample_entity_data of this JsonFormatAttribute. Sample JSON with all fields of JSON schema specified in it for the JSON data files used in Data Flow, Data Loader or Data Preview and should be specified in Base64 encoded format. Maximum size is 2 MB.

Returns:	The sample_entity_data of this JsonFormatAttribute.
Return type:	str