BaseType

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

Bases: object

Base type for the type system.

Attributes

MODEL_TYPE_ARRAY_TYPE A constant which can be used with the model_type property of a BaseType.
MODEL_TYPE_COMPOSITE_TYPE A constant which can be used with the model_type property of a BaseType.
MODEL_TYPE_CONFIGURED_TYPE A constant which can be used with the model_type property of a BaseType.
MODEL_TYPE_DATA_TYPE A constant which can be used with the model_type property of a BaseType.
MODEL_TYPE_DERIVED_TYPE A constant which can be used with the model_type property of a BaseType.
MODEL_TYPE_DYNAMIC_TYPE A constant which can be used with the model_type property of a BaseType.
MODEL_TYPE_JAVA_TYPE A constant which can be used with the model_type property of a BaseType.
MODEL_TYPE_MAP_TYPE A constant which can be used with the model_type property of a BaseType.
MODEL_TYPE_MATERIALIZED_COMPOSITE_TYPE A constant which can be used with the model_type property of a BaseType.
MODEL_TYPE_STRUCTURED_TYPE A constant which can be used with the model_type property of a BaseType.
description Gets the description of this BaseType.
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.

Methods

__init__(**kwargs) Initializes a new BaseType 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_ARRAY_TYPE = 'ARRAY_TYPE'

A constant which can be used with the model_type property of a BaseType. This constant has a value of “ARRAY_TYPE”

MODEL_TYPE_COMPOSITE_TYPE = 'COMPOSITE_TYPE'

A constant which can be used with the model_type property of a BaseType. This constant has a value of “COMPOSITE_TYPE”

MODEL_TYPE_CONFIGURED_TYPE = 'CONFIGURED_TYPE'

A constant which can be used with the model_type property of a BaseType. This constant has a value of “CONFIGURED_TYPE”

MODEL_TYPE_DATA_TYPE = 'DATA_TYPE'

A constant which can be used with the model_type property of a BaseType. This constant has a value of “DATA_TYPE”

MODEL_TYPE_DERIVED_TYPE = 'DERIVED_TYPE'

A constant which can be used with the model_type property of a BaseType. This constant has a value of “DERIVED_TYPE”

MODEL_TYPE_DYNAMIC_TYPE = 'DYNAMIC_TYPE'

A constant which can be used with the model_type property of a BaseType. This constant has a value of “DYNAMIC_TYPE”

MODEL_TYPE_JAVA_TYPE = 'JAVA_TYPE'

A constant which can be used with the model_type property of a BaseType. This constant has a value of “JAVA_TYPE”

MODEL_TYPE_MAP_TYPE = 'MAP_TYPE'

A constant which can be used with the model_type property of a BaseType. This constant has a value of “MAP_TYPE”

MODEL_TYPE_MATERIALIZED_COMPOSITE_TYPE = 'MATERIALIZED_COMPOSITE_TYPE'

A constant which can be used with the model_type property of a BaseType. This constant has a value of “MATERIALIZED_COMPOSITE_TYPE”

MODEL_TYPE_STRUCTURED_TYPE = 'STRUCTURED_TYPE'

A constant which can be used with the model_type property of a BaseType. This constant has a value of “STRUCTURED_TYPE”

__init__(**kwargs)

Initializes a new BaseType object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

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 BaseType. Allowed values for this property are: “DYNAMIC_TYPE”, “STRUCTURED_TYPE”, “DATA_TYPE”, “JAVA_TYPE”, “CONFIGURED_TYPE”, “COMPOSITE_TYPE”, “DERIVED_TYPE”, “ARRAY_TYPE”, “MAP_TYPE”, “MATERIALIZED_COMPOSITE_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 BaseType.
  • model_version (str) – The value to assign to the model_version property of this BaseType.
  • parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this BaseType.
  • name (str) – The value to assign to the name property of this BaseType.
  • object_status (int) – The value to assign to the object_status property of this BaseType.
  • description (str) – The value to assign to the description property of this BaseType.
description

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

Returns:The description of this BaseType.
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”, “ARRAY_TYPE”, “MAP_TYPE”, “MATERIALIZED_COMPOSITE_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