TypedObject

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

Bases: object

The TypedObject class is a base class for any model object that has a type.

Attributes

MODEL_TYPE_DERIVED_FIELD A constant which can be used with the model_type property of a TypedObject.
MODEL_TYPE_DYNAMIC_INPUT_FIELD A constant which can be used with the model_type property of a TypedObject.
MODEL_TYPE_DYNAMIC_PROXY_FIELD A constant which can be used with the model_type property of a TypedObject.
MODEL_TYPE_INPUT_FIELD A constant which can be used with the model_type property of a TypedObject.
MODEL_TYPE_INPUT_PORT A constant which can be used with the model_type property of a TypedObject.
MODEL_TYPE_MACRO_FIELD A constant which can be used with the model_type property of a TypedObject.
MODEL_TYPE_OUTPUT_FIELD A constant which can be used with the model_type property of a TypedObject.
MODEL_TYPE_OUTPUT_PORT A constant which can be used with the model_type property of a TypedObject.
MODEL_TYPE_PARAMETER A constant which can be used with the model_type property of a TypedObject.
MODEL_TYPE_PROXY_FIELD A constant which can be used with the model_type property of a TypedObject.
MODEL_TYPE_SHAPE A constant which can be used with the model_type property of a TypedObject.
MODEL_TYPE_SHAPE_FIELD A constant which can be used with the model_type property of a TypedObject.
config_values Gets the config_values of this TypedObject.
description Gets the description of this TypedObject.
key Gets the key of this TypedObject.
model_type [Required] Gets the model_type of this TypedObject.
model_version Gets the model_version of this TypedObject.
name Gets the name of this TypedObject.
object_status Gets the object_status of this TypedObject.
parent_ref Gets the parent_ref of this TypedObject.

Methods

__init__(**kwargs) Initializes a new TypedObject 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_DERIVED_FIELD = 'DERIVED_FIELD'

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

MODEL_TYPE_DYNAMIC_INPUT_FIELD = 'DYNAMIC_INPUT_FIELD'

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

MODEL_TYPE_DYNAMIC_PROXY_FIELD = 'DYNAMIC_PROXY_FIELD'

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

MODEL_TYPE_INPUT_FIELD = 'INPUT_FIELD'

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

MODEL_TYPE_INPUT_PORT = 'INPUT_PORT'

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

MODEL_TYPE_MACRO_FIELD = 'MACRO_FIELD'

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

MODEL_TYPE_OUTPUT_FIELD = 'OUTPUT_FIELD'

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

MODEL_TYPE_OUTPUT_PORT = 'OUTPUT_PORT'

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

MODEL_TYPE_PARAMETER = 'PARAMETER'

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

MODEL_TYPE_PROXY_FIELD = 'PROXY_FIELD'

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

MODEL_TYPE_SHAPE = 'SHAPE'

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

MODEL_TYPE_SHAPE_FIELD = 'SHAPE_FIELD'

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

__init__(**kwargs)

Initializes a new TypedObject 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 TypedObject. Allowed values for this property are: “SHAPE”, “INPUT_PORT”, “SHAPE_FIELD”, “INPUT_FIELD”, “DERIVED_FIELD”, “MACRO_FIELD”, “OUTPUT_FIELD”, “DYNAMIC_PROXY_FIELD”, “OUTPUT_PORT”, “DYNAMIC_INPUT_FIELD”, “PROXY_FIELD”, “PARAMETER”
  • key (str) – The value to assign to the key property of this TypedObject.
  • model_version (str) – The value to assign to the model_version property of this TypedObject.
  • parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this TypedObject.
  • config_values (oci.data_integration.models.ConfigValues) – The value to assign to the config_values property of this TypedObject.
  • object_status (int) – The value to assign to the object_status property of this TypedObject.
  • name (str) – The value to assign to the name property of this TypedObject.
  • description (str) – The value to assign to the description property of this TypedObject.
config_values

Gets the config_values of this TypedObject.

Returns:The config_values of this TypedObject.
Return type:oci.data_integration.models.ConfigValues
description

Gets the description of this TypedObject. Detailed description for the object.

Returns:The description of this TypedObject.
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 TypedObject. The key of the object.

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

[Required] Gets the model_type of this TypedObject. The type of the types object.

Allowed values for this property are: “SHAPE”, “INPUT_PORT”, “SHAPE_FIELD”, “INPUT_FIELD”, “DERIVED_FIELD”, “MACRO_FIELD”, “OUTPUT_FIELD”, “DYNAMIC_PROXY_FIELD”, “OUTPUT_PORT”, “DYNAMIC_INPUT_FIELD”, “PROXY_FIELD”, “PARAMETER”

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

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

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

Gets the name of this TypedObject. 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 TypedObject.
Return type:str
object_status

Gets the object_status of this TypedObject. 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 TypedObject.
Return type:int
parent_ref

Gets the parent_ref of this TypedObject.

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