@Generated(value="software.amazon.awssdk:codegen") public final class GetMetricWidgetImageRequest extends CloudWatchRequest implements ToCopyableBuilder<GetMetricWidgetImageRequest.Builder,GetMetricWidgetImageRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
GetMetricWidgetImageRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static GetMetricWidgetImageRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
metricWidget()
A JSON string that defines the bitmap graph to be retrieved.
|
String |
outputFormat()
The format of the resulting image.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetMetricWidgetImageRequest.Builder> |
serializableBuilderClass() |
GetMetricWidgetImageRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final 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
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.
public final 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 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.
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.
public GetMetricWidgetImageRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<GetMetricWidgetImageRequest.Builder,GetMetricWidgetImageRequest>
toBuilder
in class CloudWatchRequest
public static GetMetricWidgetImageRequest.Builder builder()
public static Class<? extends GetMetricWidgetImageRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2021. All rights reserved.