/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.cloudwatch.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GetMetricWidgetImageRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

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

*/ private String metricWidget; /** *

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

*/ private String outputFormat; /** *

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

* * @param 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. */ public void setMetricWidget(String metricWidget) { this.metricWidget = 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. *

* * @return 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. */ public String getMetricWidget() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMetricWidgetImageRequest withMetricWidget(String metricWidget) { setMetricWidget(metricWidget); return this; } /** *

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

* * @param 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. */ public void setOutputFormat(String outputFormat) { this.outputFormat = 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. *

* * @return 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. */ public String getOutputFormat() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public GetMetricWidgetImageRequest withOutputFormat(String outputFormat) { setOutputFormat(outputFormat); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getMetricWidget() != null) sb.append("MetricWidget: ").append(getMetricWidget()).append(","); if (getOutputFormat() != null) sb.append("OutputFormat: ").append(getOutputFormat()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetMetricWidgetImageRequest == false) return false; GetMetricWidgetImageRequest other = (GetMetricWidgetImageRequest) obj; if (other.getMetricWidget() == null ^ this.getMetricWidget() == null) return false; if (other.getMetricWidget() != null && other.getMetricWidget().equals(this.getMetricWidget()) == false) return false; if (other.getOutputFormat() == null ^ this.getOutputFormat() == null) return false; if (other.getOutputFormat() != null && other.getOutputFormat().equals(this.getOutputFormat()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getMetricWidget() == null) ? 0 : getMetricWidget().hashCode()); hashCode = prime * hashCode + ((getOutputFormat() == null) ? 0 : getOutputFormat().hashCode()); return hashCode; } @Override public GetMetricWidgetImageRequest clone() { return (GetMetricWidgetImageRequest) super.clone(); } }