Class: OCI::Monitoring::Models::Datapoint

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/monitoring/models/datapoint.rb

Overview

Metric value for a specific timestamp.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Datapoint

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :timestamp (DateTime) —

    The value to assign to the #timestamp property

  • :value (Float) —

    The value to assign to the #value property

  • :count (Integer) —

    The value to assign to the #count property



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/monitoring/models/datapoint.rb', line 65

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.timestamp = attributes[:'timestamp'] if attributes[:'timestamp']

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

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

Instance Attribute Details

#count ⇒ Integer

The number of occurrences of the associated value in the set of data.

Default is 1. Value must be greater than zero.

Returns:

  • (Integer) 


32
33
34
 
# File 'lib/oci/monitoring/models/datapoint.rb', line 32

def count
  @count
end

#timestamp ⇒ DateTime

[Required] Timestamp for this metric value. Format defined by RFC3339. For a data point to be posted, its timestamp must be near current time (less than two hours in the past and less than 10 minutes in the future).

Example: 2023-02-01T01:02:29.600Z

Returns:

  • (DateTime) 


18
19
20
 
# File 'lib/oci/monitoring/models/datapoint.rb', line 18

def timestamp
  @timestamp
end

#value ⇒ Float

[Required] Numeric value of the metric.

Example: 10.23

Returns:

  • (Float) 


25
26
27
 
# File 'lib/oci/monitoring/models/datapoint.rb', line 25

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
 
# File 'lib/oci/monitoring/models/datapoint.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'timestamp': :'timestamp',
    'value': :'value',
    'count': :'count'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
 
# File 'lib/oci/monitoring/models/datapoint.rb', line 46

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'timestamp': :'DateTime',
    'value': :'Float',
    'count': :'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



85
86
87
88
89
90
91
92
 
# File 'lib/oci/monitoring/models/datapoint.rb', line 85

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

  self.class == other.class &&
    timestamp == other.timestamp &&
    value == other.value &&
    count == other.count
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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/oci/monitoring/models/datapoint.rb', line 117

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


97
98
99
 
# File 'lib/oci/monitoring/models/datapoint.rb', line 97

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



106
107
108
 
# File 'lib/oci/monitoring/models/datapoint.rb', line 106

def hash
  [timestamp, value, count].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/monitoring/models/datapoint.rb', line 150

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



144
145
146
 
# File 'lib/oci/monitoring/models/datapoint.rb', line 144

def to_s
  to_hash.to_s
end