Package software.amazon.awssdk.services.emr.model

Class ListStepsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.emr.model.EmrRequest

software.amazon.awssdk.services.emr.model.ListStepsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListStepsRequest.Builder,ListStepsRequest>

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

This input determines which steps to list.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListStepsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListStepsRequest.Builder	builder()
String	clusterId()	The identifier of the cluster for which to list the steps.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStepIds()	For responses, this returns true if the service returned a value for the StepIds property.
boolean	hasStepStates()	For responses, this returns true if the service returned a value for the StepStates property.
String	marker()	The maximum number of steps that a single ListSteps action returns is 50.
List<SdkField<?>>	sdkFields()
static Class<? extends ListStepsRequest.Builder>	serializableBuilderClass()
List<String>	stepIds()	The filter to limit the step list based on the identifier of the steps.
List<StepState>	stepStates()	The filter to limit the step list based on certain states.
List<String>	stepStatesAsStrings()	The filter to limit the step list based on certain states.
ListStepsRequest.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

clusterId

public final String clusterId()

The identifier of the cluster for which to list the steps.

Returns:

The identifier of the cluster for which to list the steps.

stepStates

public final List<StepState> stepStates()

The filter to limit the step list based on certain states.

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

Returns:

The filter to limit the step list based on certain states.

hasStepStates

public final boolean hasStepStates()

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

stepStatesAsStrings

public final List<String> stepStatesAsStrings()

The filter to limit the step list based on certain states.

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

Returns:

The filter to limit the step list based on certain states.

hasStepIds

public final boolean hasStepIds()

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

stepIds

public final List<String> stepIds()

The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step IDs. The character constraint applies to the overall length of the array.

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

Returns:

The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step IDs. The character constraint applies to the overall length of the array.

marker

public final String marker()

The maximum number of steps that a single ListSteps action returns is 50. To return a longer list of steps, use multiple ListSteps actions along with the Marker parameter, which is a pagination token that indicates the next set of results to retrieve.

Returns:

The maximum number of steps that a single ListSteps action returns is 50. To return a longer list of steps, use multiple ListSteps actions along with the Marker parameter, which is a pagination token that indicates the next set of results to retrieve.

toBuilder

public ListStepsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListStepsRequest.Builder,ListStepsRequest>

Specified by:

toBuilder in class EmrRequest

builder

public static ListStepsRequest.Builder builder()

serializableBuilderClass

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