Class: OCI::Loggingsearch::Models::FieldInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/loggingsearch/models/field_info.rb

Overview

Contains field schema information.

Constant Summary collapse

FIELD_TYPE_ENUM = 
[
  FIELD_TYPE_STRING = 'STRING'.freeze,
  FIELD_TYPE_NUMBER = 'NUMBER'.freeze,
  FIELD_TYPE_BOOLEAN = 'BOOLEAN'.freeze,
  FIELD_TYPE_ARRAY = 'ARRAY'.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 = {}) ⇒ FieldInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :field_name (String) —

    The value to assign to the #field_name property

  • :field_type (String) —

    The value to assign to the #field_type property



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/loggingsearch/models/field_info.rb', line 61

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_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.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']
end

Instance Attribute Details

#field_name ⇒ String

[Required] Field name

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/loggingsearch/models/field_info.rb', line 22

def field_name
  @field_name
end

#field_type ⇒ String

[Required] Field type - * STRING: A sequence of characters. * NUMBER: Numeric type which can be an integer or floating point. * BOOLEAN: Either true or false. * ARRAY: An ordered collection of values.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/loggingsearch/models/field_info.rb', line 31

def field_type
  @field_type
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
 
# File 'lib/oci/loggingsearch/models/field_info.rb', line 34

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

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
 
# File 'lib/oci/loggingsearch/models/field_info.rb', line 44

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



100
101
102
103
104
105
106
 
# File 'lib/oci/loggingsearch/models/field_info.rb', line 100

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

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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/loggingsearch/models/field_info.rb', line 131

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


111
112
113
 
# File 'lib/oci/loggingsearch/models/field_info.rb', line 111

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



120
121
122
 
# File 'lib/oci/loggingsearch/models/field_info.rb', line 120

def hash
  [field_name, field_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/loggingsearch/models/field_info.rb', line 164

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



158
159
160
 
# File 'lib/oci/loggingsearch/models/field_info.rb', line 158

def to_s
  to_hash.to_s
end