Class GetMetricWidgetImageRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest
software.amazon.awssdk.services.cloudwatch.model.GetMetricWidgetImageRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetMetricWidgetImageRequest.Builder,GetMetricWidgetImageRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetMetricWidgetImageRequest extends CloudWatchRequest implements ToCopyableBuilder<GetMetricWidgetImageRequest.Builder,GetMetricWidgetImageRequest>

  • Method Details

    • metricWidget

      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.

      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 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.

    • outputFormat

      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.

      Returns:
      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.

    • toBuilder

      public GetMetricWidgetImageRequest.Builder 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 interface ToCopyableBuilder<GetMetricWidgetImageRequest.Builder,GetMetricWidgetImageRequest>
      Specified by:
      toBuilder in class CloudWatchRequest
      Returns:
      a builder for type T

    • builder

      public static GetMetricWidgetImageRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetMetricWidgetImageRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.