class OCI::DataIntegration::Models::Lookup

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.

Constants

MULTI_MATCH_STRATEGY_ENUM

Attributes

is_skip_no_match[RW]

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. @return [BOOLEAN]

lookup_condition[RW]

@return [OCI::DataIntegration::Models::Expression]

multi_match_strategy[R]

if there are multiple records found in the lookup input what action should be performed. The default value for this field is RETURN_ANY. @return [String]

null_fill_values[RW]

this map is used for replacing NULL values in the record. Key is the column name and value is the NULL replacement. @return [Hash<String, Object>]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/oci/data_integration/models/lookup.rb, line 37
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'key': :'key',
    'model_version': :'modelVersion',
    'parent_ref': :'parentRef',
    'name': :'name',
    'description': :'description',
    'object_version': :'objectVersion',
    'input_ports': :'inputPorts',
    'output_ports': :'outputPorts',
    'object_status': :'objectStatus',
    'identifier': :'identifier',
    'parameters': :'parameters',
    'op_config_values': :'opConfigValues',
    'lookup_condition': :'lookupCondition',
    'is_skip_no_match': :'isSkipNoMatch',
    'multi_match_strategy': :'multiMatchStrategy',
    'null_fill_values': :'nullFillValues'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :key The value to assign to the {OCI::DataIntegration::Models::Operator#key key} proprety @option attributes [String] :model_version The value to assign to the {OCI::DataIntegration::Models::Operator#model_version model_version} proprety @option attributes [OCI::DataIntegration::Models::ParentReference] :parent_ref The value to assign to the {OCI::DataIntegration::Models::Operator#parent_ref parent_ref} proprety @option attributes [String] :name The value to assign to the {OCI::DataIntegration::Models::Operator#name name} proprety @option attributes [String] :description The value to assign to the {OCI::DataIntegration::Models::Operator#description description} proprety @option attributes [Integer] :object_version The value to assign to the {OCI::DataIntegration::Models::Operator#object_version object_version} proprety @option attributes [Array<OCI::DataIntegration::Models::InputPort>] :input_ports The value to assign to the {OCI::DataIntegration::Models::Operator#input_ports input_ports} proprety @option attributes [Array<OCI::DataIntegration::Models::OutputPort>] :output_ports The value to assign to the {OCI::DataIntegration::Models::Operator#output_ports output_ports} proprety @option attributes [Integer] :object_status The value to assign to the {OCI::DataIntegration::Models::Operator#object_status object_status} proprety @option attributes [String] :identifier The value to assign to the {OCI::DataIntegration::Models::Operator#identifier identifier} proprety @option attributes [Array<OCI::DataIntegration::Models::Parameter>] :parameters The value to assign to the {OCI::DataIntegration::Models::Operator#parameters parameters} proprety @option attributes [OCI::DataIntegration::Models::ConfigValues] :op_config_values The value to assign to the {OCI::DataIntegration::Models::Operator#op_config_values op_config_values} proprety @option attributes [OCI::DataIntegration::Models::Expression] :lookup_condition The value to assign to the {#lookup_condition} property @option attributes [BOOLEAN] :is_skip_no_match The value to assign to the {#is_skip_no_match} property @option attributes [String] :multi_match_strategy The value to assign to the {#multi_match_strategy} property @option attributes [Hash<String, Object>] :null_fill_values The value to assign to the {#null_fill_values} property

# File lib/oci/data_integration/models/lookup.rb, line 108
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['modelType'] = 'LOOKUP_OPERATOR'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.lookup_condition = attributes[:'lookupCondition'] if attributes[:'lookupCondition']

  raise 'You cannot provide both :lookupCondition and :lookup_condition' if attributes.key?(:'lookupCondition') && attributes.key?(:'lookup_condition')

  self.lookup_condition = attributes[:'lookup_condition'] if attributes[:'lookup_condition']

  self.is_skip_no_match = attributes[:'isSkipNoMatch'] unless attributes[:'isSkipNoMatch'].nil?

  raise 'You cannot provide both :isSkipNoMatch and :is_skip_no_match' if attributes.key?(:'isSkipNoMatch') && attributes.key?(:'is_skip_no_match')

  self.is_skip_no_match = attributes[:'is_skip_no_match'] unless attributes[:'is_skip_no_match'].nil?

  self.multi_match_strategy = attributes[:'multiMatchStrategy'] if attributes[:'multiMatchStrategy']

  raise 'You cannot provide both :multiMatchStrategy and :multi_match_strategy' if attributes.key?(:'multiMatchStrategy') && attributes.key?(:'multi_match_strategy')

  self.multi_match_strategy = attributes[:'multi_match_strategy'] if attributes[:'multi_match_strategy']

  self.null_fill_values = attributes[:'nullFillValues'] if attributes[:'nullFillValues']

  raise 'You cannot provide both :nullFillValues and :null_fill_values' if attributes.key?(:'nullFillValues') && attributes.key?(:'null_fill_values')

  self.null_fill_values = attributes[:'null_fill_values'] if attributes[:'null_fill_values']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/data_integration/models/lookup.rb, line 62
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'String',
    'key': :'String',
    'model_version': :'String',
    'parent_ref': :'OCI::DataIntegration::Models::ParentReference',
    'name': :'String',
    'description': :'String',
    'object_version': :'Integer',
    'input_ports': :'Array<OCI::DataIntegration::Models::InputPort>',
    'output_ports': :'Array<OCI::DataIntegration::Models::OutputPort>',
    'object_status': :'Integer',
    'identifier': :'String',
    'parameters': :'Array<OCI::DataIntegration::Models::Parameter>',
    'op_config_values': :'OCI::DataIntegration::Models::ConfigValues',
    'lookup_condition': :'OCI::DataIntegration::Models::Expression',
    'is_skip_no_match': :'BOOLEAN',
    'multi_match_strategy': :'String',
    'null_fill_values': :'Hash<String, Object>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/data_integration/models/lookup.rb, line 163
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    model_type == other.model_type &&
    key == other.key &&
    model_version == other.model_version &&
    parent_ref == other.parent_ref &&
    name == other.name &&
    description == other.description &&
    object_version == other.object_version &&
    input_ports == other.input_ports &&
    output_ports == other.output_ports &&
    object_status == other.object_status &&
    identifier == other.identifier &&
    parameters == other.parameters &&
    op_config_values == other.op_config_values &&
    lookup_condition == other.lookup_condition &&
    is_skip_no_match == other.is_skip_no_match &&
    multi_match_strategy == other.multi_match_strategy &&
    null_fill_values == other.null_fill_values
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/data_integration/models/lookup.rb, line 209
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(other) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/data_integration/models/lookup.rb, line 189
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/data_integration/models/lookup.rb, line 198
def hash
  [model_type, key, model_version, parent_ref, name, description, object_version, input_ports, output_ports, object_status, identifier, parameters, op_config_values, lookup_condition, is_skip_no_match, multi_match_strategy, null_fill_values].hash
end
multi_match_strategy=(multi_match_strategy) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] multi_match_strategy Object to be assigned

# File lib/oci/data_integration/models/lookup.rb, line 147
def multi_match_strategy=(multi_match_strategy)
  # rubocop:disable Style/ConditionalAssignment
  if multi_match_strategy && !MULTI_MATCH_STRATEGY_ENUM.include?(multi_match_strategy)
    OCI.logger.debug("Unknown value for 'multi_match_strategy' [" + multi_match_strategy + "]. Mapping to 'MULTI_MATCH_STRATEGY_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @multi_match_strategy = MULTI_MATCH_STRATEGY_UNKNOWN_ENUM_VALUE
  else
    @multi_match_strategy = multi_match_strategy
  end
  # rubocop:enable Style/ConditionalAssignment
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/data_integration/models/lookup.rb, line 242
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/data_integration/models/lookup.rb, line 236
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/data_integration/models/lookup.rb, line 259
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end