Class: OCI::Monitoring::Models::MetricData

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

Overview

The set of aggregated data returned for a metric. For information about metrics, see [Metrics Overview](docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#MetricsOverview).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MetricData

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 106

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

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

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

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

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

  self.aggregated_datapoints = attributes[:'aggregatedDatapoints'] if attributes[:'aggregatedDatapoints']

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

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

Instance Attribute Details

#aggregated_datapoints ⇒ Array<OCI::Monitoring::Models::AggregatedDatapoint>

[Required] The list of timestamp-value pairs returned for the specified request. Metric values are rolled up to the start time specified in the request.

Returns:



61
62
63
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 61

def aggregated_datapoints
  @aggregated_datapoints
end

#compartment_id ⇒ String

[Required] The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources from which the aggregated data was returned.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 23

def compartment_id
  @compartment_id
end

#dimensions ⇒ Hash<String, String>

[Required] Qualifiers provided in the definition of the returned metric. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair.

Example: ‘"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"`

Returns:

  • (Hash<String, String>) 


38
39
40
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 38

def dimensions
  @dimensions
end

#metadata ⇒ Hash<String, String>

The references provided in a metric definition to indicate extra information about the metric.

Example: ‘"unit": "bytes"`

Returns:

  • (Hash<String, String>) 


45
46
47
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 45

def metadata
  @metadata
end

#name ⇒ String

[Required] The name of the metric.

Example: ‘CpuUtilization`

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 30

def name
  @name
end

#namespace ⇒ String

[Required] The reference provided in a metric definition to indicate the source service or application that emitted the metric.

Example: ‘oci_computeagent`

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 17

def namespace
  @namespace
end

#resolution ⇒ String

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. For example, use a query interval of 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute frequency. The resolution must be equal or less than the interval in the query. The default resolution is 1m (one minute). Supported values: ‘1m`-`60m` (also `1h`).

Example: ‘5m`

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 56

def resolution
  @resolution
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'namespace': :'namespace',
    'compartment_id': :'compartmentId',
    'name': :'name',
    'dimensions': :'dimensions',
    'metadata': :'metadata',
    'resolution': :'resolution',
    'aggregated_datapoints': :'aggregatedDatapoints'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 79

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'namespace': :'String',
    'compartment_id': :'String',
    'name': :'String',
    'dimensions': :'Hash<String, String>',
    'metadata': :'Hash<String, String>',
    'resolution': :'String',
    'aggregated_datapoints': :'Array<OCI::Monitoring::Models::AggregatedDatapoint>'
    # 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



142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 142

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

  self.class == other.class &&
    namespace == other.namespace &&
    compartment_id == other.compartment_id &&
    name == other.name &&
    dimensions == other.dimensions &&
    metadata == other.metadata &&
    resolution == other.resolution &&
    aggregated_datapoints == other.aggregated_datapoints
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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 178

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


158
159
160
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 158

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



167
168
169
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 167

def hash
  [namespace, compartment_id, name, dimensions, metadata, resolution, aggregated_datapoints].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 211

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



205
206
207
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 205

def to_s
  to_hash.to_s
end