software.amazon.awssdk.services.costexplorer.model

Class GetUsageForecastResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.costexplorer.model.CostExplorerResponse

software.amazon.awssdk.services.costexplorer.model.GetUsageForecastResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetUsageForecastResponse.Builder,GetUsageForecastResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetUsageForecastResponse
extends CostExplorerResponse
implements ToCopyableBuilder<GetUsageForecastResponse.Builder,GetUsageForecastResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetUsageForecastResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetUsageForecastResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<ForecastResult>	forecastResultsByTime() The forecasts for your query, in order.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasForecastResultsByTime() For responses, this returns true if the service returned a value for the ForecastResultsByTime property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends GetUsageForecastResponse.Builder>	serializableBuilderClass()
GetUsageForecastResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
MetricValue	total() How much you're forecasted to use over the forecast period.

Methods inherited from class software.amazon.awssdk.services.costexplorer.model.CostExplorerResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

total

public final MetricValue total()

How much you're forecasted to use over the forecast period.

Returns:

How much you're forecasted to use over the forecast period.

hasForecastResultsByTime

public final boolean hasForecastResultsByTime()

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

forecastResultsByTime

public final List<ForecastResult> forecastResultsByTime()

The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For MONTHLY forecasts, this is a list of months.

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

Returns:

The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For MONTHLY forecasts, this is a list of months.

toBuilder

public GetUsageForecastResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetUsageForecastResponse.Builder,GetUsageForecastResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetUsageForecastResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo