class OCI::DataIntegration::Models::NameListRule

The name list rule which defines how fields are projected. For example, this may be all fields begining with STR.

Constants

MATCHING_STRATEGY_ENUM
RULE_TYPE_ENUM

Attributes

is_cascade[RW]

Specifies whether to cascade or not. @return [BOOLEAN]

is_case_sensitive[RW]

Specifies if the rule is case sensitive. @return [BOOLEAN]

is_skip_remaining_rules_on_match[RW]

Specifies whether to skip remaining rules when a match is found. @return [BOOLEAN]

matching_strategy[R]

The pattern matching strategy. @return [String]

names[RW]

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

rule_type[R]

The rule type. @return [String]

scope[RW]

Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a `TypedObject`, or a full `TypedObject` definition. @return [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/name_list_rule.rb, line 54
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'key': :'key',
    'model_version': :'modelVersion',
    'parent_ref': :'parentRef',
    'is_java_regex_syntax': :'isJavaRegexSyntax',
    'config_values': :'configValues',
    'object_status': :'objectStatus',
    'description': :'description',
    'is_skip_remaining_rules_on_match': :'isSkipRemainingRulesOnMatch',
    'scope': :'scope',
    'is_cascade': :'isCascade',
    'matching_strategy': :'matchingStrategy',
    'is_case_sensitive': :'isCaseSensitive',
    'rule_type': :'ruleType',
    'names': :'names'
    # 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::ProjectionRule#key key} proprety @option attributes [String] :model_version The value to assign to the {OCI::DataIntegration::Models::ProjectionRule#model_version model_version} proprety @option attributes [OCI::DataIntegration::Models::ParentReference] :parent_ref The value to assign to the {OCI::DataIntegration::Models::ProjectionRule#parent_ref parent_ref} proprety @option attributes [BOOLEAN] :is_java_regex_syntax The value to assign to the {OCI::DataIntegration::Models::ProjectionRule#is_java_regex_syntax is_java_regex_syntax} proprety @option attributes [OCI::DataIntegration::Models::ConfigValues] :config_values The value to assign to the {OCI::DataIntegration::Models::ProjectionRule#config_values config_values} proprety @option attributes [Integer] :object_status The value to assign to the {OCI::DataIntegration::Models::ProjectionRule#object_status object_status} proprety @option attributes [String] :description The value to assign to the {OCI::DataIntegration::Models::ProjectionRule#description description} proprety @option attributes [BOOLEAN] :is_skip_remaining_rules_on_match The value to assign to the {#is_skip_remaining_rules_on_match} property @option attributes [Object] :scope The value to assign to the {#scope} property @option attributes [BOOLEAN] :is_cascade The value to assign to the {#is_cascade} property @option attributes [String] :matching_strategy The value to assign to the {#matching_strategy} property @option attributes [BOOLEAN] :is_case_sensitive The value to assign to the {#is_case_sensitive} property @option attributes [String] :rule_type The value to assign to the {#rule_type} property @option attributes [Array<String>] :names The value to assign to the {#names} property

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

  attributes['modelType'] = 'NAME_LIST_RULE'

  super(attributes)

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

  self.is_skip_remaining_rules_on_match = attributes[:'isSkipRemainingRulesOnMatch'] unless attributes[:'isSkipRemainingRulesOnMatch'].nil?

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

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

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

  self.is_cascade = attributes[:'isCascade'] unless attributes[:'isCascade'].nil?

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

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

  self.matching_strategy = attributes[:'matchingStrategy'] if attributes[:'matchingStrategy']

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

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

  self.is_case_sensitive = attributes[:'isCaseSensitive'] unless attributes[:'isCaseSensitive'].nil?

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

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

  self.rule_type = attributes[:'ruleType'] if attributes[:'ruleType']

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

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

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

Attribute type mapping.

# File lib/oci/data_integration/models/name_list_rule.rb, line 77
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'String',
    'key': :'String',
    'model_version': :'String',
    'parent_ref': :'OCI::DataIntegration::Models::ParentReference',
    'is_java_regex_syntax': :'BOOLEAN',
    'config_values': :'OCI::DataIntegration::Models::ConfigValues',
    'object_status': :'Integer',
    'description': :'String',
    'is_skip_remaining_rules_on_match': :'BOOLEAN',
    'scope': :'Object',
    'is_cascade': :'BOOLEAN',
    'matching_strategy': :'String',
    'is_case_sensitive': :'BOOLEAN',
    'rule_type': :'String',
    'names': :'Array<String>'
    # 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/name_list_rule.rb, line 197
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 &&
    is_java_regex_syntax == other.is_java_regex_syntax &&
    config_values == other.config_values &&
    object_status == other.object_status &&
    description == other.description &&
    is_skip_remaining_rules_on_match == other.is_skip_remaining_rules_on_match &&
    scope == other.scope &&
    is_cascade == other.is_cascade &&
    matching_strategy == other.matching_strategy &&
    is_case_sensitive == other.is_case_sensitive &&
    rule_type == other.rule_type &&
    names == other.names
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/name_list_rule.rb, line 241
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/name_list_rule.rb, line 221
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/name_list_rule.rb, line 230
def hash
  [model_type, key, model_version, parent_ref, is_java_regex_syntax, config_values, object_status, description, is_skip_remaining_rules_on_match, scope, is_cascade, matching_strategy, is_case_sensitive, rule_type, names].hash
end
matching_strategy=(matching_strategy) click to toggle source

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

# File lib/oci/data_integration/models/name_list_rule.rb, line 168
def matching_strategy=(matching_strategy)
  # rubocop:disable Style/ConditionalAssignment
  if matching_strategy && !MATCHING_STRATEGY_ENUM.include?(matching_strategy)
    OCI.logger.debug("Unknown value for 'matching_strategy' [" + matching_strategy + "]. Mapping to 'MATCHING_STRATEGY_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @matching_strategy = MATCHING_STRATEGY_UNKNOWN_ENUM_VALUE
  else
    @matching_strategy = matching_strategy
  end
  # rubocop:enable Style/ConditionalAssignment
end
rule_type=(rule_type) click to toggle source

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

# File lib/oci/data_integration/models/name_list_rule.rb, line 181
def rule_type=(rule_type)
  # rubocop:disable Style/ConditionalAssignment
  if rule_type && !RULE_TYPE_ENUM.include?(rule_type)
    OCI.logger.debug("Unknown value for 'rule_type' [" + rule_type + "]. Mapping to 'RULE_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @rule_type = RULE_TYPE_UNKNOWN_ENUM_VALUE
  else
    @rule_type = rule_type
  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/name_list_rule.rb, line 274
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/name_list_rule.rb, line 268
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/name_list_rule.rb, line 291
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