/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace CloudWatch { namespace Model { /** */ class GetMetricWidgetImageRequest : public CloudWatchRequest { public: AWS_CLOUDWATCH_API GetMetricWidgetImageRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "GetMetricWidgetImage"; } AWS_CLOUDWATCH_API Aws::String SerializePayload() const override; protected: AWS_CLOUDWATCH_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

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.

*/ inline const Aws::String& GetMetricWidget() const{ return m_metricWidget; } /** *

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.

*/ inline bool MetricWidgetHasBeenSet() const { return m_metricWidgetHasBeenSet; } /** *

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.

*/ inline void SetMetricWidget(const Aws::String& value) { m_metricWidgetHasBeenSet = true; m_metricWidget = value; } /** *

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.

*/ inline void SetMetricWidget(Aws::String&& value) { m_metricWidgetHasBeenSet = true; m_metricWidget = std::move(value); } /** *

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.

*/ inline void SetMetricWidget(const char* value) { m_metricWidgetHasBeenSet = true; m_metricWidget.assign(value); } /** *

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.

*/ inline GetMetricWidgetImageRequest& WithMetricWidget(const Aws::String& value) { SetMetricWidget(value); return *this;} /** *

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.

*/ inline GetMetricWidgetImageRequest& WithMetricWidget(Aws::String&& value) { SetMetricWidget(std::move(value)); return *this;} /** *

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.

*/ inline GetMetricWidgetImageRequest& WithMetricWidget(const char* value) { SetMetricWidget(value); return *this;} /** *

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 Amazon Web Services 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.

*/ inline const Aws::String& GetOutputFormat() const{ return m_outputFormat; } /** *

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 Amazon Web Services 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.

*/ inline bool OutputFormatHasBeenSet() const { return m_outputFormatHasBeenSet; } /** *

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 Amazon Web Services 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.

*/ inline void SetOutputFormat(const Aws::String& value) { m_outputFormatHasBeenSet = true; m_outputFormat = value; } /** *

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 Amazon Web Services 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.

*/ inline void SetOutputFormat(Aws::String&& value) { m_outputFormatHasBeenSet = true; m_outputFormat = std::move(value); } /** *

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 Amazon Web Services 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.

*/ inline void SetOutputFormat(const char* value) { m_outputFormatHasBeenSet = true; m_outputFormat.assign(value); } /** *

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 Amazon Web Services 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.

*/ inline GetMetricWidgetImageRequest& WithOutputFormat(const Aws::String& value) { SetOutputFormat(value); return *this;} /** *

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 Amazon Web Services 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.

*/ inline GetMetricWidgetImageRequest& WithOutputFormat(Aws::String&& value) { SetOutputFormat(std::move(value)); return *this;} /** *

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 Amazon Web Services 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.

*/ inline GetMetricWidgetImageRequest& WithOutputFormat(const char* value) { SetOutputFormat(value); return *this;} private: Aws::String m_metricWidget; bool m_metricWidgetHasBeenSet = false; Aws::String m_outputFormat; bool m_outputFormatHasBeenSet = false; }; } // namespace Model } // namespace CloudWatch } // namespace Aws