Class ListStepsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListStepsRequest.Builder,
ListStepsRequest>
This input determines which steps to list.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ListStepsRequest.Builder
builder()
final String
The identifier of the cluster for which to list the steps.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the StepIds property.final boolean
For responses, this returns true if the service returned a value for the StepStates property.final String
marker()
The maximum number of steps that a singleListSteps
action returns is 50.static Class
<? extends ListStepsRequest.Builder> stepIds()
The filter to limit the step list based on the identifier of the steps.The filter to limit the step list based on certain states.The filter to limit the step list based on certain states.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 theisEmpty()
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
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 theisEmpty()
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
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
The maximum number of steps that a single
ListSteps
action returns is 50. To return a longer list of steps, use multipleListSteps
actions along with theMarker
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 multipleListSteps
actions along with theMarker
parameter, which is a pagination token that indicates the next set of results to retrieve.
-
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 interfaceToCopyableBuilder<ListStepsRequest.Builder,
ListStepsRequest> - Specified by:
toBuilder
in classEmrRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-