/* * 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.lightsail.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 GetBucketMetricDataRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The name of the bucket for which to get metric data. *

*/ private String bucketName; /** *

* The metric for which you want to return information. *

* Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and * the published unit value. *

* *

* These bucket metrics are reported once per day. *

* *

*
* BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is calculated * by summing the size of all objects in the bucket (including object versions), including the size of all parts for * all incomplete multipart uploads to the bucket. *
*
* Statistics: The most useful statistic is Maximum. *
*
* Unit: The published unit is Bytes. *
*
*
* NumberOfObjects - The total number of objects stored in a bucket. This value is calculated * by counting all objects in the bucket (including object versions) and the total number of parts for all * incomplete multipart uploads to the bucket. *
*
* Statistics: The most useful statistic is Average. *
*
* Unit: The published unit is Count. *
*

*/ private String metricName; /** *

* The timestamp indicating the earliest data to be returned. *

*/ private java.util.Date startTime; /** *

* The timestamp indicating the latest data to be returned. *

*/ private java.util.Date endTime; /** *

* The granularity, in seconds, of the returned data points. *

* *

* Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which * is the number of seconds in a day. *

* */ private Integer period; /** *

* The statistic for the metric. *

* The following statistics are available: *

*
* Minimum - The lowest value observed during the specified period. Use this value to determine low * volumes of activity for your application. *
*
*
* Maximum - The highest value observed during the specified period. Use this value to determine high * volumes of activity for your application. *
*
*
* Sum - The sum of all values submitted for the matching metric. You can use this statistic to * determine the total volume of a metric. *
*
*
* Average - The value of Sum / SampleCount during the specified period. By * comparing this statistic with the Minimum and Maximum values, you can determine the * full scope of a metric and how close the average use is to the Minimum and Maximum * values. This comparison helps you to know when to increase or decrease your resources. *
*
*
* SampleCount - The count, or number, of data points used for the statistical calculation. *
*

*/ private java.util.List statistics; /** *

* The unit for the metric data request. *

* Valid units depend on the metric data being requested. For the valid units with each available metric, see the * metricName parameter. *

*/ private String unit; /** *

* The name of the bucket for which to get metric data. *

* * @param bucketName * The name of the bucket for which to get metric data. */ public void setBucketName(String bucketName) { this.bucketName = bucketName; } /** *

* The name of the bucket for which to get metric data. *

* * @return The name of the bucket for which to get metric data. */ public String getBucketName() { return this.bucketName; } /** *

* The name of the bucket for which to get metric data. *

* * @param bucketName * The name of the bucket for which to get metric data. * @return Returns a reference to this object so that method calls can be chained together. */ public GetBucketMetricDataRequest withBucketName(String bucketName) { setBucketName(bucketName); return this; } /** *

* The metric for which you want to return information. *

* Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and * the published unit value. *

* *

* These bucket metrics are reported once per day. *

* *

*
* BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is calculated * by summing the size of all objects in the bucket (including object versions), including the size of all parts for * all incomplete multipart uploads to the bucket. *
*
* Statistics: The most useful statistic is Maximum. *
*
* Unit: The published unit is Bytes. *
*
*
* NumberOfObjects - The total number of objects stored in a bucket. This value is calculated * by counting all objects in the bucket (including object versions) and the total number of parts for all * incomplete multipart uploads to the bucket. *
*
* Statistics: The most useful statistic is Average. *
*
* Unit: The published unit is Count. *
*

* * @param metricName * The metric for which you want to return information.

* Valid bucket metric names are listed below, along with the most useful statistics to include in your * request, and the published unit value. *

* *

* These bucket metrics are reported once per day. *

* *

*
* BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is * calculated by summing the size of all objects in the bucket (including object versions), including the * size of all parts for all incomplete multipart uploads to the bucket. *
*
* Statistics: The most useful statistic is Maximum. *
*
* Unit: The published unit is Bytes. *
*
*
* NumberOfObjects - The total number of objects stored in a bucket. This value is * calculated by counting all objects in the bucket (including object versions) and the total number of parts * for all incomplete multipart uploads to the bucket. *
*
* Statistics: The most useful statistic is Average. *
*
* Unit: The published unit is Count. *
*

* The metric for which you want to return information. *

* Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and * the published unit value. *

* These bucket metrics are reported once per day. *

*
* BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is calculated * by summing the size of all objects in the bucket (including object versions), including the size of all parts for * all incomplete multipart uploads to the bucket. *
*
* Statistics: The most useful statistic is Maximum. *
*
* Unit: The published unit is Bytes. *
*
*
* NumberOfObjects - The total number of objects stored in a bucket. This value is calculated * by counting all objects in the bucket (including object versions) and the total number of parts for all * incomplete multipart uploads to the bucket. *
*
* Statistics: The most useful statistic is Average. *
*
* Unit: The published unit is Count. *
*

* Valid bucket metric names are listed below, along with the most useful statistics to include in your * request, and the published unit value. *

* These bucket metrics are reported once per day. *

*
* BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is * calculated by summing the size of all objects in the bucket (including object versions), including the * size of all parts for all incomplete multipart uploads to the bucket. *
*
* Statistics: The most useful statistic is Maximum. *
*
* Unit: The published unit is Bytes. *
*
*
* NumberOfObjects - The total number of objects stored in a bucket. This value is * calculated by counting all objects in the bucket (including object versions) and the total number of * parts for all incomplete multipart uploads to the bucket. *
*
* Statistics: The most useful statistic is Average. *
*
* Unit: The published unit is Count. *
*

* The metric for which you want to return information. *

* Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and * the published unit value. *

* These bucket metrics are reported once per day. *

*
* BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is calculated * by summing the size of all objects in the bucket (including object versions), including the size of all parts for * all incomplete multipart uploads to the bucket. *
*
* Statistics: The most useful statistic is Maximum. *
*
* Unit: The published unit is Bytes. *
*
*
* NumberOfObjects - The total number of objects stored in a bucket. This value is calculated * by counting all objects in the bucket (including object versions) and the total number of parts for all * incomplete multipart uploads to the bucket. *
*
* Statistics: The most useful statistic is Average. *
*
* Unit: The published unit is Count. *
*

* Valid bucket metric names are listed below, along with the most useful statistics to include in your * request, and the published unit value. *

* These bucket metrics are reported once per day. *

*
* BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is * calculated by summing the size of all objects in the bucket (including object versions), including the * size of all parts for all incomplete multipart uploads to the bucket. *
*
* Statistics: The most useful statistic is Maximum. *
*
* Unit: The published unit is Bytes. *
*
*
* NumberOfObjects - The total number of objects stored in a bucket. This value is * calculated by counting all objects in the bucket (including object versions) and the total number of parts * for all incomplete multipart uploads to the bucket. *
*
* Statistics: The most useful statistic is Average. *
*
* Unit: The published unit is Count. *
*

* The metric for which you want to return information. *

* Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and * the published unit value. *

* These bucket metrics are reported once per day. *

*
* BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is calculated * by summing the size of all objects in the bucket (including object versions), including the size of all parts for * all incomplete multipart uploads to the bucket. *
*
* Statistics: The most useful statistic is Maximum. *
*
* Unit: The published unit is Bytes. *
*
*
* NumberOfObjects - The total number of objects stored in a bucket. This value is calculated * by counting all objects in the bucket (including object versions) and the total number of parts for all * incomplete multipart uploads to the bucket. *
*
* Statistics: The most useful statistic is Average. *
*
* Unit: The published unit is Count. *
*

* Valid bucket metric names are listed below, along with the most useful statistics to include in your * request, and the published unit value. *

* These bucket metrics are reported once per day. *

*
* BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is * calculated by summing the size of all objects in the bucket (including object versions), including the * size of all parts for all incomplete multipart uploads to the bucket. *
*
* Statistics: The most useful statistic is Maximum. *
*
* Unit: The published unit is Bytes. *
*
*
* NumberOfObjects - The total number of objects stored in a bucket. This value is * calculated by counting all objects in the bucket (including object versions) and the total number of parts * for all incomplete multipart uploads to the bucket. *
*
* Statistics: The most useful statistic is Average. *
*
* Unit: The published unit is Count. *
*

* The timestamp indicating the earliest data to be returned. *

* The timestamp indicating the latest data to be returned. *

* The granularity, in seconds, of the returned data points. *

* Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which * is the number of seconds in a day. *

* Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, * which is the number of seconds in a day. *

*/ public void setPeriod(Integer period) { this.period = period; } /** *

* The granularity, in seconds, of the returned data points. *

* *

* Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which * is the number of seconds in a day. *

* * * @return The granularity, in seconds, of the returned data points.

* Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 * seconds, which is the number of seconds in a day. *

*/ public Integer getPeriod() { return this.period; } /** *

* The granularity, in seconds, of the returned data points. *

* *

* Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which * is the number of seconds in a day. *

* * * @param period * The granularity, in seconds, of the returned data points.

* Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, * which is the number of seconds in a day. *

* @return Returns a reference to this object so that method calls can be chained together. */ public GetBucketMetricDataRequest withPeriod(Integer period) { setPeriod(period); return this; } /** *

* The statistic for the metric. *

* The following statistics are available: *

*
* Minimum - The lowest value observed during the specified period. Use this value to determine low * volumes of activity for your application. *
*
*
* Maximum - The highest value observed during the specified period. Use this value to determine high * volumes of activity for your application. *
*
*
* Sum - The sum of all values submitted for the matching metric. You can use this statistic to * determine the total volume of a metric. *
*
*
* Average - The value of Sum / SampleCount during the specified period. By * comparing this statistic with the Minimum and Maximum values, you can determine the * full scope of a metric and how close the average use is to the Minimum and Maximum * values. This comparison helps you to know when to increase or decrease your resources. *
*
*
* SampleCount - The count, or number, of data points used for the statistical calculation. *
*

* * @return The statistic for the metric.

* The following statistics are available: *

*
* Minimum - The lowest value observed during the specified period. Use this value to determine * low volumes of activity for your application. *
*
*
* Maximum - The highest value observed during the specified period. Use this value to * determine high volumes of activity for your application. *
*
*
* Sum - The sum of all values submitted for the matching metric. You can use this statistic to * determine the total volume of a metric. *
*
*
* Average - The value of Sum / SampleCount during the specified * period. By comparing this statistic with the Minimum and Maximum values, you * can determine the full scope of a metric and how close the average use is to the Minimum and * Maximum values. This comparison helps you to know when to increase or decrease your * resources. *
*
*
* SampleCount - The count, or number, of data points used for the statistical calculation. *
*

getStatistics() { return statistics; } /** *

* The statistic for the metric. *

* The following statistics are available: *

*
* Minimum - The lowest value observed during the specified period. Use this value to determine low * volumes of activity for your application. *
*
*
* Maximum - The highest value observed during the specified period. Use this value to determine high * volumes of activity for your application. *
*
*
* Sum - The sum of all values submitted for the matching metric. You can use this statistic to * determine the total volume of a metric. *
*
*
* Average - The value of Sum / SampleCount during the specified period. By * comparing this statistic with the Minimum and Maximum values, you can determine the * full scope of a metric and how close the average use is to the Minimum and Maximum * values. This comparison helps you to know when to increase or decrease your resources. *
*
*
* SampleCount - The count, or number, of data points used for the statistical calculation. *
*

* * @param statistics * The statistic for the metric.

* The following statistics are available: *

*
* Minimum - The lowest value observed during the specified period. Use this value to determine * low volumes of activity for your application. *
*
*
* Maximum - The highest value observed during the specified period. Use this value to determine * high volumes of activity for your application. *
*
*
* Sum - The sum of all values submitted for the matching metric. You can use this statistic to * determine the total volume of a metric. *
*
*
* Average - The value of Sum / SampleCount during the specified * period. By comparing this statistic with the Minimum and Maximum values, you can * determine the full scope of a metric and how close the average use is to the Minimum and * Maximum values. This comparison helps you to know when to increase or decrease your * resources. *
*
*
* SampleCount - The count, or number, of data points used for the statistical calculation. *
*

statistics) { if (statistics == null) { this.statistics = null; return; } this.statistics = new java.util.ArrayList(statistics); } /** *

* The statistic for the metric. *

* The following statistics are available: *

*
* Minimum - The lowest value observed during the specified period. Use this value to determine low * volumes of activity for your application. *
*
*
* Maximum - The highest value observed during the specified period. Use this value to determine high * volumes of activity for your application. *
*
*
* Sum - The sum of all values submitted for the matching metric. You can use this statistic to * determine the total volume of a metric. *
*
*
* Average - The value of Sum / SampleCount during the specified period. By * comparing this statistic with the Minimum and Maximum values, you can determine the * full scope of a metric and how close the average use is to the Minimum and Maximum * values. This comparison helps you to know when to increase or decrease your resources. *
*
*
* SampleCount - The count, or number, of data points used for the statistical calculation. *
*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setStatistics(java.util.Collection)} or {@link #withStatistics(java.util.Collection)} if you want to * override the existing values. *

* * @param statistics * The statistic for the metric.

* The following statistics are available: *

*
* Minimum - The lowest value observed during the specified period. Use this value to determine * low volumes of activity for your application. *
*
*
* Maximum - The highest value observed during the specified period. Use this value to determine * high volumes of activity for your application. *
*
*
* Sum - The sum of all values submitted for the matching metric. You can use this statistic to * determine the total volume of a metric. *
*
*
* Average - The value of Sum / SampleCount during the specified * period. By comparing this statistic with the Minimum and Maximum values, you can * determine the full scope of a metric and how close the average use is to the Minimum and * Maximum values. This comparison helps you to know when to increase or decrease your * resources. *
*
*
* SampleCount - The count, or number, of data points used for the statistical calculation. *
*

(statistics.length)); } for (String ele : statistics) { this.statistics.add(ele); } return this; } /** *

* The statistic for the metric. *

* The following statistics are available: *

*
* Minimum - The lowest value observed during the specified period. Use this value to determine low * volumes of activity for your application. *
*
*
* Maximum - The highest value observed during the specified period. Use this value to determine high * volumes of activity for your application. *
*
*
* Sum - The sum of all values submitted for the matching metric. You can use this statistic to * determine the total volume of a metric. *
*
*
* Average - The value of Sum / SampleCount during the specified period. By * comparing this statistic with the Minimum and Maximum values, you can determine the * full scope of a metric and how close the average use is to the Minimum and Maximum * values. This comparison helps you to know when to increase or decrease your resources. *
*
*
* SampleCount - The count, or number, of data points used for the statistical calculation. *
*

* * @param statistics * The statistic for the metric.

* The following statistics are available: *

*
* Minimum - The lowest value observed during the specified period. Use this value to determine * low volumes of activity for your application. *
*
*
* Maximum - The highest value observed during the specified period. Use this value to determine * high volumes of activity for your application. *
*
*
* Sum - The sum of all values submitted for the matching metric. You can use this statistic to * determine the total volume of a metric. *
*
*
* Average - The value of Sum / SampleCount during the specified * period. By comparing this statistic with the Minimum and Maximum values, you can * determine the full scope of a metric and how close the average use is to the Minimum and * Maximum values. This comparison helps you to know when to increase or decrease your * resources. *
*
*
* SampleCount - The count, or number, of data points used for the statistical calculation. *
*

statistics) { setStatistics(statistics); return this; } /** *

* The statistic for the metric. *

* The following statistics are available: *

*
* Minimum - The lowest value observed during the specified period. Use this value to determine low * volumes of activity for your application. *
*
*
* Maximum - The highest value observed during the specified period. Use this value to determine high * volumes of activity for your application. *
*
*
* Sum - The sum of all values submitted for the matching metric. You can use this statistic to * determine the total volume of a metric. *
*
*
* Average - The value of Sum / SampleCount during the specified period. By * comparing this statistic with the Minimum and Maximum values, you can determine the * full scope of a metric and how close the average use is to the Minimum and Maximum * values. This comparison helps you to know when to increase or decrease your resources. *
*
*
* SampleCount - The count, or number, of data points used for the statistical calculation. *
*

* * @param statistics * The statistic for the metric.

* The following statistics are available: *

*
* Minimum - The lowest value observed during the specified period. Use this value to determine * low volumes of activity for your application. *
*
*
* Maximum - The highest value observed during the specified period. Use this value to determine * high volumes of activity for your application. *
*
*
* Sum - The sum of all values submitted for the matching metric. You can use this statistic to * determine the total volume of a metric. *
*
*
* Average - The value of Sum / SampleCount during the specified * period. By comparing this statistic with the Minimum and Maximum values, you can * determine the full scope of a metric and how close the average use is to the Minimum and * Maximum values. This comparison helps you to know when to increase or decrease your * resources. *
*
*
* SampleCount - The count, or number, of data points used for the statistical calculation. *
*

statisticsCopy = new java.util.ArrayList(statistics.length); for (MetricStatistic value : statistics) { statisticsCopy.add(value.toString()); } if (getStatistics() == null) { setStatistics(statisticsCopy); } else { getStatistics().addAll(statisticsCopy); } return this; } /** *

* The unit for the metric data request. *

* Valid units depend on the metric data being requested. For the valid units with each available metric, see the * metricName parameter. *

* * @param unit * The unit for the metric data request.

* Valid units depend on the metric data being requested. For the valid units with each available metric, see * the metricName parameter. * @see MetricUnit */ public void setUnit(String unit) { this.unit = unit; } /** *

* The unit for the metric data request. *

* Valid units depend on the metric data being requested. For the valid units with each available metric, see the * metricName parameter. *

* * @return The unit for the metric data request.

* Valid units depend on the metric data being requested. For the valid units with each available metric, * see the metricName parameter. * @see MetricUnit */ public String getUnit() { return this.unit; } /** *

* The unit for the metric data request. *

* Valid units depend on the metric data being requested. For the valid units with each available metric, see the * metricName parameter. *

* * @param unit * The unit for the metric data request.

* The unit for the metric data request. *

* Valid units depend on the metric data being requested. For the valid units with each available metric, see the * metricName parameter. *

* * @param unit * The unit for the metric data request.

* Valid units depend on the metric data being requested. For the valid units with each available metric, see * the metricName parameter. * @return Returns a reference to this object so that method calls can be chained together. * @see MetricUnit */ public GetBucketMetricDataRequest withUnit(MetricUnit unit) { this.unit = unit.toString(); 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 (getBucketName() != null) sb.append("BucketName: ").append(getBucketName()).append(","); if (getMetricName() != null) sb.append("MetricName: ").append(getMetricName()).append(","); if (getStartTime() != null) sb.append("StartTime: ").append(getStartTime()).append(","); if (getEndTime() != null) sb.append("EndTime: ").append(getEndTime()).append(","); if (getPeriod() != null) sb.append("Period: ").append(getPeriod()).append(","); if (getStatistics() != null) sb.append("Statistics: ").append(getStatistics()).append(","); if (getUnit() != null) sb.append("Unit: ").append(getUnit()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetBucketMetricDataRequest == false) return false; GetBucketMetricDataRequest other = (GetBucketMetricDataRequest) obj; if (other.getBucketName() == null ^ this.getBucketName() == null) return false; if (other.getBucketName() != null && other.getBucketName().equals(this.getBucketName()) == false) return false; if (other.getMetricName() == null ^ this.getMetricName() == null) return false; if (other.getMetricName() != null && other.getMetricName().equals(this.getMetricName()) == false) return false; if (other.getStartTime() == null ^ this.getStartTime() == null) return false; if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == false) return false; if (other.getEndTime() == null ^ this.getEndTime() == null) return false; if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == false) return false; if (other.getPeriod() == null ^ this.getPeriod() == null) return false; if (other.getPeriod() != null && other.getPeriod().equals(this.getPeriod()) == false) return false; if (other.getStatistics() == null ^ this.getStatistics() == null) return false; if (other.getStatistics() != null && other.getStatistics().equals(this.getStatistics()) == false) return false; if (other.getUnit() == null ^ this.getUnit() == null) return false; if (other.getUnit() != null && other.getUnit().equals(this.getUnit()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getBucketName() == null) ? 0 : getBucketName().hashCode()); hashCode = prime * hashCode + ((getMetricName() == null) ? 0 : getMetricName().hashCode()); hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode()); hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode()); hashCode = prime * hashCode + ((getPeriod() == null) ? 0 : getPeriod().hashCode()); hashCode = prime * hashCode + ((getStatistics() == null) ? 0 : getStatistics().hashCode()); hashCode = prime * hashCode + ((getUnit() == null) ? 0 : getUnit().hashCode()); return hashCode; } @Override public GetBucketMetricDataRequest clone() { return (GetBucketMetricDataRequest) super.clone(); } }