Class: OCI::LogAnalytics::Models::SortField

Inherits:
AbstractField show all
Defined in:
lib/oci/log_analytics/models/sort_field.rb

Overview

Field outlining queryString sort command fields and their corresponding sort order.

Constant Summary collapse

DIRECTION_ENUM = 
[
  DIRECTION_ASCENDING = 'ASCENDING'.freeze,
  DIRECTION_DESCENDING = 'DESCENDING'.freeze,
  DIRECTION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from AbstractField

AbstractField::NAME_ENUM, AbstractField::VALUE_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from AbstractField

#_alias, #display_name, #filter_query_string, #internal_name, #is_declared, #is_duration, #is_groupable, #name, #original_display_names, #unit_type, #value_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AbstractField

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ SortField

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name proprety

  • :is_declared (BOOLEAN) —

    The value to assign to the #is_declared proprety

  • :original_display_names (Array<String>) —

    The value to assign to the #original_display_names proprety

  • :internal_name (String) —

    The value to assign to the #internal_name proprety

  • :value_type (String) —

    The value to assign to the #value_type proprety

  • :is_groupable (BOOLEAN) —

    The value to assign to the #is_groupable proprety

  • :is_duration (BOOLEAN) —

    The value to assign to the #is_duration proprety

  • :_alias (String) —

    The value to assign to the #alias proprety

  • :filter_query_string (String) —

    The value to assign to the #filter_query_string proprety

  • :unit_type (String) —

    The value to assign to the #unit_type proprety

  • :direction (String) —

    The value to assign to the #direction property



82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/log_analytics/models/sort_field.rb', line 82

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

  attributes['name'] = 'SORT'

  super(attributes)

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

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

Instance Attribute Details

#direction ⇒ String

Sort order for the field specified in the queryString.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/log_analytics/models/sort_field.rb', line 23

def direction
  @direction
end

Class Method Details

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/oci/log_analytics/models/sort_field.rb', line 26

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'display_name': :'displayName',
    'is_declared': :'isDeclared',
    'original_display_names': :'originalDisplayNames',
    'internal_name': :'internalName',
    'value_type': :'valueType',
    'is_groupable': :'isGroupable',
    'is_duration': :'isDuration',
    '_alias': :'alias',
    'filter_query_string': :'filterQueryString',
    'unit_type': :'unitType',
    'direction': :'direction'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/log_analytics/models/sort_field.rb', line 46

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'display_name': :'String',
    'is_declared': :'BOOLEAN',
    'original_display_names': :'Array<String>',
    'internal_name': :'String',
    'value_type': :'String',
    'is_groupable': :'BOOLEAN',
    'is_duration': :'BOOLEAN',
    '_alias': :'String',
    'filter_query_string': :'String',
    'unit_type': :'String',
    'direction': :'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



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/log_analytics/models/sort_field.rb', line 115

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

  self.class == other.class &&
    name == other.name &&
    display_name == other.display_name &&
    is_declared == other.is_declared &&
    original_display_names == other.original_display_names &&
    internal_name == other.internal_name &&
    value_type == other.value_type &&
    is_groupable == other.is_groupable &&
    is_duration == other.is_duration &&
    _alias == other._alias &&
    filter_query_string == other.filter_query_string &&
    unit_type == other.unit_type &&
    direction == other.direction
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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/log_analytics/models/sort_field.rb', line 156

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


136
137
138
 
# File 'lib/oci/log_analytics/models/sort_field.rb', line 136

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



145
146
147
 
# File 'lib/oci/log_analytics/models/sort_field.rb', line 145

def hash
  [name, display_name, is_declared, original_display_names, internal_name, value_type, is_groupable, is_duration, _alias, filter_query_string, unit_type, direction].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/log_analytics/models/sort_field.rb', line 189

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



183
184
185
 
# File 'lib/oci/log_analytics/models/sort_field.rb', line 183

def to_s
  to_hash.to_s
end