Class: OCI::ResourceSearch::Models::StructuredSearchDetails

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

Overview

A request that uses Search's structured query language to specify filter conditions to apply to search results. For more information about writing queries, see Search Language Syntax.

Constant Summary

Constants inherited from SearchDetails

OCI::ResourceSearch::Models::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 = {}) ⇒ StructuredSearchDetails

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

  • :query (String) —

    The value to assign to the #query property



48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/oci/resource_search/models/structured_search_details.rb', line 48

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

  attributes['type'] = 'Structured'

  super(attributes)

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

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

Instance Attribute Details

#query ⇒ String

[Required] The structured query describing which resources to search for.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/resource_search/models/structured_search_details.rb', line 16

def query
  @query
end

Class Method Details

.attribute_map ⇒ Object

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



19
20
21
22
23
24
25
26
27
 
# File 'lib/oci/resource_search/models/structured_search_details.rb', line 19

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

.swagger_types ⇒ Object

Attribute type mapping.



30
31
32
33
34
35
36
37
38
 
# File 'lib/oci/resource_search/models/structured_search_details.rb', line 30

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'matching_context_type': :'String',
    'query': :'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



68
69
70
71
72
73
74
75
 
# File 'lib/oci/resource_search/models/structured_search_details.rb', line 68

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

  self.class == other.class &&
    type == other.type &&
    matching_context_type == other.matching_context_type &&
    query == other.query
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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/resource_search/models/structured_search_details.rb', line 100

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


80
81
82
 
# File 'lib/oci/resource_search/models/structured_search_details.rb', line 80

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



89
90
91
 
# File 'lib/oci/resource_search/models/structured_search_details.rb', line 89

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



133
134
135
136
137
138
139
140
141
142
 
# File 'lib/oci/resource_search/models/structured_search_details.rb', line 133

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



127
128
129
 
# File 'lib/oci/resource_search/models/structured_search_details.rb', line 127

def to_s
  to_hash.to_s
end