Package software.amazon.awssdk.services.cloudformation.model

Class ListStacksRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest

software.amazon.awssdk.services.cloudformation.model.ListStacksRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListStacksRequest.Builder,ListStacksRequest>

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

The input for ListStacks action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListStacksRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListStacksRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStackStatusFilters()	For responses, this returns true if the service returned a value for the StackStatusFilters property.
String	nextToken()	The token for the next set of items to return.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListStacksRequest.Builder>	serializableBuilderClass()
List<StackStatus>	stackStatusFilters()	Stack status to use as a filter.
List<String>	stackStatusFiltersAsStrings()	Stack status to use as a filter.
ListStacksRequest.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

nextToken

public final String nextToken()

The token for the next set of items to return. (You received this token from a previous call.)

Returns:

The token for the next set of items to return. (You received this token from a previous call.)

stackStatusFilters

public final List<StackStatus> stackStatusFilters()

Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

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

Returns:

Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

hasStackStatusFilters

public final boolean hasStackStatusFilters()

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

stackStatusFiltersAsStrings

public final List<String> stackStatusFiltersAsStrings()

Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

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

Returns:

Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

toBuilder

public ListStacksRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListStacksRequest.Builder,ListStacksRequest>

Specified by:

toBuilder in class CloudFormationRequest

builder

public static ListStacksRequest.Builder builder()

serializableBuilderClass

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