Class: OCI::Monitoring::Models::SummarizeMetricsDataDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/monitoring/models/summarize_metrics_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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SummarizeMetricsDataDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :namespace (String) —

    The value to assign to the #namespace property

  • :resource_group (String) —

    The value to assign to the #resource_group property

  • :query (String) —

    The value to assign to the #query property

  • :start_time (DateTime) —

    The value to assign to the #start_time property

  • :end_time (DateTime) —

    The value to assign to the #end_time property

  • :resolution (String) —

    The value to assign to the #resolution property



118
119
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/summarize_metrics_data_details.rb', line 118

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

  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']

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

Instance Attribute Details

#end_time ⇒ DateTime

The end of the time range to use when searching for metric data points. Format is defined by RFC3339. The response excludes metric data points for the endTime. Default value: the timestamp representing when the call was sent.

Example: 2023-02-01T02:02:29.600Z

Returns:

  • (DateTime) 


65
66
67
 
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 65

def end_time
  @end_time
end

#namespace ⇒ String

[Required] The source service or application to use when searching for metric data points to aggregate.

Example: oci_computeagent

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 18

def namespace
  @namespace
end

#query ⇒ String

[Required] The Monitoring Query Language (MQL) expression to use when searching for metric data points to aggregate. The query must specify a metric, statistic, and interval. Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. When specifying a dimension value, surround it with double quotes, and escape each double quote with a backslash (\) character. Supported grouping functions: grouping(), groupBy().

Construct your query to avoid exceeding limits on returned data. See MetricData.

For details about Monitoring Query Language (MQL), see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.

Example 1: CpuUtilization[1m].sum()

Example 2 (escaped double quotes for value string): CpuUtilization[1m]{resourceId = \\"<var>&lt;instance_OCID&gt;</var>\\"}.max()

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 47

def query
  @query
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) 


76
77
78
 
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 76

def resolution
  @resolution
end

#resource_group ⇒ String

Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. 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) 


26
27
28
 
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 26

def resource_group
  @resource_group
end

#start_time ⇒ DateTime

The beginning of the time range to use when searching for metric data points. Format is defined by RFC3339. The response includes metric data points for the startTime. Default value: the timestamp 3 hours before the call was sent.

Example: 2023-02-01T01:02:29.600Z

Returns:

  • (DateTime) 


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

def start_time
  @start_time
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'namespace': :'namespace',
    'resource_group': :'resourceGroup',
    'query': :'query',
    'start_time': :'startTime',
    'end_time': :'endTime',
    'resolution': :'resolution'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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



156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 156

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

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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 191

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


171
172
173
 
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 171

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



180
181
182
 
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 180

def hash
  [namespace, resource_group, query, start_time, end_time, resolution].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



224
225
226
227
228
229
230
231
232
233
 
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 224

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



218
219
220
 
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 218

def to_s
  to_hash.to_s
end