Class: OCI::LogAnalytics::Models::TimeColumn

Inherits:
AbstractColumn show all
Defined in:
lib/oci/log_analytics/models/time_column.rb

Overview

Time column returned when the shape of a queries results contsin a time series.

Constant Summary

Constants inherited from AbstractColumn

AbstractColumn::SUB_SYSTEM_ENUM, AbstractColumn::TYPE_ENUM, AbstractColumn::VALUE_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from AbstractColumn

#display_name, #internal_name, #is_case_sensitive, #is_evaluable, #is_groupable, #is_hidden, #is_list_of_values, #is_multi_valued, #original_display_name, #sub_system, #type, #value_type, #values

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AbstractColumn

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ TimeColumn

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

  • :sub_system (String)

    The value to assign to the #sub_system proprety

  • :values (Array<OCI::LogAnalytics::Models::FieldValue>)

    The value to assign to the #values proprety

  • :is_list_of_values (BOOLEAN)

    The value to assign to the #is_list_of_values proprety

  • :is_multi_valued (BOOLEAN)

    The value to assign to the #is_multi_valued proprety

  • :is_case_sensitive (BOOLEAN)

    The value to assign to the #is_case_sensitive proprety

  • :is_groupable (BOOLEAN)

    The value to assign to the #is_groupable proprety

  • :is_evaluable (BOOLEAN)

    The value to assign to the #is_evaluable proprety

  • :is_hidden (BOOLEAN)

    The value to assign to the #is_hidden proprety

  • :value_type (String)

    The value to assign to the #value_type proprety

  • :original_display_name (String)

    The value to assign to the #original_display_name proprety

  • :internal_name (String)

    The value to assign to the #internal_name proprety

  • :span (String)

    The value to assign to the #span property

  • :times (Array<Integer>)

    The value to assign to the #times property



89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/oci/log_analytics/models/time_column.rb', line 89

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

  attributes['type'] = 'TIME_COLUMN'

  super(attributes)

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

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

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

Instance Attribute Details

#spanString

Time span between each series data point.

Returns:

  • (String)


16
17
18
# File 'lib/oci/log_analytics/models/time_column.rb', line 16

def span
  @span
end

#timesArray<Integer>

List of timestamps that represent each time stamp in the entire time series even if certain intervals are filtered out of query results.

Returns:

  • (Array<Integer>)


21
22
23
# File 'lib/oci/log_analytics/models/time_column.rb', line 21

def times
  @times
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'display_name': :'displayName',
    'sub_system': :'subSystem',
    'values': :'values',
    'is_list_of_values': :'isListOfValues',
    'is_multi_valued': :'isMultiValued',
    'is_case_sensitive': :'isCaseSensitive',
    'is_groupable': :'isGroupable',
    'is_evaluable': :'isEvaluable',
    'is_hidden': :'isHidden',
    'value_type': :'valueType',
    'original_display_name': :'originalDisplayName',
    'internal_name': :'internalName',
    'span': :'span',
    'times': :'times'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'display_name': :'String',
    'sub_system': :'String',
    'values': :'Array<OCI::LogAnalytics::Models::FieldValue>',
    'is_list_of_values': :'BOOLEAN',
    'is_multi_valued': :'BOOLEAN',
    'is_case_sensitive': :'BOOLEAN',
    'is_groupable': :'BOOLEAN',
    'is_evaluable': :'BOOLEAN',
    'is_hidden': :'BOOLEAN',
    'value_type': :'String',
    'original_display_name': :'String',
    'internal_name': :'String',
    'span': :'String',
    'times': :'Array<Integer>'
    # 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



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

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

  self.class == other.class &&
    type == other.type &&
    display_name == other.display_name &&
    sub_system == other.sub_system &&
    values == other.values &&
    is_list_of_values == other.is_list_of_values &&
    is_multi_valued == other.is_multi_valued &&
    is_case_sensitive == other.is_case_sensitive &&
    is_groupable == other.is_groupable &&
    is_evaluable == other.is_evaluable &&
    is_hidden == other.is_hidden &&
    value_type == other.value_type &&
    original_display_name == other.original_display_name &&
    internal_name == other.internal_name &&
    span == other.span &&
    times == other.times
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



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

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


135
136
137
# File 'lib/oci/log_analytics/models/time_column.rb', line 135

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



144
145
146
# File 'lib/oci/log_analytics/models/time_column.rb', line 144

def hash
  [type, display_name, sub_system, values, is_list_of_values, is_multi_valued, is_case_sensitive, is_groupable, is_evaluable, is_hidden, value_type, original_display_name, internal_name, span, times].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



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

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



182
183
184
# File 'lib/oci/log_analytics/models/time_column.rb', line 182

def to_s
  to_hash.to_s
end