Lookup

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

Bases: Operator

The information about the lookup operator. The lookup operator has two input links, a primary input, and a lookup source input. It has an output link, fields of the lookup input are appended to the primary input and projected as the output fields.

Attributes:

MODEL_TYPE_AGGREGATOR_OPERATOR

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

MODEL_TYPE_DECISION_OPERATOR

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

MODEL_TYPE_DISTINCT_OPERATOR

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

MODEL_TYPE_END_OPERATOR

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

MODEL_TYPE_EXPRESSION_OPERATOR

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

MODEL_TYPE_FILTER_OPERATOR

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

MODEL_TYPE_FLATTEN_OPERATOR

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

MODEL_TYPE_FUNCTION_OPERATOR

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

MODEL_TYPE_INTERSECT_OPERATOR

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

MODEL_TYPE_JOINER_OPERATOR

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

MODEL_TYPE_LOOKUP_OPERATOR

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

MODEL_TYPE_MERGE_OPERATOR

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

MODEL_TYPE_MINUS_OPERATOR

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

MODEL_TYPE_PIPELINE_OPERATOR

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

MODEL_TYPE_PIVOT_OPERATOR

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

MODEL_TYPE_PROJECTION_OPERATOR

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

MODEL_TYPE_SORT_OPERATOR

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

MODEL_TYPE_SOURCE_OPERATOR

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

MODEL_TYPE_SPLIT_OPERATOR

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

MODEL_TYPE_START_OPERATOR

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

MODEL_TYPE_TARGET_OPERATOR

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

MODEL_TYPE_TASK_OPERATOR

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

MODEL_TYPE_UNION_OPERATOR

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

MULTI_MATCH_STRATEGY_RETURN_ALL

A constant which can be used with the multi_match_strategy property of a Lookup.

MULTI_MATCH_STRATEGY_RETURN_ANY

A constant which can be used with the multi_match_strategy property of a Lookup.

MULTI_MATCH_STRATEGY_RETURN_ERROR

A constant which can be used with the multi_match_strategy property of a Lookup.

MULTI_MATCH_STRATEGY_RETURN_FIRST

A constant which can be used with the multi_match_strategy property of a Lookup.

MULTI_MATCH_STRATEGY_RETURN_LAST

A constant which can be used with the multi_match_strategy property of a Lookup.

description

Gets the description of this Operator.

identifier

Gets the identifier of this Operator.

input_ports

Gets the input_ports of this Operator.

is_skip_no_match

Gets the is_skip_no_match of this Lookup.

key

Gets the key of this Operator.

lookup_condition

Gets the lookup_condition of this Lookup.

model_type

[Required] Gets the model_type of this Operator.

model_version

Gets the model_version of this Operator.

multi_match_strategy

Gets the multi_match_strategy of this Lookup.

name

Gets the name of this Operator.

null_fill_values

Gets the null_fill_values of this Lookup.

object_status

Gets the object_status of this Operator.

object_version

Gets the object_version of this Operator.

op_config_values

Gets the op_config_values of this Operator.

output_ports

Gets the output_ports of this Operator.

parameters

Gets the parameters of this Operator.

parent_ref

Gets the parent_ref of this Operator.

Methods:

__init__(**kwargs)

Initializes a new Lookup 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_AGGREGATOR_OPERATOR = 'AGGREGATOR_OPERATOR'

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

MODEL_TYPE_DECISION_OPERATOR = 'DECISION_OPERATOR'

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

MODEL_TYPE_DISTINCT_OPERATOR = 'DISTINCT_OPERATOR'

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

MODEL_TYPE_END_OPERATOR = 'END_OPERATOR'

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

MODEL_TYPE_EXPRESSION_OPERATOR = 'EXPRESSION_OPERATOR'

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

MODEL_TYPE_FILTER_OPERATOR = 'FILTER_OPERATOR'

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

MODEL_TYPE_FLATTEN_OPERATOR = 'FLATTEN_OPERATOR'

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

MODEL_TYPE_FUNCTION_OPERATOR = 'FUNCTION_OPERATOR'

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

MODEL_TYPE_INTERSECT_OPERATOR = 'INTERSECT_OPERATOR'

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

MODEL_TYPE_JOINER_OPERATOR = 'JOINER_OPERATOR'

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

MODEL_TYPE_LOOKUP_OPERATOR = 'LOOKUP_OPERATOR'

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

MODEL_TYPE_MERGE_OPERATOR = 'MERGE_OPERATOR'

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

MODEL_TYPE_MINUS_OPERATOR = 'MINUS_OPERATOR'

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

MODEL_TYPE_PIPELINE_OPERATOR = 'PIPELINE_OPERATOR'

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

MODEL_TYPE_PIVOT_OPERATOR = 'PIVOT_OPERATOR'

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

MODEL_TYPE_PROJECTION_OPERATOR = 'PROJECTION_OPERATOR'

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

MODEL_TYPE_SORT_OPERATOR = 'SORT_OPERATOR'

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

MODEL_TYPE_SOURCE_OPERATOR = 'SOURCE_OPERATOR'

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

MODEL_TYPE_SPLIT_OPERATOR = 'SPLIT_OPERATOR'

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

MODEL_TYPE_START_OPERATOR = 'START_OPERATOR'

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

MODEL_TYPE_TARGET_OPERATOR = 'TARGET_OPERATOR'

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

MODEL_TYPE_TASK_OPERATOR = 'TASK_OPERATOR'

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

MODEL_TYPE_UNION_OPERATOR = 'UNION_OPERATOR'

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

MULTI_MATCH_STRATEGY_RETURN_ALL = 'RETURN_ALL'

A constant which can be used with the multi_match_strategy property of a Lookup. This constant has a value of “RETURN_ALL”

MULTI_MATCH_STRATEGY_RETURN_ANY = 'RETURN_ANY'

A constant which can be used with the multi_match_strategy property of a Lookup. This constant has a value of “RETURN_ANY”

MULTI_MATCH_STRATEGY_RETURN_ERROR = 'RETURN_ERROR'

A constant which can be used with the multi_match_strategy property of a Lookup. This constant has a value of “RETURN_ERROR”

MULTI_MATCH_STRATEGY_RETURN_FIRST = 'RETURN_FIRST'

A constant which can be used with the multi_match_strategy property of a Lookup. This constant has a value of “RETURN_FIRST”

MULTI_MATCH_STRATEGY_RETURN_LAST = 'RETURN_LAST'

A constant which can be used with the multi_match_strategy property of a Lookup. This constant has a value of “RETURN_LAST”

__init__(**kwargs)

Initializes a new Lookup object with values from keyword arguments. The default value of the model_type attribute of this class is LOOKUP_OPERATOR 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 Lookup. Allowed values for this property are: “SOURCE_OPERATOR”, “FILTER_OPERATOR”, “JOINER_OPERATOR”, “AGGREGATOR_OPERATOR”, “PROJECTION_OPERATOR”, “TARGET_OPERATOR”, “FLATTEN_OPERATOR”, “DISTINCT_OPERATOR”, “SORT_OPERATOR”, “UNION_OPERATOR”, “INTERSECT_OPERATOR”, “MINUS_OPERATOR”, “MERGE_OPERATOR”, “FUNCTION_OPERATOR”, “SPLIT_OPERATOR”, “START_OPERATOR”, “END_OPERATOR”, “PIPELINE_OPERATOR”, “DECISION_OPERATOR”, “TASK_OPERATOR”, “EXPRESSION_OPERATOR”, “LOOKUP_OPERATOR”, “PIVOT_OPERATOR”, ‘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 Lookup.

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

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

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

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

  • object_version (int) – The value to assign to the object_version property of this Lookup.

  • input_ports (list[oci.data_integration.models.InputPort]) – The value to assign to the input_ports property of this Lookup.

  • output_ports (list[oci.data_integration.models.TypedObject]) – The value to assign to the output_ports property of this Lookup.

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

  • identifier (str) – The value to assign to the identifier property of this Lookup.

  • parameters (list[oci.data_integration.models.Parameter]) – The value to assign to the parameters property of this Lookup.

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

  • lookup_condition (oci.data_integration.models.Expression) – The value to assign to the lookup_condition property of this Lookup.

  • is_skip_no_match (bool) – The value to assign to the is_skip_no_match property of this Lookup.

  • multi_match_strategy (str) – The value to assign to the multi_match_strategy property of this Lookup. Allowed values for this property are: “RETURN_ANY”, “RETURN_FIRST”, “RETURN_LAST”, “RETURN_ALL”, “RETURN_ERROR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • null_fill_values (dict(str, object)) – The value to assign to the null_fill_values property of this Lookup.

property description

Gets the description of this Operator. Details about the operator.

Returns

The description of this Operator.

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 identifier

Gets the identifier of this Operator. Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Returns

The identifier of this Operator.

Return type

str

property input_ports

Gets the input_ports of this Operator. An array of input ports.

Returns

The input_ports of this Operator.

Return type

list[oci.data_integration.models.InputPort]

property is_skip_no_match

Gets the is_skip_no_match of this Lookup. For the rows for which lookup condition does not satisfy, if set to true - do not return those rows of primary Input source and if set to false - create a row with primary input fields values and lookup field values as NULL.

Returns

The is_skip_no_match of this Lookup.

Return type

bool

property key

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

Returns

The key of this Operator.

Return type

str

property lookup_condition

Gets the lookup_condition of this Lookup.

Returns

The lookup_condition of this Lookup.

Return type

oci.data_integration.models.Expression

property model_type

[Required] Gets the model_type of this Operator. The model type of the operator.

Allowed values for this property are: “SOURCE_OPERATOR”, “FILTER_OPERATOR”, “JOINER_OPERATOR”, “AGGREGATOR_OPERATOR”, “PROJECTION_OPERATOR”, “TARGET_OPERATOR”, “FLATTEN_OPERATOR”, “DISTINCT_OPERATOR”, “SORT_OPERATOR”, “UNION_OPERATOR”, “INTERSECT_OPERATOR”, “MINUS_OPERATOR”, “MERGE_OPERATOR”, “FUNCTION_OPERATOR”, “SPLIT_OPERATOR”, “START_OPERATOR”, “END_OPERATOR”, “PIPELINE_OPERATOR”, “DECISION_OPERATOR”, “TASK_OPERATOR”, “EXPRESSION_OPERATOR”, “LOOKUP_OPERATOR”, “PIVOT_OPERATOR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The model_type of this Operator.

Return type

str

property model_version

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

Returns

The model_version of this Operator.

Return type

str

property multi_match_strategy

Gets the multi_match_strategy of this Lookup. if there are multiple records found in the lookup input what action should be performed. The default value for this field is RETURN_ANY.

Allowed values for this property are: “RETURN_ANY”, “RETURN_FIRST”, “RETURN_LAST”, “RETURN_ALL”, “RETURN_ERROR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The multi_match_strategy of this Lookup.

Return type

str

property name

Gets the name of this Operator. 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 Operator.

Return type

str

property null_fill_values

Gets the null_fill_values of this Lookup. this map is used for replacing NULL values in the record. Key is the column name and value is the NULL replacement.

Returns

The null_fill_values of this Lookup.

Return type

dict(str, object)

property object_status

Gets the object_status of this Operator. 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 Operator.

Return type

int

property object_version

Gets the object_version of this Operator. The version of the object that is used to track changes in the object instance.

Returns

The object_version of this Operator.

Return type

int

property op_config_values

Gets the op_config_values of this Operator.

Returns

The op_config_values of this Operator.

Return type

oci.data_integration.models.ConfigValues

property output_ports

Gets the output_ports of this Operator. An array of output ports.

Returns

The output_ports of this Operator.

Return type

list[oci.data_integration.models.TypedObject]

property parameters

Gets the parameters of this Operator. An array of parameters used in the data flow.

Returns

The parameters of this Operator.

Return type

list[oci.data_integration.models.Parameter]

property parent_ref

Gets the parent_ref of this Operator.

Returns

The parent_ref of this Operator.

Return type

oci.data_integration.models.ParentReference