Class: OCI::ResourceSearch::Models::QueryableFieldDescription

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

Overview

An individual field that can be used as part of a query filter.

Constant Summary collapse

FIELD_TYPE_ENUM =

rubocop:disable Metrics/LineLength

[
  FIELD_TYPE_IDENTIFIER = 'IDENTIFIER'.freeze,
  FIELD_TYPE_STRING = 'STRING'.freeze,
  FIELD_TYPE_INTEGER = 'INTEGER'.freeze,
  FIELD_TYPE_RATIONAL = 'RATIONAL'.freeze,
  FIELD_TYPE_BOOLEAN = 'BOOLEAN'.freeze,
  FIELD_TYPE_DATETIME = 'DATETIME'.freeze,
  FIELD_TYPE_IP = 'IP'.freeze,
  FIELD_TYPE_OBJECT = 'OBJECT'.freeze,
  FIELD_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ QueryableFieldDescription

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/resource_search/models/queryable_field_description.rb', line 77

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

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

  self.field_type = attributes[:'fieldType'] if attributes[:'fieldType']

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

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

  self.field_name = attributes[:'fieldName'] if attributes[:'fieldName']

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

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

  self.is_array = attributes[:'isArray'] unless attributes[:'isArray'].nil?

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

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

  self.object_properties = attributes[:'objectProperties'] if attributes[:'objectProperties']

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

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

Instance Attribute Details

#field_name ⇒ String

[Required] The name of the field to use when constructing the query. Field names are present for all types except ‘OBJECT`.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/resource_search/models/queryable_field_description.rb', line 30

def field_name
  @field_name
end

#field_type ⇒ String

[Required] The type of the field, which dictates what semantics and query constraints you can use when searching or querying.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/resource_search/models/queryable_field_description.rb', line 25

def field_type
  @field_type
end

#is_array ⇒ BOOLEAN

Indicates this field is actually an array of the specified field type.

Returns:

  • (BOOLEAN) 


35
36
37
 
# File 'lib/oci/resource_search/models/queryable_field_description.rb', line 35

def is_array
  @is_array
end

#object_properties ⇒ Array<OCI::ResourceSearch::Models::QueryableFieldDescription>

If the field type is ‘OBJECT`, then this property will provide all the individual properties on the object that can be queried.

Returns:



41
42
43
 
# File 'lib/oci/resource_search/models/queryable_field_description.rb', line 41

def object_properties
  @object_properties
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'field_type': :'fieldType',
    'field_name': :'fieldName',
    'is_array': :'isArray',
    'object_properties': :'objectProperties'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/resource_search/models/queryable_field_description.rb', line 56

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'field_type': :'String',
    'field_name': :'String',
    'is_array': :'BOOLEAN',
    'object_properties': :'Array<OCI::ResourceSearch::Models::QueryableFieldDescription>'
    # 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



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

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

  self.class == other.class &&
    field_type == other.field_type &&
    field_name == other.field_name &&
    is_array == other.is_array &&
    object_properties == other.object_properties
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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/resource_search/models/queryable_field_description.rb', line 163

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


143
144
145
 
# File 'lib/oci/resource_search/models/queryable_field_description.rb', line 143

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



152
153
154
 
# File 'lib/oci/resource_search/models/queryable_field_description.rb', line 152

def hash
  [field_type, field_name, is_array, object_properties].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/resource_search/models/queryable_field_description.rb', line 196

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



190
191
192
 
# File 'lib/oci/resource_search/models/queryable_field_description.rb', line 190

def to_s
  to_hash.to_s
end