java.lang.Object
- software.amazon.awssdk.services.bcmpricingcalculator.model.WorkloadEstimateSummary

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<WorkloadEstimateSummary.Builder,WorkloadEstimateSummary>

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

Provides a summary of a workload estimate.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface WorkloadEstimateSummary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static WorkloadEstimateSummary.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 creation or processing failed.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`id()`	The unique identifier of the workload estimate.
`String`	`name()`	The name of the 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 WorkloadEstimateSummary.Builder>`	`serializableBuilderClass()`
`WorkloadEstimateStatus`	`status()`	The current status of the workload estimate.
`String`	`statusAsString()`	The current status of the workload estimate.
`WorkloadEstimateSummary.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Double`	`totalCost()`	The total estimated cost for the workload.

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 workload estimate.
    
    Returns:
    
    The unique identifier of the workload estimate.
  - name
```
public final String name()
```
    The name of the workload estimate.
    
    Returns:
    
    The name of the 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 creation or processing failed.
    
    Returns:
    
    An error message if the workload estimate creation or processing failed.
  - toBuilder
```
public WorkloadEstimateSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<WorkloadEstimateSummary.Builder,WorkloadEstimateSummary>
  - builder
```
public static WorkloadEstimateSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends WorkloadEstimateSummary.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class WorkloadEstimateSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

name

createdAt

expiresAt

rateType

rateTypeAsString

rateTimestamp

status

statusAsString

totalCost

costCurrency

costCurrencyAsString

failureMessage

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField