Package software.amazon.awssdk.services.costexplorer.model

Class ResultByTime

java.lang.Object

software.amazon.awssdk.services.costexplorer.model.ResultByTime

All Implemented Interfaces:

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

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

The result that's associated with a time period.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ResultByTime.Builder

Method Summary

Modifier and Type	Method	Description
static ResultByTime.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	estimated()	Determines whether the result is estimated.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<Group>	groups()	The groups that this time period includes.
boolean	hasGroups()	For responses, this returns true if the service returned a value for the Groups property.
int	hashCode()
boolean	hasTotal()	For responses, this returns true if the service returned a value for the Total property.
List<SdkField<?>>	sdkFields()
static Class<? extends ResultByTime.Builder>	serializableBuilderClass()
DateInterval	timePeriod()	The time period that the result covers.
ResultByTime.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Map<String,MetricValue>	total()	The total amount of cost or usage accrued during the time period.

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

timePeriod

public final DateInterval timePeriod()

The time period that the result covers.

Returns:

The time period that the result covers.

hasTotal

public final boolean hasTotal()

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

total

public final Map<String,MetricValue> total()

The total amount of cost or usage accrued during the time period.

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

Returns:

The total amount of cost or usage accrued during the time period.

hasGroups

public final boolean hasGroups()

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

groups

public final List<Group> groups()

The groups that this time period includes.

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

Returns:

The groups that this time period includes.

estimated

public final Boolean estimated()

Determines whether the result is estimated.

Returns:

Determines whether the result is estimated.

toBuilder

public ResultByTime.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResultByTime.Builder,ResultByTime>

builder

public static ResultByTime.Builder builder()

serializableBuilderClass

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