Package software.amazon.awssdk.services.lightsail.model

Class GetDistributionMetricDataRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lightsail.model.LightsailRequest

software.amazon.awssdk.services.lightsail.model.GetDistributionMetricDataRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDistributionMetricDataRequest.Builder,GetDistributionMetricDataRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetDistributionMetricDataRequest
extends LightsailRequest
implements ToCopyableBuilder<GetDistributionMetricDataRequest.Builder,GetDistributionMetricDataRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetDistributionMetricDataRequest.Builder

Method Summary

Modifier and Type	Method	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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStatistics()	For responses, this returns true if the service returned a value for the Statistics property.
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()
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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

distributionName

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.

Returns:

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.

metricName

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().

Returns:

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 Also:

DistributionMetricName

metricNameAsString

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().

Returns:

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 Also:

DistributionMetricName

startTime

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 human-friendly time to Unix time format using a converter like Epoch converter.

Returns:

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.

endTime

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 human-friendly time to Unix time format using a converter like Epoch converter.

Returns:

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.

period

public final Integer period()

The granularity, in seconds, for the metric data points that will be returned.

Returns:

The granularity, in seconds, for the metric data points that will be returned.

unit

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().

Returns:

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 Also:

MetricUnit

unitAsString

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().

Returns:

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 Also:

MetricUnit

statistics

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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStatistics() method.

Returns:

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.

hasStatistics

public final boolean hasStatistics()

For responses, this returns true if the service returned a value for the Statistics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

statisticsAsStrings

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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStatistics() method.

Returns:

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.

toBuilder

public GetDistributionMetricDataRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetDistributionMetricDataRequest.Builder,GetDistributionMetricDataRequest>

Specified by:

toBuilder in class LightsailRequest

builder

public static GetDistributionMetricDataRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetDistributionMetricDataRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo