software.amazon.awssdk.services.lightsail.model

Class ResourceBudgetEstimate

java.lang.Object

software.amazon.awssdk.services.lightsail.model.ResourceBudgetEstimate

All Implemented Interfaces:

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

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

Describes the estimated cost or usage that a budget tracks.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ResourceBudgetEstimate.Builder

Method Summary

Modifier and Type	Method and Description
static ResourceBudgetEstimate.Builder	builder()
List<CostEstimate>	costEstimates() The cost estimate for the specified budget.
Instant	endTime() The estimate end time.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCostEstimates() For responses, this returns true if the service returned a value for the CostEstimates property.
int	hashCode()
String	resourceName() The resource name.
ResourceType	resourceType() The type of resource the budget will track.
String	resourceTypeAsString() The type of resource the budget will track.
List<SdkField<?>>	sdkFields()
static Class<? extends ResourceBudgetEstimate.Builder>	serializableBuilderClass()
Instant	startTime() The estimate start time.
ResourceBudgetEstimate.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

resourceName

public final String resourceName()

The resource name.

Returns:

The resource name.

resourceType

public final ResourceType resourceType()

The type of resource the budget will track.

If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

Returns:

The type of resource the budget will track.

See Also:

ResourceType

resourceTypeAsString

public final String resourceTypeAsString()

The type of resource the budget will track.

If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

Returns:

The type of resource the budget will track.

See Also:

ResourceType

hasCostEstimates

public final boolean hasCostEstimates()

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

costEstimates

public final List<CostEstimate> costEstimates()

The cost estimate for the specified budget.

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

Returns:

The cost estimate for the specified budget.

startTime

public final Instant startTime()

The estimate start time.

Returns:

The estimate start time.

endTime

public final Instant endTime()

The estimate end time.

Returns:

The estimate end time.

toBuilder

public ResourceBudgetEstimate.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResourceBudgetEstimate.Builder,ResourceBudgetEstimate>

builder

public static ResourceBudgetEstimate.Builder builder()

serializableBuilderClass

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