Package software.amazon.awssdk.services.autoscaling.model

Class LoadForecast

java.lang.Object

software.amazon.awssdk.services.autoscaling.model.LoadForecast

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<LoadForecast.Builder,LoadForecast>

@Generated("software.amazon.awssdk:codegen")
public final class LoadForecast
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LoadForecast.Builder,LoadForecast>

A GetPredictiveScalingForecast call returns the load forecast for a predictive scaling policy. This structure includes the data points for that load forecast, along with the timestamps of those data points and the metric specification.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LoadForecast.Builder

Method Summary

Modifier and Type	Method	Description
static LoadForecast.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTimestamps()	For responses, this returns true if the service returned a value for the Timestamps property.
boolean	hasValues()	For responses, this returns true if the service returned a value for the Values property.
PredictiveScalingMetricSpecification	metricSpecification()	The metric specification for the load forecast.
List<SdkField<?>>	sdkFields()
static Class<? extends LoadForecast.Builder>	serializableBuilderClass()
List<Instant>	timestamps()	The timestamps for the data points, in UTC format.
LoadForecast.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<Double>	values()	The values of the data points.

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

hasTimestamps

public final boolean hasTimestamps()

For responses, this returns true if the service returned a value for the Timestamps 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.

timestamps

public final List<Instant> timestamps()

The timestamps for the data points, in UTC format.

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

Returns:

The timestamps for the data points, in UTC format.

hasValues

public final boolean hasValues()

For responses, this returns true if the service returned a value for the Values 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.

values

public final List<Double> values()

The values of the data points.

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

Returns:

The values of the data points.

metricSpecification

public final PredictiveScalingMetricSpecification metricSpecification()

The metric specification for the load forecast.

Returns:

The metric specification for the load forecast.

toBuilder

public LoadForecast.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LoadForecast.Builder,LoadForecast>

builder

public static LoadForecast.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo