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



114
115
116
117
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
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 114

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_timeDateTime

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: 2019-02-01T02:02:29.600Z

Returns:

  • (DateTime)


61
62
63
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 61

def end_time
  @end_time
end

#namespaceString

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

Example: oci_computeagent

Returns:

  • (String)


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

def namespace
  @namespace
end

#queryString

[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: 1m-60m (also 1h). You can optionally specify dimensions and grouping functions. 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: CpuUtilization[1m].sum()

Returns:

  • (String)


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

def query
  @query
end

#resolutionString

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

Returns:

  • (String)


72
73
74
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 72

def resolution
  @resolution
end

#resource_groupString

Resource group that you want to use as a filter. 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 ($). Avoid entering confidential information.

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_timeDateTime

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: 2019-02-01T01:02:29.600Z

Returns:

  • (DateTime)


52
53
54
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 52

def start_time
  @start_time
end

Class Method Details

.attribute_mapObject

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



75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 75

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_typesObject

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 89

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



152
153
154
155
156
157
158
159
160
161
162
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 152

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



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

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


167
168
169
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 167

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



176
177
178
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 176

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



220
221
222
223
224
225
226
227
228
229
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 220

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



214
215
216
# File 'lib/oci/monitoring/models/summarize_metrics_data_details.rb', line 214

def to_s
  to_hash.to_s
end