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.

Limits information for returned data follows.

  • Data points: 100,000.

  • Metric streams* within data points: 2,000.

  • Time range returned for 1-day resolution: 90 days.

  • Time range returned for 1-hour resolution: 90 days.

  • Time range returned for 5-minute resolution: 30 days.

  • Time range returned for 1-minute resolution: 7 days.

*A metric stream is an individual set of aggregated data for a metric with zero or more dimension values. Metric streams cannot be aggregated across metric groups. A metric group is the combination of a given metric, metric namespace, and tenancy for the purpose of determining limits. For more information about metric-related concepts, see Monitoring Concepts.

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):



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 136

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

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

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

  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. For important limits information related to data points, see MetricData Reference at the top of this page.

Returns:



88
89
90
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 88

def aggregated_datapoints
  @aggregated_datapoints
end

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the resources that the aggregated data was returned from.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 49

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>) 


64
65
66
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 64

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>) 


71
72
73
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 71

def metadata
  @metadata
end

#name ⇒ String

[Required] The name of the metric.

Example: CpuUtilization

Returns:

  • (String) 


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

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) 


35
36
37
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 35

def namespace
  @namespace
end

#resolution ⇒ String

The time between calculated aggregation windows. Use with the query interval to vary the frequency for returning aggregated data points. 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, 1h-24h, 1d.

Example: 5m

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 82

def resolution
  @resolution
end

#resource_group ⇒ String

Resource group provided with the posted metric. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).

Example: frontend-fleet

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 43

def resource_group
  @resource_group
end

Class Method Details

.attribute_map ⇒ Object

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 91

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'namespace': :'namespace',
    'resource_group': :'resourceGroup',
    '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.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 107

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



178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 178

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

  self.class == other.class &&
    namespace == other.namespace &&
    resource_group == other.resource_group &&
    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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 215

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


195
196
197
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 195

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [namespace, resource_group, 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



248
249
250
251
252
253
254
255
256
257
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 248

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



242
243
244
 
# File 'lib/oci/monitoring/models/metric_data.rb', line 242

def to_s
  to_hash.to_s
end