Class: MintPress::Aws::CloudWatch::MetricDataQuery

Inherits:

Object

• Object
• MintPress::Aws::CloudWatch::MetricDataQuery

Includes:

MintLogger, AwsCommon, Mixins::Properties

Defined in:

src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_data_query.rb

Properties (Read/Write)

• #expression ⇒ [String]
  'The math expression to be performed on the returned data, if this object is performing a math expression.'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::CloudWatch::MetricDataQuery"
  • orig_name ⇒ 'expression'
  • get_metric_data_prop ⇒ 'expression'

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_data_query.rb', line 16
  
  property :expression, disposition: :attribute, description: 'The math expression to be performed on the returned data, if this object is performing a math expression.', source: "MintPress::Aws::CloudWatch::MetricDataQuery", orig_name: 'expression', type: [String], get_metric_data_prop: 'expression'

• #id ⇒ [String] (Default Value: Proc.new { self.name })
  'A short name used to tie this object to the results in the response.'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::CloudWatch::MetricDataQuery"
  • orig_name ⇒ 'id'
  • get_metric_data_prop ⇒ 'id'
  • default ⇒ Proc.new { self.name }

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_data_query.rb', line 17
  
  property :id, disposition: :attribute, description: 'A short name used to tie this object to the results in the response.', source: "MintPress::Aws::CloudWatch::MetricDataQuery", orig_name: 'id', type: [String], get_metric_data_prop: 'id', default: Proc.new { self.name }

• #label ⇒ [String]
  'A human-readable label for this metric or expression.'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::CloudWatch::MetricDataQuery"
  • orig_name ⇒ 'label'
  • get_metric_data_prop ⇒ 'label'

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_data_query.rb', line 18
  
  property :label, disposition: :attribute, description: 'A human-readable label for this metric or expression.', source: "MintPress::Aws::CloudWatch::MetricDataQuery", orig_name: 'label', type: [String], get_metric_data_prop: 'label'

• #metric_stat ⇒ [MintPress::Aws::CloudWatch::MetricStat] (Default Value: MintPress::Aws::CloudWatch::MetricStat.new)
  'The metric to be returned, along with statistics, period, and units.'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::CloudWatch::MetricDataQuery"
  • orig_name ⇒ 'metric_stat'
  • default ⇒ MintPress::Aws::CloudWatch::MetricStat.new
  • get_metric_data_prop ⇒ 'metric_stat'

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_data_query.rb', line 19
  
  property :metric_stat, disposition: :attribute, description: 'The metric to be returned, along with statistics, period, and units.', source: "MintPress::Aws::CloudWatch::MetricDataQuery", orig_name: 'metric_stat', type: [MintPress::Aws::CloudWatch::MetricStat], default: MintPress::Aws::CloudWatch::MetricStat.new, get_metric_data_prop: 'metric_stat'

• #period ⇒ [Integer]
  'The granularity, in seconds, of the returned data points.'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::CloudWatch::MetricDataQuery"
  • orig_name ⇒ 'period'
  • get_metric_data_prop ⇒ 'period'

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_data_query.rb', line 20
  
  property :period, disposition: :attribute, description: 'The granularity, in seconds, of the returned data points.', source: "MintPress::Aws::CloudWatch::MetricDataQuery", orig_name: 'period', type: [Integer], get_metric_data_prop: 'period'

• #return_data ⇒ [TrueClass,FalseClass]
  'When used in GetMetricData, this option indicates whether to return the timestamps and raw data values of this metric.'
  Property Attributes
  • disposition ⇒ :attribute
  • source ⇒ "MintPress::Aws::CloudWatch::MetricDataQuery"
  • orig_name ⇒ 'return_data'
  • get_metric_data_prop ⇒ 'return_data'

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_data_query.rb', line 21
  
  property :return_data, disposition: :attribute, description: 'When used in GetMetricData, this option indicates whether to return the timestamps and raw data values of this metric.', source: "MintPress::Aws::CloudWatch::MetricDataQuery", orig_name: 'return_data', type: [TrueClass,FalseClass], get_metric_data_prop: 'return_data'

• #name ⇒ String
  
  Property Attributes

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

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

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

• #initialize(opts = {}) ⇒ MetricDataQuery constructor
  A new instance of MetricDataQuery.

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 = {}) ⇒ MetricDataQuery

Returns a new instance of MetricDataQuery.