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

Class ListCommitmentPurchaseAnalysesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.costexplorer.model.CostExplorerRequest

software.amazon.awssdk.services.costexplorer.model.ListCommitmentPurchaseAnalysesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListCommitmentPurchaseAnalysesRequest.Builder,ListCommitmentPurchaseAnalysesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListCommitmentPurchaseAnalysesRequest.Builder

Method Summary

Modifier and Type	Method	Description
List<String>	analysisIds()	The analysis IDs associated with the commitment purchase analyses.
AnalysisStatus	analysisStatus()	The status of the analysis.
String	analysisStatusAsString()	The status of the analysis.
static ListCommitmentPurchaseAnalysesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAnalysisIds()	For responses, this returns true if the service returned a value for the AnalysisIds property.
int	hashCode()
String	nextPageToken()	The token to retrieve the next set of results.
Integer	pageSize()	The number of analyses that you want returned in a single response object.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListCommitmentPurchaseAnalysesRequest.Builder>	serializableBuilderClass()
ListCommitmentPurchaseAnalysesRequest.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

analysisStatus

public final AnalysisStatus analysisStatus()

The status of the analysis.

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

Returns:

The status of the analysis.

See Also:

AnalysisStatus

analysisStatusAsString

public final String analysisStatusAsString()

The status of the analysis.

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

Returns:

The status of the analysis.

See Also:

AnalysisStatus

nextPageToken

public final String nextPageToken()

The token to retrieve the next set of results.

Returns:

The token to retrieve the next set of results.

pageSize

public final Integer pageSize()

The number of analyses that you want returned in a single response object.

Returns:

The number of analyses that you want returned in a single response object.

hasAnalysisIds

public final boolean hasAnalysisIds()

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

analysisIds

public final List<String> analysisIds()

The analysis IDs associated with the commitment purchase analyses.

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

Returns:

The analysis IDs associated with the commitment purchase analyses.

toBuilder

public ListCommitmentPurchaseAnalysesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListCommitmentPurchaseAnalysesRequest.Builder,ListCommitmentPurchaseAnalysesRequest>

Specified by:

toBuilder in class CostExplorerRequest

builder

public static ListCommitmentPurchaseAnalysesRequest.Builder builder()

serializableBuilderClass

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