@Generated(value="software.amazon.awssdk:codegen") public final class GetDistributionMetricDataRequest extends LightsailRequest implements ToCopyableBuilder<GetDistributionMetricDataRequest.Builder,GetDistributionMetricDataRequest>
Modifier and Type  Class and Description 

static interface 
GetDistributionMetricDataRequest.Builder 
Modifier and Type  Method and Description 

static GetDistributionMetricDataRequest.Builder 
builder() 
String 
distributionName()
The name of the distribution for which to get metric data.

Instant 
endTime()
The end of the time interval for which to get metric data.

boolean 
equals(Object obj) 
boolean 
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.

<T> Optional<T> 
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . 
int 
hashCode() 
boolean 
hasStatistics()
Returns true if the Statistics property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).

DistributionMetricName 
metricName()
The metric for which you want to return information.

String 
metricNameAsString()
The metric for which you want to return information.

Integer 
period()
The granularity, in seconds, for the metric data points that will be returned.

List<SdkField<?>> 
sdkFields() 
static Class<? extends GetDistributionMetricDataRequest.Builder> 
serializableBuilderClass() 
Instant 
startTime()
The start of the time interval for which to get metric data.

List<MetricStatistic> 
statistics()
The statistic for the metric.

List<String> 
statisticsAsStrings()
The statistic for the metric.

GetDistributionMetricDataRequest.Builder 
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.

String 
toString()
Returns a string representation of this object.

MetricUnit 
unit()
The unit for the metric data request.

String 
unitAsString()
The unit for the metric data request.

overrideConfiguration
copy
public final String 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 final DistributionMetricName 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
.
If the service returns an enum value that is not available in the current SDK version, metricName
will
return DistributionMetricName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from metricNameAsString()
.
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
.
DistributionMetricName
public final String metricNameAsString()
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
.
If the service returns an enum value that is not available in the current SDK version, metricName
will
return DistributionMetricName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from metricNameAsString()
.
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
.
DistributionMetricName
public final Instant 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 humanfriendly time to Unix time format using a converter like Epoch converter.
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 humanfriendly time to Unix time format using a converter like Epoch converter.
public final Instant 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 humanfriendly time to Unix time format using a converter like Epoch converter.
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 humanfriendly time to Unix time format using a converter like Epoch converter.
public final Integer period()
The granularity, in seconds, for the metric data points that will be returned.
public final MetricUnit 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.
If the service returns an enum value that is not available in the current SDK version, unit
will return
MetricUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
unitAsString()
.
Valid units depend on the metric data being requested. For the valid units with each available metric,
see the metricName
parameter.
MetricUnit
public final String unitAsString()
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.
If the service returns an enum value that is not available in the current SDK version, unit
will return
MetricUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
unitAsString()
.
Valid units depend on the metric data being requested. For the valid units with each available metric,
see the metricName
parameter.
MetricUnit
public final List<MetricStatistic> 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasStatistics()
to see if a value was sent in this field.
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.
public final boolean hasStatistics()
public final List<String> statisticsAsStrings()
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasStatistics()
to see if a value was sent in this field.
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.
public GetDistributionMetricDataRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetDistributionMetricDataRequest.Builder,GetDistributionMetricDataRequest>
toBuilder
in class LightsailRequest
public static GetDistributionMetricDataRequest.Builder builder()
public static Class<? extends GetDistributionMetricDataRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
 the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service2.json model specified in the
codegenresources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
 The name of the member to be retrieved.clazz
 The class to cast the returned object to.