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 Details

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

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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetMetricWidgetImageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetMetricWidgetImageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.