Parameter

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

Bases: TypedObject

Parameters are created and assigned values that can be configured for each integration task.

Attributes:

MODEL_TYPE_CONDITIONAL_OUTPUT_PORT

A constant which can be used with the model_type property of a TypedObject.

MODEL_TYPE_DECISION_OUTPUT_PORT

A constant which can be used with the model_type property of a TypedObject.

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_INPUT_PROXY_FIELD

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_MACRO_PIVOT_FIELD

A constant which can be used with the model_type property of a TypedObject.

MODEL_TYPE_MATERIALIZED_DYNAMIC_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_PIVOT_FIELD

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.

OUTPUT_AGGREGATION_TYPE_COUNT

A constant which can be used with the output_aggregation_type property of a Parameter.

OUTPUT_AGGREGATION_TYPE_MAX

A constant which can be used with the output_aggregation_type property of a Parameter.

OUTPUT_AGGREGATION_TYPE_MIN

A constant which can be used with the output_aggregation_type property of a Parameter.

OUTPUT_AGGREGATION_TYPE_SUM

A constant which can be used with the output_aggregation_type property of a Parameter.

config_values

Gets the config_values of this TypedObject.

default_value

Gets the default_value of this Parameter.

description

Gets the description of this TypedObject.

is_input

Gets the is_input of this Parameter.

is_output

Gets the is_output of this Parameter.

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.

output_aggregation_type

Gets the output_aggregation_type of this Parameter.

parent_ref

Gets the parent_ref of this TypedObject.

root_object_default_value

Gets the root_object_default_value of this Parameter.

type

Gets the type of this Parameter.

type_name

Gets the type_name of this Parameter.

used_for

Gets the used_for of this Parameter.

Methods:

__init__(**kwargs)

Initializes a new Parameter 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_CONDITIONAL_OUTPUT_PORT = 'CONDITIONAL_OUTPUT_PORT'

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

MODEL_TYPE_DECISION_OUTPUT_PORT = 'DECISION_OUTPUT_PORT'

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

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_INPUT_PROXY_FIELD = 'INPUT_PROXY_FIELD'

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

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_MACRO_PIVOT_FIELD = 'MACRO_PIVOT_FIELD'

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

MODEL_TYPE_MATERIALIZED_DYNAMIC_FIELD = 'MATERIALIZED_DYNAMIC_FIELD'

A constant which can be used with the model_type property of a TypedObject. This constant has a value of “MATERIALIZED_DYNAMIC_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_PIVOT_FIELD = 'PIVOT_FIELD'

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

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”

OUTPUT_AGGREGATION_TYPE_COUNT = 'COUNT'

A constant which can be used with the output_aggregation_type property of a Parameter. This constant has a value of “COUNT”

OUTPUT_AGGREGATION_TYPE_MAX = 'MAX'

A constant which can be used with the output_aggregation_type property of a Parameter. This constant has a value of “MAX”

OUTPUT_AGGREGATION_TYPE_MIN = 'MIN'

A constant which can be used with the output_aggregation_type property of a Parameter. This constant has a value of “MIN”

OUTPUT_AGGREGATION_TYPE_SUM = 'SUM'

A constant which can be used with the output_aggregation_type property of a Parameter. This constant has a value of “SUM”

__init__(**kwargs)

Initializes a new Parameter object with values from keyword arguments. The default value of the model_type attribute of this class is PARAMETER 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 Parameter. 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”, “PIVOT_FIELD”, “MACRO_PIVOT_FIELD”, “CONDITIONAL_OUTPUT_PORT”, “INPUT_PROXY_FIELD”, “MATERIALIZED_DYNAMIC_FIELD”, “DECISION_OUTPUT_PORT”, ‘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 Parameter.

  • model_version (str) – The value to assign to the model_version property of this Parameter.

  • parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this Parameter.

  • config_values (oci.data_integration.models.ConfigValues) – The value to assign to the config_values property of this Parameter.

  • object_status (int) – The value to assign to the object_status property of this Parameter.

  • name (str) – The value to assign to the name property of this Parameter.

  • description (str) – The value to assign to the description property of this Parameter.

  • type (object) – The value to assign to the type property of this Parameter.

  • default_value (object) – The value to assign to the default_value property of this Parameter.

  • root_object_default_value (object) – The value to assign to the root_object_default_value property of this Parameter.

  • is_input (bool) – The value to assign to the is_input property of this Parameter.

  • is_output (bool) – The value to assign to the is_output property of this Parameter.

  • output_aggregation_type (str) – The value to assign to the output_aggregation_type property of this Parameter. Allowed values for this property are: “MIN”, “MAX”, “COUNT”, “SUM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • type_name (str) – The value to assign to the type_name property of this Parameter.

  • used_for (str) – The value to assign to the used_for property of this Parameter.

property config_values

Gets the config_values of this TypedObject.

Returns

The config_values of this TypedObject.

Return type

oci.data_integration.models.ConfigValues

property default_value

Gets the default_value of this Parameter. The default value of the parameter.

Returns

The default_value of this Parameter.

Return type

object

property 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.

property is_input

Gets the is_input of this Parameter. Specifies whether the parameter is input value.

Returns

The is_input of this Parameter.

Return type

bool

property is_output

Gets the is_output of this Parameter. Specifies whether the parameter is output value.

Returns

The is_output of this Parameter.

Return type

bool

property key

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

Returns

The key of this TypedObject.

Return type

str

property 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”, “PIVOT_FIELD”, “MACRO_PIVOT_FIELD”, “CONDITIONAL_OUTPUT_PORT”, “INPUT_PROXY_FIELD”, “MATERIALIZED_DYNAMIC_FIELD”, “DECISION_OUTPUT_PORT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The model_type of this TypedObject.

Return type

str

property 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

property 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

property 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

property output_aggregation_type

Gets the output_aggregation_type of this Parameter. The output aggregation type.

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

Returns

The output_aggregation_type of this Parameter.

Return type

str

property parent_ref

Gets the parent_ref of this TypedObject.

Returns

The parent_ref of this TypedObject.

Return type

oci.data_integration.models.ParentReference

property root_object_default_value

Gets the root_object_default_value of this Parameter. The default value of the parameter which can be an object in DIS, such as a data entity.

Returns

The root_object_default_value of this Parameter.

Return type

object

property type

Gets the type of this Parameter. This can either be a string value referencing the type or a BaseType object.

Returns

The type of this Parameter.

Return type

object

property type_name

Gets the type_name of this Parameter. The type of value the parameter was created for.

Returns

The type_name of this Parameter.

Return type

str

property used_for

Gets the used_for of this Parameter. The param name for which parameter is created for for eg. driver Shape, Operation etc.

Returns

The used_for of this Parameter.

Return type

str