Interface GetMetricWidgetImageRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CloudWatchRequest.Builder
,CopyableBuilder<GetMetricWidgetImageRequest.Builder,GetMetricWidgetImageRequest>
,SdkBuilder<GetMetricWidgetImageRequest.Builder,GetMetricWidgetImageRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- GetMetricWidgetImageRequest
public static interface GetMetricWidgetImageRequest.Builder extends CloudWatchRequest.Builder, SdkPojo, CopyableBuilder<GetMetricWidgetImageRequest.Builder,GetMetricWidgetImageRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetMetricWidgetImageRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
metricWidget
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 eachGetMetricWidgetImage
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.
- Parameters:
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 oneMetricWidget
parameter in eachGetMetricWidgetImage
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputFormat
GetMetricWidgetImageRequest.Builder outputFormat(String outputFormat)
The format of the resulting image. Only PNG images are supported.
The default is
png
. If you specifypng
, the API returns an HTTP response with the content-type set totext/xml
. The image data is in aMetricWidgetImage
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 usepng
. If you specifyimage/png
, the HTTP response has a content-type set toimage/png
, and the body of the response is a PNG image.- Parameters:
outputFormat
- The format of the resulting image. Only PNG images are supported.The default is
png
. If you specifypng
, the API returns an HTTP response with the content-type set totext/xml
. The image data is in aMetricWidgetImage
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 usepng
. If you specifyimage/png
, the HTTP response has a content-type set toimage/png
, and the body of the response is a PNG image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GetMetricWidgetImageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
GetMetricWidgetImageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-