File: metric_statistics.rb

package info (click to toggle)
ruby-aws-sdk 1.67.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,840 kB
  • sloc: ruby: 28,436; makefile: 7
file content (69 lines) | stat: -rw-r--r-- 1,769 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
#     http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.

module AWS
  class CloudWatch

    # Statistics for a metric.
    #
    # This class is an enumerable collection of data points.
    #
    # ## Enumerating Statistics
    #
    #     metric = CloudWatch::Metric.new('my/namepace', 'metric-name')
    #
    #     stats = metric.statistics(
    #       :start_time => Time.now - 3600,
    #       :end_time => Time.now,
    #       :statistics => ['Average'])
    #
    #     stats.label #=> 'some-label'
    #     stats.each do |datapoint|
    #       # datapoint is a hash
    #     end
    #
    # @see Core::Collection
    #
    class MetricStatistics

      include Core::Collection::Simple

      # @param [Metric] metric
      # @param [String] label
      # @param [Array<Hash>] datapoints
      def initialize metric, label, datapoints
        @metric = metric
        @label = label
        @datapoints = datapoints
      end

      # @return [Metric]
      attr_reader :metric

      # @return [String]
      attr_reader :label

      # @return [Array<Hash>]
      attr_reader :datapoints

      protected

      def _each_item options = {}
        datapoints.each do |point|
          yield(point)
        end
      end

    end
  end
end