public static interface GetMetricWidgetImageRequest.Builder extends CloudWatchRequest.Builder, SdkPojo, CopyableBuilder<GetMetricWidgetImageRequest.Builder,GetMetricWidgetImageRequest>
Modifier and Type | Method and Description |
---|---|
GetMetricWidgetImageRequest.Builder |
metricWidget(String metricWidget)
A JSON string that defines the bitmap graph to be retrieved.
|
GetMetricWidgetImageRequest.Builder |
outputFormat(String outputFormat)
The format of the resulting image.
|
GetMetricWidgetImageRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
GetMetricWidgetImageRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
GetMetricWidgetImageRequest.Builder metricWidget(String 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.
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.
GetMetricWidgetImageRequest.Builder outputFormat(String 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 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.
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 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.
GetMetricWidgetImageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
GetMetricWidgetImageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2021. All rights reserved.