Class: MintPress::Aws::CloudWatch::MetricWidimage

Inherits:

Object

• Object
• MintPress::Aws::CloudWatch::MetricWidimage

Includes:

MintLogger, AwsCommon, Mixins::Properties

Defined in:

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

Properties (Read/Write)

• #metric_widget ⇒ [String]
  'A JSON string that defines the bitmap graph to be retrieved. The string includes the metrics to include in the graph, statistics, annotations, title, axis limits, and so on. You can include only one MetricWidget parameter in each GetMetricWidgetImage call. For more information about the syntax of MetricWidget see GetMetricWidgetImage: Metric Widget Structure and Syntax. If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation point appears next to the graph legend.'
  Property Attributes
  • get_metric_widget_image_prop ⇒ 'metric_widget'
  • read_only ⇒ false
  • source ⇒ "get_metric_widget_image"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_widimage.rb', line 17
  
  property :metric_widget, get_metric_widget_image_prop: 'metric_widget', type: [String], read_only: false, source: "get_metric_widget_image", description: 'A JSON string that defines the bitmap graph to be retrieved. The
  string includes the metrics to include in the graph, statistics,
  annotations, title, axis limits, and so on. You can include only one
  MetricWidget parameter in each GetMetricWidgetImage call.
  
  For more information about the syntax of MetricWidget see
  GetMetricWidgetImage: Metric Widget Structure and Syntax.
  
  If any metric on the graph could not load all the requested data
  points, an orange triangle with an exclamation point appears next to
  the graph legend.'

• #output_format ⇒ [String]
  'The format of the resulting image. Only PNG images are supported. The default is png. If you specify png, the API returns an HTTP response with the content-type set to text/xml. The image data is in a MetricWidgetImage field. For example: > iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip... 6f0d4192-4d42-11e8-82c1-f539a07e0e3b The image/png setting is intended only for custom HTTP requests. For most use cases, and all actions using an AWS SDK, you should use png. If you specify image/png, the HTTP response has a content-type set to image/png, and the body of the response is a PNG image.'
  Property Attributes
  • get_metric_widget_image_prop ⇒ 'output_format'
  • read_only ⇒ false
  • source ⇒ "get_metric_widget_image"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_widimage.rb', line 28
  
  property :output_format, get_metric_widget_image_prop: 'output_format', type: [String], read_only: false, source: "get_metric_widget_image", description: 'The format of the resulting image. Only PNG images are supported.
  
  The default is png. If you specify png, the API returns an HTTP
  response with the content-type set to text/xml. The image data is in
  a MetricWidgetImage field. For example:
  
  <GetMetricWidgetImageResponse xmlns=<URLstring>>
  
  <GetMetricWidgetImageResult>
  
  <MetricWidgetImage>
  
  iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...
  
  </MetricWidgetImage>
  
  </GetMetricWidgetImageResult>
  
  <ResponseMetadata>
  
  <RequestId>6f0d4192-4d42-11e8-82c1-f539a07e0e3b</RequestId>
  
  </ResponseMetadata>
  
  </GetMetricWidgetImageResponse>
  
  The image/png setting is intended only for custom HTTP requests. For
  most use cases, and all actions using an AWS SDK, you should use
  png. If you specify image/png, the HTTP response has a
  content-type set to image/png, and the body of the response is a PNG
  image.'

• #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_widimage.rb', line 62
  
  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_widimage.rb', line 65
  
  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

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

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

Returns a new instance of MetricWidimage.

Instance Method Details

#get ⇒ Object