DataType

class oci.data_integration.models.DataType(**kwargs)

Bases: oci.data_integration.models.base_type.BaseType

A DataType object is a simple primitive type that describes the type of a single atomic unit of data. For example, INT, VARCHAR, NUMBER, and so on.

Attributes

DT_TYPE_PRIMITIVE A constant which can be used with the dt_type property of a DataType.
DT_TYPE_STRUCTURED A constant which can be used with the dt_type property of a DataType.
MODEL_TYPE_COMPOSITE_TYPE str(object=’’) -> str
MODEL_TYPE_CONFIGURED_TYPE str(object=’’) -> str
MODEL_TYPE_DATA_TYPE str(object=’’) -> str
MODEL_TYPE_DERIVED_TYPE str(object=’’) -> str
MODEL_TYPE_DYNAMIC_TYPE str(object=’’) -> str
MODEL_TYPE_JAVA_TYPE str(object=’’) -> str
MODEL_TYPE_STRUCTURED_TYPE str(object=’’) -> str
config_definition Gets the config_definition of this DataType.
description Gets the description of this BaseType.
dt_type Gets the dt_type of this DataType.
key Gets the key of this BaseType.
model_type [Required] Gets the model_type of this BaseType.
model_version Gets the model_version of this BaseType.
name Gets the name of this BaseType.
object_status Gets the object_status of this BaseType.
parent_ref Gets the parent_ref of this BaseType.
type_system_name Gets the type_system_name of this DataType.

Methods

__init__(**kwargs) Initializes a new DataType 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.
DT_TYPE_PRIMITIVE = 'PRIMITIVE'

A constant which can be used with the dt_type property of a DataType. This constant has a value of “PRIMITIVE”

DT_TYPE_STRUCTURED = 'STRUCTURED'

A constant which can be used with the dt_type property of a DataType. This constant has a value of “STRUCTURED”

MODEL_TYPE_COMPOSITE_TYPE = 'COMPOSITE_TYPE'
MODEL_TYPE_CONFIGURED_TYPE = 'CONFIGURED_TYPE'
MODEL_TYPE_DATA_TYPE = 'DATA_TYPE'
MODEL_TYPE_DERIVED_TYPE = 'DERIVED_TYPE'
MODEL_TYPE_DYNAMIC_TYPE = 'DYNAMIC_TYPE'
MODEL_TYPE_JAVA_TYPE = 'JAVA_TYPE'
MODEL_TYPE_STRUCTURED_TYPE = 'STRUCTURED_TYPE'
__init__(**kwargs)

Initializes a new DataType object with values from keyword arguments. The default value of the model_type attribute of this class is DATA_TYPE 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 DataType. Allowed values for this property are: “DYNAMIC_TYPE”, “STRUCTURED_TYPE”, “DATA_TYPE”, “JAVA_TYPE”, “CONFIGURED_TYPE”, “COMPOSITE_TYPE”, “DERIVED_TYPE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • key (str) – The value to assign to the key property of this DataType.
  • model_version (str) – The value to assign to the model_version property of this DataType.
  • parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this DataType.
  • name (str) – The value to assign to the name property of this DataType.
  • object_status (int) – The value to assign to the object_status property of this DataType.
  • description (str) – The value to assign to the description property of this DataType.
  • dt_type (str) – The value to assign to the dt_type property of this DataType. Allowed values for this property are: “PRIMITIVE”, “STRUCTURED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • type_system_name (str) – The value to assign to the type_system_name property of this DataType.
  • config_definition (oci.data_integration.models.ConfigDefinition) – The value to assign to the config_definition property of this DataType.
config_definition

Gets the config_definition of this DataType.

Returns:The config_definition of this DataType.
Return type:oci.data_integration.models.ConfigDefinition
description

Gets the description of this BaseType. A user defined description for the object.

Returns:The description of this BaseType.
Return type:str
dt_type

Gets the dt_type of this DataType. The data type.

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

Returns:The dt_type of this DataType.
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.

key

Gets the key of this BaseType. The key of the object.

Returns:The key of this BaseType.
Return type:str
model_type

[Required] Gets the model_type of this BaseType. The property which disciminates the subtypes.

Allowed values for this property are: “DYNAMIC_TYPE”, “STRUCTURED_TYPE”, “DATA_TYPE”, “JAVA_TYPE”, “CONFIGURED_TYPE”, “COMPOSITE_TYPE”, “DERIVED_TYPE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The model_type of this BaseType.
Return type:str
model_version

Gets the model_version of this BaseType. The model version of an object.

Returns:The model_version of this BaseType.
Return type:str
name

Gets the name of this BaseType. Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Returns:The name of this BaseType.
Return type:str
object_status

Gets the object_status of this BaseType. The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

Returns:The object_status of this BaseType.
Return type:int
parent_ref

Gets the parent_ref of this BaseType.

Returns:The parent_ref of this BaseType.
Return type:oci.data_integration.models.ParentReference
type_system_name

Gets the type_system_name of this DataType. The data type system name.

Returns:The type_system_name of this DataType.
Return type:str