Package software.amazon.awssdk.services.bcmpricingcalculator.model

Class GetWorkloadEstimateResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.bcmpricingcalculator.model.BcmPricingCalculatorResponse

software.amazon.awssdk.services.bcmpricingcalculator.model.GetWorkloadEstimateResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetWorkloadEstimateResponse.Builder,GetWorkloadEstimateResponse>

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

Mixin for common fields returned by CRUD APIs

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetWorkloadEstimateResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetWorkloadEstimateResponse.Builder	builder()
CurrencyCode	costCurrency()	The currency of the estimated cost.
String	costCurrencyAsString()	The currency of the estimated cost.
Instant	createdAt()	The timestamp when the workload estimate was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Instant	expiresAt()	The timestamp when the workload estimate will expire.
String	failureMessage()	An error message if the workload estimate retrieval failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The unique identifier of the retrieved workload estimate.
String	name()	The name of the retrieved workload estimate.
Instant	rateTimestamp()	The timestamp of the pricing rates used for the estimate.
WorkloadEstimateRateType	rateType()	The type of pricing rates used for the estimate.
String	rateTypeAsString()	The type of pricing rates used for the estimate.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetWorkloadEstimateResponse.Builder>	serializableBuilderClass()
WorkloadEstimateStatus	status()	The current status of the workload estimate.
String	statusAsString()	The current status of the workload estimate.
GetWorkloadEstimateResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Double	totalCost()	The total estimated cost for the workload.

Methods inherited from class software.amazon.awssdk.services.bcmpricingcalculator.model.BcmPricingCalculatorResponse

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

id

public final String id()

The unique identifier of the retrieved workload estimate.

Returns:

The unique identifier of the retrieved workload estimate.

name

public final String name()

The name of the retrieved workload estimate.

Returns:

The name of the retrieved workload estimate.

createdAt

public final Instant createdAt()

The timestamp when the workload estimate was created.

Returns:

The timestamp when the workload estimate was created.

expiresAt

public final Instant expiresAt()

The timestamp when the workload estimate will expire.

Returns:

The timestamp when the workload estimate will expire.

rateType

public final WorkloadEstimateRateType rateType()

The type of pricing rates used for the estimate.

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

Returns:

The type of pricing rates used for the estimate.

See Also:

WorkloadEstimateRateType

rateTypeAsString

public final String rateTypeAsString()

The type of pricing rates used for the estimate.

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

Returns:

The type of pricing rates used for the estimate.

See Also:

WorkloadEstimateRateType

rateTimestamp

public final Instant rateTimestamp()

The timestamp of the pricing rates used for the estimate.

Returns:

The timestamp of the pricing rates used for the estimate.

status

public final WorkloadEstimateStatus status()

The current status of the workload estimate.

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

Returns:

The current status of the workload estimate.

See Also:

WorkloadEstimateStatus

statusAsString

public final String statusAsString()

The current status of the workload estimate.

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

Returns:

The current status of the workload estimate.

See Also:

WorkloadEstimateStatus

totalCost

public final Double totalCost()

The total estimated cost for the workload.

Returns:

The total estimated cost for the workload.

costCurrency

public final CurrencyCode costCurrency()

The currency of the estimated cost.

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

Returns:

The currency of the estimated cost.

See Also:

CurrencyCode

costCurrencyAsString

public final String costCurrencyAsString()

The currency of the estimated cost.

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

Returns:

The currency of the estimated cost.

See Also:

CurrencyCode

failureMessage

public final String failureMessage()

An error message if the workload estimate retrieval failed.

Returns:

An error message if the workload estimate retrieval failed.

toBuilder

public GetWorkloadEstimateResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetWorkloadEstimateResponse.Builder,GetWorkloadEstimateResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetWorkloadEstimateResponse.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo