com.amazonaws.services.lightsail.model.GetDistributionMetricDataRequest Maven / Gradle / Ivy
/*
* 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 GetDistributionMetricDataRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the distribution for which to get metric data.
*
*
* Use the GetDistributions action to get a list of distribution names that you can specify.
*
*/
private String distributionName;
/**
*
* The metric for which you want to return information.
*
*
* Valid distribution metric names are listed below, along with the most useful statistics to include
* in your request, and the published unit value.
*
*
* -
*
* Requests - The total number of viewer requests received by your Lightsail distribution, for
* all HTTP methods, and for both HTTP and HTTPS requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS
* requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* BytesUploaded - The number of bytes uploaded to your origin by your Lightsail
* distribution, using POST and PUT requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* TotalErrorRate - The percentage of all viewer requests for which the response's HTTP status
* code was 4xx or 5xx.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* -
*
* 4xxErrorRate - The percentage of all viewer requests for which the response's HTTP status
* cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of
* 404 (Not Found) means that the client requested an object that could not be found.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* -
*
* 5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status
* code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503
* (Service Unavailable) means that the origin server is currently unavailable.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
*
*/
private String metricName;
/**
*
* The start of the time interval for which to get metric data.
*
*
* Constraints:
*
*
* -
*
* Specified in Coordinated Universal Time (UTC).
*
*
* -
*
* Specified in the Unix time format.
*
*
* For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as
* the start time.
*
*
*
*
* You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
*
*/
private java.util.Date startTime;
/**
*
* The end of the time interval for which to get metric data.
*
*
* Constraints:
*
*
* -
*
* Specified in Coordinated Universal Time (UTC).
*
*
* -
*
* Specified in the Unix time format.
*
*
* For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as
* the end time.
*
*
*
*
* You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
*
*/
private java.util.Date endTime;
/**
*
* The granularity, in seconds, for the metric data points that will be returned.
*
*/
private Integer period;
/**
*
* 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 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 - All values submitted for the matching metric added together. 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 name of the distribution for which to get metric data.
*
*
* Use the GetDistributions action to get a list of distribution names that you can specify.
*
*
* @param distributionName
* The name of the distribution for which to get metric data.
*
* Use the GetDistributions action to get a list of distribution names that you can specify.
*/
public void setDistributionName(String distributionName) {
this.distributionName = distributionName;
}
/**
*
* The name of the distribution for which to get metric data.
*
*
* Use the GetDistributions action to get a list of distribution names that you can specify.
*
*
* @return The name of the distribution for which to get metric data.
*
* Use the GetDistributions action to get a list of distribution names that you can specify.
*/
public String getDistributionName() {
return this.distributionName;
}
/**
*
* The name of the distribution for which to get metric data.
*
*
* Use the GetDistributions action to get a list of distribution names that you can specify.
*
*
* @param distributionName
* The name of the distribution for which to get metric data.
*
* Use the GetDistributions action to get a list of distribution names that you can specify.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDistributionMetricDataRequest withDistributionName(String distributionName) {
setDistributionName(distributionName);
return this;
}
/**
*
* The metric for which you want to return information.
*
*
* Valid distribution metric names are listed below, along with the most useful statistics to include
* in your request, and the published unit value.
*
*
* -
*
* Requests - The total number of viewer requests received by your Lightsail distribution, for
* all HTTP methods, and for both HTTP and HTTPS requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS
* requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* BytesUploaded - The number of bytes uploaded to your origin by your Lightsail
* distribution, using POST and PUT requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* TotalErrorRate - The percentage of all viewer requests for which the response's HTTP status
* code was 4xx or 5xx.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* -
*
* 4xxErrorRate - The percentage of all viewer requests for which the response's HTTP status
* cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of
* 404 (Not Found) means that the client requested an object that could not be found.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* -
*
* 5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status
* code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503
* (Service Unavailable) means that the origin server is currently unavailable.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
*
*
* @param metricName
* The metric for which you want to return information.
*
* Valid distribution metric names are listed below, along with the most useful statistics to
* include in your request, and the published unit value.
*
*
* -
*
* Requests - The total number of viewer requests received by your Lightsail
* distribution, for all HTTP methods, and for both HTTP and HTTPS requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and
* OPTIONS requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* BytesUploaded - The number of bytes uploaded to your origin by your Lightsail
* distribution, using POST and PUT requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* TotalErrorRate - The percentage of all viewer requests for which the response's HTTP
* status code was 4xx or 5xx.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* -
*
* 4xxErrorRate - The percentage of all viewer requests for which the response's HTTP
* status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a
* status code of 404 (Not Found) means that the client requested an object that could not be found.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* -
*
* 5xxErrorRate - The percentage of all viewer requests for which the response's HTTP
* status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status
* code of 503 (Service Unavailable) means that the origin server is currently unavailable.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* @see DistributionMetricName
*/
public void setMetricName(String metricName) {
this.metricName = metricName;
}
/**
*
* The metric for which you want to return information.
*
*
* Valid distribution metric names are listed below, along with the most useful statistics to include
* in your request, and the published unit value.
*
*
* -
*
* Requests - The total number of viewer requests received by your Lightsail distribution, for
* all HTTP methods, and for both HTTP and HTTPS requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS
* requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* BytesUploaded - The number of bytes uploaded to your origin by your Lightsail
* distribution, using POST and PUT requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* TotalErrorRate - The percentage of all viewer requests for which the response's HTTP status
* code was 4xx or 5xx.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* -
*
* 4xxErrorRate - The percentage of all viewer requests for which the response's HTTP status
* cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of
* 404 (Not Found) means that the client requested an object that could not be found.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* -
*
* 5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status
* code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503
* (Service Unavailable) means that the origin server is currently unavailable.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
*
*
* @return The metric for which you want to return information.
*
* Valid distribution metric names are listed below, along with the most useful statistics to
* include in your request, and the published unit value.
*
*
* -
*
* Requests - The total number of viewer requests received by your Lightsail
* distribution, for all HTTP methods, and for both HTTP and HTTPS requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and
* OPTIONS requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* BytesUploaded - The number of bytes uploaded to your origin by your Lightsail
* distribution, using POST and PUT requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* TotalErrorRate - The percentage of all viewer requests for which the response's
* HTTP status code was 4xx or 5xx.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* -
*
* 4xxErrorRate - The percentage of all viewer requests for which the response's HTTP
* status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a
* status code of 404 (Not Found) means that the client requested an object that could not be found.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* -
*
* 5xxErrorRate - The percentage of all viewer requests for which the response's HTTP
* status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a
* status code of 503 (Service Unavailable) means that the origin server is currently unavailable.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* @see DistributionMetricName
*/
public String getMetricName() {
return this.metricName;
}
/**
*
* The metric for which you want to return information.
*
*
* Valid distribution metric names are listed below, along with the most useful statistics to include
* in your request, and the published unit value.
*
*
* -
*
* Requests - The total number of viewer requests received by your Lightsail distribution, for
* all HTTP methods, and for both HTTP and HTTPS requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS
* requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* BytesUploaded - The number of bytes uploaded to your origin by your Lightsail
* distribution, using POST and PUT requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* TotalErrorRate - The percentage of all viewer requests for which the response's HTTP status
* code was 4xx or 5xx.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* -
*
* 4xxErrorRate - The percentage of all viewer requests for which the response's HTTP status
* cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of
* 404 (Not Found) means that the client requested an object that could not be found.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* -
*
* 5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status
* code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503
* (Service Unavailable) means that the origin server is currently unavailable.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
*
*
* @param metricName
* The metric for which you want to return information.
*
* Valid distribution metric names are listed below, along with the most useful statistics to
* include in your request, and the published unit value.
*
*
* -
*
* Requests - The total number of viewer requests received by your Lightsail
* distribution, for all HTTP methods, and for both HTTP and HTTPS requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and
* OPTIONS requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* BytesUploaded - The number of bytes uploaded to your origin by your Lightsail
* distribution, using POST and PUT requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* TotalErrorRate - The percentage of all viewer requests for which the response's HTTP
* status code was 4xx or 5xx.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* -
*
* 4xxErrorRate - The percentage of all viewer requests for which the response's HTTP
* status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a
* status code of 404 (Not Found) means that the client requested an object that could not be found.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* -
*
* 5xxErrorRate - The percentage of all viewer requests for which the response's HTTP
* status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status
* code of 503 (Service Unavailable) means that the origin server is currently unavailable.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see DistributionMetricName
*/
public GetDistributionMetricDataRequest withMetricName(String metricName) {
setMetricName(metricName);
return this;
}
/**
*
* The metric for which you want to return information.
*
*
* Valid distribution metric names are listed below, along with the most useful statistics to include
* in your request, and the published unit value.
*
*
* -
*
* Requests - The total number of viewer requests received by your Lightsail distribution, for
* all HTTP methods, and for both HTTP and HTTPS requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS
* requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* BytesUploaded - The number of bytes uploaded to your origin by your Lightsail
* distribution, using POST and PUT requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* TotalErrorRate - The percentage of all viewer requests for which the response's HTTP status
* code was 4xx or 5xx.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* -
*
* 4xxErrorRate - The percentage of all viewer requests for which the response's HTTP status
* cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of
* 404 (Not Found) means that the client requested an object that could not be found.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* -
*
* 5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status
* code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503
* (Service Unavailable) means that the origin server is currently unavailable.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
*
*
* @param metricName
* The metric for which you want to return information.
*
* Valid distribution metric names are listed below, along with the most useful statistics to
* include in your request, and the published unit value.
*
*
* -
*
* Requests - The total number of viewer requests received by your Lightsail
* distribution, for all HTTP methods, and for both HTTP and HTTPS requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and
* OPTIONS requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* BytesUploaded - The number of bytes uploaded to your origin by your Lightsail
* distribution, using POST and PUT requests.
*
*
* Statistics: The most useful statistic is Sum.
*
*
* Unit: The published unit is None.
*
*
* -
*
* TotalErrorRate - The percentage of all viewer requests for which the response's HTTP
* status code was 4xx or 5xx.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* -
*
* 4xxErrorRate - The percentage of all viewer requests for which the response's HTTP
* status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a
* status code of 404 (Not Found) means that the client requested an object that could not be found.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* -
*
* 5xxErrorRate - The percentage of all viewer requests for which the response's HTTP
* status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status
* code of 503 (Service Unavailable) means that the origin server is currently unavailable.
*
*
* Statistics: The most useful statistic is Average.
*
*
* Unit: The published unit is Percent.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see DistributionMetricName
*/
public GetDistributionMetricDataRequest withMetricName(DistributionMetricName metricName) {
this.metricName = metricName.toString();
return this;
}
/**
*
* The start of the time interval for which to get metric data.
*
*
* Constraints:
*
*
* -
*
* Specified in Coordinated Universal Time (UTC).
*
*
* -
*
* Specified in the Unix time format.
*
*
* For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as
* the start time.
*
*
*
*
* You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
*
*
* @param startTime
* The start of the time interval for which to get metric data.
*
* Constraints:
*
*
* -
*
* Specified in Coordinated Universal Time (UTC).
*
*
* -
*
* Specified in the Unix time format.
*
*
* For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify
* 1538424000 as the start time.
*
*
*
*
* You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
*/
public void setStartTime(java.util.Date startTime) {
this.startTime = startTime;
}
/**
*
* The start of the time interval for which to get metric data.
*
*
* Constraints:
*
*
* -
*
* Specified in Coordinated Universal Time (UTC).
*
*
* -
*
* Specified in the Unix time format.
*
*
* For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as
* the start time.
*
*
*
*
* You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
*
*
* @return The start of the time interval for which to get metric data.
*
* Constraints:
*
*
* -
*
* Specified in Coordinated Universal Time (UTC).
*
*
* -
*
* Specified in the Unix time format.
*
*
* For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify
* 1538424000 as the start time.
*
*
*
*
* You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
*/
public java.util.Date getStartTime() {
return this.startTime;
}
/**
*
* The start of the time interval for which to get metric data.
*
*
* Constraints:
*
*
* -
*
* Specified in Coordinated Universal Time (UTC).
*
*
* -
*
* Specified in the Unix time format.
*
*
* For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as
* the start time.
*
*
*
*
* You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
*
*
* @param startTime
* The start of the time interval for which to get metric data.
*
* Constraints:
*
*
* -
*
* Specified in Coordinated Universal Time (UTC).
*
*
* -
*
* Specified in the Unix time format.
*
*
* For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify
* 1538424000 as the start time.
*
*
*
*
* You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDistributionMetricDataRequest withStartTime(java.util.Date startTime) {
setStartTime(startTime);
return this;
}
/**
*
* The end of the time interval for which to get metric data.
*
*
* Constraints:
*
*
* -
*
* Specified in Coordinated Universal Time (UTC).
*
*
* -
*
* Specified in the Unix time format.
*
*
* For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as
* the end time.
*
*
*
*
* You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
*
*
* @param endTime
* The end of the time interval for which to get metric data.
*
* Constraints:
*
*
* -
*
* Specified in Coordinated Universal Time (UTC).
*
*
* -
*
* Specified in the Unix time format.
*
*
* For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify
* 1538427600 as the end time.
*
*
*
*
* You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
*/
public void setEndTime(java.util.Date endTime) {
this.endTime = endTime;
}
/**
*
* The end of the time interval for which to get metric data.
*
*
* Constraints:
*
*
* -
*
* Specified in Coordinated Universal Time (UTC).
*
*
* -
*
* Specified in the Unix time format.
*
*
* For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as
* the end time.
*
*
*
*
* You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
*
*
* @return The end of the time interval for which to get metric data.
*
* Constraints:
*
*
* -
*
* Specified in Coordinated Universal Time (UTC).
*
*
* -
*
* Specified in the Unix time format.
*
*
* For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify
* 1538427600 as the end time.
*
*
*
*
* You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
*/
public java.util.Date getEndTime() {
return this.endTime;
}
/**
*
* The end of the time interval for which to get metric data.
*
*
* Constraints:
*
*
* -
*
* Specified in Coordinated Universal Time (UTC).
*
*
* -
*
* Specified in the Unix time format.
*
*
* For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as
* the end time.
*
*
*
*
* You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
*
*
* @param endTime
* The end of the time interval for which to get metric data.
*
* Constraints:
*
*
* -
*
* Specified in Coordinated Universal Time (UTC).
*
*
* -
*
* Specified in the Unix time format.
*
*
* For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify
* 1538427600 as the end time.
*
*
*
*
* You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDistributionMetricDataRequest withEndTime(java.util.Date endTime) {
setEndTime(endTime);
return this;
}
/**
*
* The granularity, in seconds, for the metric data points that will be returned.
*
*
* @param period
* The granularity, in seconds, for the metric data points that will be returned.
*/
public void setPeriod(Integer period) {
this.period = period;
}
/**
*
* The granularity, in seconds, for the metric data points that will be returned.
*
*
* @return The granularity, in seconds, for the metric data points that will be returned.
*/
public Integer getPeriod() {
return this.period;
}
/**
*
* The granularity, in seconds, for the metric data points that will be returned.
*
*
* @param period
* The granularity, in seconds, for the metric data points that will be returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDistributionMetricDataRequest withPeriod(Integer period) {
setPeriod(period);
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.
*
* 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 GetDistributionMetricDataRequest withUnit(String unit) {
setUnit(unit);
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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetricUnit
*/
public GetDistributionMetricDataRequest withUnit(MetricUnit unit) {
this.unit = unit.toString();
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 - All values submitted for the matching metric added together. 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 - All values submitted for the matching metric added together. 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.
*
*
* @see MetricStatistic
*/
public java.util.List 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 - All values submitted for the matching metric added together. 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 - All values submitted for the matching metric added together. 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.
*
*
* @see MetricStatistic
*/
public void setStatistics(java.util.Collection 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 - All values submitted for the matching metric added together. 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 - All values submitted for the matching metric added together. 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 Returns a reference to this object so that method calls can be chained together.
* @see MetricStatistic
*/
public GetDistributionMetricDataRequest withStatistics(String... statistics) {
if (this.statistics == null) {
setStatistics(new java.util.ArrayList(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 - All values submitted for the matching metric added together. 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 - All values submitted for the matching metric added together. 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 Returns a reference to this object so that method calls can be chained together.
* @see MetricStatistic
*/
public GetDistributionMetricDataRequest withStatistics(java.util.Collection 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 - All values submitted for the matching metric added together. 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 - All values submitted for the matching metric added together. 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 Returns a reference to this object so that method calls can be chained together.
* @see MetricStatistic
*/
public GetDistributionMetricDataRequest withStatistics(MetricStatistic... statistics) {
java.util.ArrayList 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;
}
/**
* 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 (getDistributionName() != null)
sb.append("DistributionName: ").append(getDistributionName()).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 (getUnit() != null)
sb.append("Unit: ").append(getUnit()).append(",");
if (getStatistics() != null)
sb.append("Statistics: ").append(getStatistics());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetDistributionMetricDataRequest == false)
return false;
GetDistributionMetricDataRequest other = (GetDistributionMetricDataRequest) obj;
if (other.getDistributionName() == null ^ this.getDistributionName() == null)
return false;
if (other.getDistributionName() != null && other.getDistributionName().equals(this.getDistributionName()) == 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.getUnit() == null ^ this.getUnit() == null)
return false;
if (other.getUnit() != null && other.getUnit().equals(this.getUnit()) == false)
return false;
if (other.getStatistics() == null ^ this.getStatistics() == null)
return false;
if (other.getStatistics() != null && other.getStatistics().equals(this.getStatistics()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDistributionName() == null) ? 0 : getDistributionName().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 + ((getUnit() == null) ? 0 : getUnit().hashCode());
hashCode = prime * hashCode + ((getStatistics() == null) ? 0 : getStatistics().hashCode());
return hashCode;
}
@Override
public GetDistributionMetricDataRequest clone() {
return (GetDistributionMetricDataRequest) super.clone();
}
}