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

Class CreateWorkloadEstimateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.bcmpricingcalculator.model.BcmPricingCalculatorRequest

software.amazon.awssdk.services.bcmpricingcalculator.model.CreateWorkloadEstimateRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateWorkloadEstimateRequest.Builder,CreateWorkloadEstimateRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateWorkloadEstimateRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateWorkloadEstimateRequest.Builder	builder()
String	clientToken()	A unique, case-sensitive identifier to ensure idempotency of the request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	name()	A descriptive name for the workload estimate.
WorkloadEstimateRateType	rateType()	The type of pricing rates to use for the estimate.
String	rateTypeAsString()	The type of pricing rates to use for the estimate.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateWorkloadEstimateRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	The tags to apply to the workload estimate.
CreateWorkloadEstimateRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

name

public final String name()

A descriptive name for the workload estimate.

Returns:

A descriptive name for the workload estimate.

clientToken

public final String clientToken()

A unique, case-sensitive identifier to ensure idempotency of the request.

Returns:

A unique, case-sensitive identifier to ensure idempotency of the request.

rateType

public final WorkloadEstimateRateType rateType()

The type of pricing rates to use 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 to use for the estimate.

See Also:

WorkloadEstimateRateType

rateTypeAsString

public final String rateTypeAsString()

The type of pricing rates to use 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 to use for the estimate.

See Also:

WorkloadEstimateRateType

hasTags

public final boolean hasTags()

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

tags

public final Map<String,String> tags()

The tags to apply to the workload estimate.

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

Returns:

The tags to apply to the workload estimate.

toBuilder

public CreateWorkloadEstimateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateWorkloadEstimateRequest.Builder,CreateWorkloadEstimateRequest>

Specified by:

toBuilder in class BcmPricingCalculatorRequest

builder

public static CreateWorkloadEstimateRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

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