Class GetMetricWidgetImageRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetMetricWidgetImageRequest.Builder,
GetMetricWidgetImageRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
A JSON string that defines the bitmap graph to be retrieved.final String
The format of the resulting image.static Class
<? extends GetMetricWidgetImageRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
- Returns:
- 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.
-
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:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetMetricWidgetImageRequest.Builder,
GetMetricWidgetImageRequest> - Specified by:
toBuilder
in classCloudWatchRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-