Class: OCI::ResourceSearch::Models::FreeTextSearchDetails

Inherits:
SearchDetails
  • Object
show all
Defined in:
lib/oci/resource_search/models/free_text_search_details.rb

Overview

A request containing arbitrary text that must be present in the resource.

Constant Summary

Constants inherited from SearchDetails

SearchDetails::MATCHING_CONTEXT_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from SearchDetails

#matching_context_type, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from SearchDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ FreeTextSearchDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :matching_context_type (String) —

    The value to assign to the #matching_context_type proprety

  • :text (String) —

    The value to assign to the #text property



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/resource_search/models/free_text_search_details.rb', line 44

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['type'] = 'FreeText'

  super(attributes)

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

  self.text = attributes[:'text'] if attributes[:'text']
end

Instance Attribute Details

#text ⇒ String

[Required] The text to search for.

Returns:

  • (String) 


12
13
14
 
# File 'lib/oci/resource_search/models/free_text_search_details.rb', line 12

def text
  @text
end

Class Method Details

.attribute_map ⇒ Object

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



15
16
17
18
19
20
21
22
23
 
# File 'lib/oci/resource_search/models/free_text_search_details.rb', line 15

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'matching_context_type': :'matchingContextType',
    'text': :'text'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



26
27
28
29
30
31
32
33
34
 
# File 'lib/oci/resource_search/models/free_text_search_details.rb', line 26

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'matching_context_type': :'String',
    'text': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



64
65
66
67
68
69
70
71
 
# File 'lib/oci/resource_search/models/free_text_search_details.rb', line 64

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    type == other.type &&
    matching_context_type == other.matching_context_type &&
    text == other.text
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/resource_search/models/free_text_search_details.rb', line 96

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) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


76
77
78
 
# File 'lib/oci/resource_search/models/free_text_search_details.rb', line 76

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



85
86
87
 
# File 'lib/oci/resource_search/models/free_text_search_details.rb', line 85

def hash
  [type, matching_context_type, text].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/resource_search/models/free_text_search_details.rb', line 129

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



123
124
125
 
# File 'lib/oci/resource_search/models/free_text_search_details.rb', line 123

def to_s
  to_hash.to_s
end