Class: MintPress::Aws::CloudWatch::MetricDatum

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_datum.rb

Properties (Read/Write)

  • #id ⇒ [String] (Default Value: Proc.new { self.name })
    'The short name you specified to represent this metric.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::CloudWatch::MetricDatum"
    • orig_name ⇒ 'id'
    • default ⇒ Proc.new { self.name }
    

19
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_datum.rb', line 19

property :id, disposition: :attribute, description: 'The short name you specified to represent this metric.', source: "MintPress::Aws::CloudWatch::MetricDatum", orig_name: 'id', type: [String], default: Proc.new { self.name }
  • #label ⇒ [String]
    'The human-readable label associated with the data.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::CloudWatch::MetricDatum"
    • orig_name ⇒ 'label'
    

20
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_datum.rb', line 20

property :label, disposition: :attribute, description: 'The human-readable label associated with the data.', source: "MintPress::Aws::CloudWatch::MetricDatum", orig_name: 'label', type: [String]
  • #messages ⇒ Array of ⇒ [MintPress::Aws::CloudWatch::MessageDatum]
    'A list of messages with additional information about the data returned.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::CloudWatch::MetricDatum"
    • orig_name ⇒ 'messages'
    

21
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_datum.rb', line 21

property :messages, disposition: :attribute, description: 'A list of messages with additional information about the data returned.', source: "MintPress::Aws::CloudWatch::MetricDatum", orig_name: 'messages', type: [MintPress::Aws::CloudWatch::MessageDatum], array: true
  • #status_code ⇒ [String]
    'The status of the returned data.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::CloudWatch::MetricDatum"
    • orig_name ⇒ 'status_code'
    

22
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_datum.rb', line 22

property :status_code, disposition: :attribute, description: 'The status of the returned data.', source: "MintPress::Aws::CloudWatch::MetricDatum", orig_name: 'status_code', type: [String]
  • #timestamps ⇒ Array of ⇒ [Time]
    'The timestamps for the data points, formatted in Unix timestamp format.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::CloudWatch::MetricDatum"
    • orig_name ⇒ 'timestamps'
    

23
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_datum.rb', line 23

property :timestamps, disposition: :attribute, description: 'The timestamps for the data points, formatted in Unix timestamp format.', source: "MintPress::Aws::CloudWatch::MetricDatum", orig_name: 'timestamps', type: [Time], array: true
  • #values ⇒ Array of ⇒ [Float]
    'The data points for the metric corresponding to Timestamps.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::CloudWatch::MetricDatum"
    • orig_name ⇒ 'values'
    

24
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_datum.rb', line 24

property :values, disposition: :attribute, description: 'The data points for the metric corresponding to Timestamps.', source: "MintPress::Aws::CloudWatch::MetricDatum", orig_name: 'values', type: [Float], array: true
  • #metric_data_queries ⇒ Hash of ⇒ [MintPress::Aws::CloudWatch::MetricDataQuery]
    'The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.'
    Property Attributes
    • get_metric_data_prop ⇒ 'metric_data_queries'
    • read_only ⇒ false
    • source ⇒ "get_metric_data"
    

25
26
27
28
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_datum.rb', line 25

property :metric_data_queries, get_metric_data_prop: 'metric_data_queries', type: [MintPress::Aws::CloudWatch::MetricDataQuery], array: false, read_only: false, source: "get_metric_data", description: 'The metric queries to be returned. A single GetMetricData call can
include as many as 500 MetricDataQuery structures. Each of these
structures can specify either a metric to retrieve, or a math
expression to perform on retrieved data.', hash: true
  • #start_time ⇒ [Time,DateTime,Integer]
    'The time stamp indicating the earliest data to be returned. The value specified is inclusive; results include data points with the specified time stamp. CloudWatch rounds the specified time stamp as follows: Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00. Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00. Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00. If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15. For better performance, specify StartTime and EndTime values that align with the value of the metric"s Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime.'
    Property Attributes
    • get_metric_data_prop ⇒ 'start_time'
    • read_only ⇒ false
    • source ⇒ "get_metric_data"
    

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
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_datum.rb', line 29

property :start_time, get_metric_data_prop: 'start_time', type: [Time,DateTime,Integer], read_only: false, source: "get_metric_data", description: 'The time stamp indicating the earliest data to be returned.

The value specified is inclusive; results include data points with the
specified time stamp.

CloudWatch rounds the specified time stamp as follows:


Start time less than 15 days ago - Round down to the nearest whole
minute. For example, 12:32:34 is rounded down to 12:32:00.
Start time between 15 and 63 days ago - Round down to the nearest
5-minute clock interval. For example, 12:32:34 is rounded down to
12:30:00.
Start time greater than 63 days ago - Round down to the nearest
1-hour clock interval. For example, 12:32:34 is rounded down to
12:00:00.



If you set Period to 5, 10, or 30, the start time of your request is
rounded down to the nearest time that corresponds to even 5-, 10-, or
30-second divisions of a minute. For example, if you make a query at
(HH:mm:ss) 01:05:23 for the previous 10-second period, the start time
of your request is rounded down and you receive data from 01:05:10 to
01:05:20. If you make a query at 15:07:17 for the previous 5 minutes
of data, using a period of 5 seconds, you receive data timestamped
between 15:02:15 and 15:07:15.

For better performance, specify StartTime and EndTime values that
align with the value of the metric"s Period and sync up with the
beginning and end of an hour. For example, if the Period of a metric
is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a
faster response from CloudWatch than setting 12:07 or 12:29 as the
StartTime.'
  • #end_time ⇒ [Time,DateTime,Integer]
    'The time stamp indicating the latest data to be returned. The value specified is exclusive; results include data points up to the specified time stamp. For better performance, specify StartTime and EndTime values that align with the value of the metric"s Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the EndTime.'
    Property Attributes
    • get_metric_data_prop ⇒ 'end_time'
    • read_only ⇒ false
    • source ⇒ "get_metric_data"
    

63
64
65
66
67
68
69
70
71
72
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_datum.rb', line 63

property :end_time, get_metric_data_prop: 'end_time', type: [Time,DateTime,Integer], read_only: false, source: "get_metric_data", description: 'The time stamp indicating the latest data to be returned.

The value specified is exclusive; results include data points up to
the specified time stamp.

For better performance, specify StartTime and EndTime values that
align with the value of the metric"s Period and sync up with the
beginning and end of an hour. For example, if the Period of a metric
is 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster
response from CloudWatch than setting 12:07 or 12:29 as the EndTime.'
  • #scan_by ⇒ [String]
    'The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached.'
    Property Attributes
    • get_metric_data_prop ⇒ 'scan_by'
    • read_only ⇒ false
    • source ⇒ "get_metric_data"
    

73
74
75
76
77
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_datum.rb', line 73

property :scan_by, get_metric_data_prop: 'scan_by', type: [String], read_only: false, source: "get_metric_data", description: 'The order in which data points should be returned.
TimestampDescending returns the newest data first and paginates when
the MaxDatapoints limit is reached. TimestampAscending returns the
oldest data first and paginates when the MaxDatapoints limit is
reached.'
  • #max_datapoints ⇒ [Integer]
    'The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.'
    Property Attributes
    • get_metric_data_prop ⇒ 'max_datapoints'
    • read_only ⇒ false
    • source ⇒ "get_metric_data"
    

78
79
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_datum.rb', line 78

property :max_datapoints, get_metric_data_prop: 'max_datapoints', type: [Integer], read_only: false, source: "get_metric_data", description: 'The maximum number of data points the request should return before
paginating. If you omit this, the default of 100,800 is used.'
  • #name ⇒ String

    Property Attributes 
    

80
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_datum.rb', line 80

property :name, type: String
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

84
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_datum.rb', line 84

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

87
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_datum.rb', line 87

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ MetricDatum

Returns a new instance of MetricDatum.

Instance Method Details

#get ⇒ Object