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

Class GetContainerServiceMetricDataRequest

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.GetContainerServiceMetricDataRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetContainerServiceMetricDataRequest.Builder,GetContainerServiceMetricDataRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetContainerServiceMetricDataRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetContainerServiceMetricDataRequest.Builder	builder()
Instant	endTime()	The end time of the time period.
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.
ContainerServiceMetricName	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, of the returned data points.
List<SdkField<?>>	sdkFields()
static Class<? extends GetContainerServiceMetricDataRequest.Builder>	serializableBuilderClass()
String	serviceName()	The name of the container service for which to get metric data.
Instant	startTime()	The start time of the time period.
List<MetricStatistic>	statistics()	The statistic for the metric.
List<String>	statisticsAsStrings()	The statistic for the metric.
GetContainerServiceMetricDataRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

serviceName

public final String serviceName()

The name of the container service for which to get metric data.

Returns:

The name of the container service for which to get metric data.

metricName

public final ContainerServiceMetricName metricName()

The metric for which you want to return information.

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

• CPUUtilization - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service.

  Statistics: The most useful statistics are Maximum and Average.

  Unit: The published unit is Percent.

• MemoryUtilization - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service.

  Statistics: The most useful statistics are Maximum and 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 ContainerServiceMetricName.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 container service metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

• CPUUtilization - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service.

  Statistics: The most useful statistics are Maximum and Average.

  Unit: The published unit is Percent.

• MemoryUtilization - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service.

  Statistics: The most useful statistics are Maximum and Average.

  Unit: The published unit is Percent.

See Also:

ContainerServiceMetricName

metricNameAsString

public final String metricNameAsString()

The metric for which you want to return information.

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

• CPUUtilization - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service.

  Statistics: The most useful statistics are Maximum and Average.

  Unit: The published unit is Percent.

• MemoryUtilization - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service.

  Statistics: The most useful statistics are Maximum and 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 ContainerServiceMetricName.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 container service metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

• CPUUtilization - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service.

  Statistics: The most useful statistics are Maximum and Average.

  Unit: The published unit is Percent.

• MemoryUtilization - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service.

  Statistics: The most useful statistics are Maximum and Average.

  Unit: The published unit is Percent.

See Also:

ContainerServiceMetricName

startTime

public final Instant startTime()

The start time of the time period.

Returns:

The start time of the time period.

endTime

public final Instant endTime()

The end time of the time period.

Returns:

The end time of the time period.

period

public final Integer period()

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

All container service metric data is available in 5-minute (300 seconds) granularity.

Returns:

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

All container service metric data is available in 5-minute (300 seconds) granularity.

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 GetContainerServiceMetricDataRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetContainerServiceMetricDataRequest.Builder,GetContainerServiceMetricDataRequest>

Specified by:

toBuilder in class LightsailRequest

builder

public static GetContainerServiceMetricDataRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetContainerServiceMetricDataRequest.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