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