Class: OCI::Monitoring::Models::MetricData
- Inherits:
-
Object
- Object
- OCI::Monitoring::Models::MetricData
- 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).
Limits information for returned data follows.
-
Data points: 100,000.
-
Metric streams* within data points: 2,000.
-
Time range returned for 1-hour resolution: 90 days.
-
Time range returned for 5-minute resolution: 30 days.
-
Time range returned for any other resolution: 7 days.
*A metric stream is an individual set of aggregated data for a metric, typically specific to a single resource. 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](docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#concepts).
Instance Attribute Summary collapse
-
#aggregated_datapoints ⇒ Array<OCI::Monitoring::Models::AggregatedDatapoint>
[Required] The list of timestamp-value pairs returned for the specified request.
-
#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.
-
#dimensions ⇒ Hash<String, String>
[Required] Qualifiers provided in the definition of the returned metric.
-
#metadata ⇒ Hash<String, String>
The references provided in a metric definition to indicate extra information about the metric.
-
#name ⇒ String
[Required] The name of the metric.
-
#namespace ⇒ String
[Required] The reference provided in a metric definition to indicate the source service or application that emitted the metric.
-
#resolution ⇒ String
The time between calculated aggregation windows.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ MetricData
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ MetricData
Initializes the object
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/oci/monitoring/models/metric_data.rb', line 120 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. = 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.
75 76 77 |
# File 'lib/oci/monitoring/models/metric_data.rb', line 75 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.
36 37 38 |
# File 'lib/oci/monitoring/models/metric_data.rb', line 36 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"`
51 52 53 |
# File 'lib/oci/monitoring/models/metric_data.rb', line 51 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"`
58 59 60 |
# File 'lib/oci/monitoring/models/metric_data.rb', line 58 def @metadata end |
#name ⇒ String
[Required] The name of the metric.
Example: ‘CpuUtilization`
43 44 45 |
# File 'lib/oci/monitoring/models/metric_data.rb', line 43 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`
30 31 32 |
# File 'lib/oci/monitoring/models/metric_data.rb', line 30 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`
69 70 71 |
# File 'lib/oci/monitoring/models/metric_data.rb', line 69 def resolution @resolution end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/oci/monitoring/models/metric_data.rb', line 78 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.
93 94 95 96 97 98 99 100 101 102 103 104 105 |
# File 'lib/oci/monitoring/models/metric_data.rb', line 93 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.
156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'lib/oci/monitoring/models/metric_data.rb', line 156 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 && == other. && resolution == other.resolution && aggregated_datapoints == other.aggregated_datapoints end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 |
# File 'lib/oci/monitoring/models/metric_data.rb', line 192 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
172 173 174 |
# File 'lib/oci/monitoring/models/metric_data.rb', line 172 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
181 182 183 |
# File 'lib/oci/monitoring/models/metric_data.rb', line 181 def hash [namespace, compartment_id, name, dimensions, , resolution, aggregated_datapoints].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
225 226 227 228 229 230 231 232 233 234 |
# File 'lib/oci/monitoring/models/metric_data.rb', line 225 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
219 220 221 |
# File 'lib/oci/monitoring/models/metric_data.rb', line 219 def to_s to_hash.to_s end |