Class: OCI::OciControlCenter::Models::RequestSummarizedMetricDataDetails
- Inherits:
-
Object
- Object
- OCI::OciControlCenter::Models::RequestSummarizedMetricDataDetails
- Defined in:
- lib/oci/oci_control_center/models/request_summarized_metric_data_details.rb
Overview
The request details for retrieving aggregated data. Use the query and optional properties to filter the returned results.
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment to use for authorization to read metrics.
-
#dimensions ⇒ Hash<String, OCI::OciControlCenter::Models::DimensionValue>
Qualifiers to use when searching for metric data.
-
#end_time ⇒ DateTime
The end of the sampled time range to use when searching for metric data points.
-
#metric_name ⇒ String
[Required] The name of a metric for retrieving aggregated data.
-
#namespace_name ⇒ String
[Required] The source service or application to use when searching for metric data points to aggregate.
-
#start_time ⇒ DateTime
The beginning of the sampled time range to use when searching for metric data points.
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 = {}) ⇒ RequestSummarizedMetricDataDetails
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 = {}) ⇒ RequestSummarizedMetricDataDetails
Initializes the object
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/oci/oci_control_center/models/request_summarized_metric_data_details.rb', line 82 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_name = attributes[:'namespaceName'] if attributes[:'namespaceName'] raise 'You cannot provide both :namespaceName and :namespace_name' if attributes.key?(:'namespaceName') && attributes.key?(:'namespace_name') self.namespace_name = attributes[:'namespace_name'] if attributes[:'namespace_name'] self.metric_name = attributes[:'metricName'] if attributes[:'metricName'] raise 'You cannot provide both :metricName and :metric_name' if attributes.key?(:'metricName') && attributes.key?(:'metric_name') self.metric_name = attributes[:'metric_name'] if attributes[:'metric_name'] 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'] self.start_time = attributes[:'startTime'] if attributes[:'startTime'] raise 'You cannot provide both :startTime and :start_time' if attributes.key?(:'startTime') && attributes.key?(:'start_time') self.start_time = attributes[:'start_time'] if attributes[:'start_time'] self.end_time = attributes[:'endTime'] if attributes[:'endTime'] raise 'You cannot provide both :endTime and :end_time' if attributes.key?(:'endTime') && attributes.key?(:'end_time') self.end_time = attributes[:'end_time'] if attributes[:'end_time'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment to use for authorization to read metrics. To use the root compartment, provide the tenancyId.
25 26 27 |
# File 'lib/oci/oci_control_center/models/request_summarized_metric_data_details.rb', line 25 def compartment_id @compartment_id end |
#dimensions ⇒ Hash<String, OCI::OciControlCenter::Models::DimensionValue>
Qualifiers to use when searching for metric data. For a list of valid dimensions for a given metric, see list_metric_properties.
30 31 32 |
# File 'lib/oci/oci_control_center/models/request_summarized_metric_data_details.rb', line 30 def dimensions @dimensions end |
#end_time ⇒ DateTime
The end of the sampled time range to use when searching for metric data points. Format is defined by <a href="RFC3339www.rfc-editor.org/rfc/rfc3339">RFC3339>. The response excludes metric data points for sampled time. Example 2019-02-01T02:02:29.600Z
40 41 42 |
# File 'lib/oci/oci_control_center/models/request_summarized_metric_data_details.rb', line 40 def end_time @end_time end |
#metric_name ⇒ String
[Required] The name of a metric for retrieving aggregated data. For a list of valid metrics for a given namespace, see list_metric_properties.
20 21 22 |
# File 'lib/oci/oci_control_center/models/request_summarized_metric_data_details.rb', line 20 def metric_name @metric_name end |
#namespace_name ⇒ String
[Required] The source service or application to use when searching for metric data points to aggregate. For a list of valid namespaces, see list_namespaces.
15 16 17 |
# File 'lib/oci/oci_control_center/models/request_summarized_metric_data_details.rb', line 15 def namespace_name @namespace_name end |
#start_time ⇒ DateTime
The beginning of the sampled time range to use when searching for metric data points. Format is defined by <a href="RFC3339www.rfc-editor.org/rfc/rfc3339">RFC3339>. The response includes metric data points for the sampled time. Example 2019-02-01T02:02:29.600Z
35 36 37 |
# File 'lib/oci/oci_control_center/models/request_summarized_metric_data_details.rb', line 35 def start_time @start_time end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/oci/oci_control_center/models/request_summarized_metric_data_details.rb', line 43 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'namespace_name': :'namespaceName', 'metric_name': :'metricName', 'compartment_id': :'compartmentId', 'dimensions': :'dimensions', 'start_time': :'startTime', 'end_time': :'endTime' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/oci/oci_control_center/models/request_summarized_metric_data_details.rb', line 57 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'namespace_name': :'String', 'metric_name': :'String', 'compartment_id': :'String', 'dimensions': :'Hash<String, OCI::OciControlCenter::Models::DimensionValue>', 'start_time': :'DateTime', 'end_time': :'DateTime' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
128 129 130 131 132 133 134 135 136 137 138 |
# File 'lib/oci/oci_control_center/models/request_summarized_metric_data_details.rb', line 128 def ==(other) return true if equal?(other) self.class == other.class && namespace_name == other.namespace_name && metric_name == other.metric_name && compartment_id == other.compartment_id && dimensions == other.dimensions && start_time == other.start_time && end_time == other.end_time end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/oci/oci_control_center/models/request_summarized_metric_data_details.rb', line 163 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
143 144 145 |
# File 'lib/oci/oci_control_center/models/request_summarized_metric_data_details.rb', line 143 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
152 153 154 |
# File 'lib/oci/oci_control_center/models/request_summarized_metric_data_details.rb', line 152 def hash [namespace_name, metric_name, compartment_id, dimensions, start_time, end_time].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
196 197 198 199 200 201 202 203 204 205 |
# File 'lib/oci/oci_control_center/models/request_summarized_metric_data_details.rb', line 196 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
190 191 192 |
# File 'lib/oci/oci_control_center/models/request_summarized_metric_data_details.rb', line 190 def to_s to_hash.to_s end |