class OCI::Monitoring::Models::Metric
The properties that define a metric. For information about metrics, see [Metrics Overview](docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#MetricsOverview).
Attributes
The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric.
@return [String]
Qualifiers provided in a metric definition. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair.
Example: `"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"`
@return [Hash<String, String>]
The name of the metric.
Example: `CpuUtilization`
@return [String]
The source service or application emitting the metric.
Example: `oci_computeagent`
@return [String]
Resource group provided with the posted metric. A resource group is a custom string that can be used as a filter. 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 ($). Avoid entering confidential information.
Example: `frontend-fleet`
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/monitoring/models/metric.rb, line 51 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'name': :'name', 'namespace': :'namespace', 'resource_group': :'resourceGroup', 'compartment_id': :'compartmentId', 'dimensions': :'dimensions' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :namespace The value to assign to the {#namespace} property @option attributes [String] :resource_group The value to assign to the {#resource_group} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [Hash<String, String>] :dimensions The value to assign to the {#dimensions} property
# File lib/oci/monitoring/models/metric.rb, line 87 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.name = attributes[:'name'] if attributes[:'name'] 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.dimensions = attributes[:'dimensions'] if attributes[:'dimensions'] end
Attribute type mapping.
# File lib/oci/monitoring/models/metric.rb, line 64 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'name': :'String', 'namespace': :'String', 'resource_group': :'String', 'compartment_id': :'String', 'dimensions': :'Hash<String, String>' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/monitoring/models/metric.rb, line 119 def ==(other) return true if equal?(other) self.class == other.class && name == other.name && namespace == other.namespace && resource_group == other.resource_group && compartment_id == other.compartment_id && dimensions == other.dimensions end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/monitoring/models/metric.rb, line 153 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/monitoring/models/metric.rb, line 133 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/monitoring/models/metric.rb, line 142 def hash [name, namespace, resource_group, compartment_id, dimensions].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/monitoring/models/metric.rb, line 186 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/monitoring/models/metric.rb, line 180 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/monitoring/models/metric.rb, line 203 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end