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(value="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 and Description
static interface	ListStepsRequest.Builder

Method Summary

Modifier and Type	Method and 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) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
boolean	hasStepIds() Returns true if the StepIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasStepStates() Returns true if the StepStates property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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() Take this object and create a builder that contains all of the current property values of this object.
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

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.

You can use hasStepStates() to see if a value was sent in this field.

Returns:

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

hasStepStates

public final boolean hasStepStates()

Returns true if the StepStates property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasStepStates() to see if a value was sent in this field.

Returns:

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

hasStepIds

public final boolean hasStepIds()

Returns true if the StepIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasStepIds() to see if a value was sent in this field.

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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListStepsRequest.Builder,ListStepsRequest>

Specified by:

toBuilder in class EmrRequest

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.