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

Class CancelStepsRequest

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.CancelStepsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CancelStepsRequest.Builder,CancelStepsRequest>

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

The input argument to the CancelSteps operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CancelStepsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CancelStepsRequest.Builder	builder()
String	clusterId()	The ClusterID for the specified steps that will be canceled.
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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CancelStepsRequest.Builder>	serializableBuilderClass()
StepCancellationOption	stepCancellationOption()	The option to choose to cancel RUNNING steps.
String	stepCancellationOptionAsString()	The option to choose to cancel RUNNING steps.
List<String>	stepIds()	The list of StepIDs to cancel.
CancelStepsRequest.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 ClusterID for the specified steps that will be canceled. Use RunJobFlow and ListClusters to get ClusterIDs.

Returns:

The ClusterID for the specified steps that will be canceled. Use RunJobFlow and ListClusters to get ClusterIDs.

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 list of StepIDs to cancel. Use ListSteps to get steps and their states for the specified cluster.

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 list of StepIDs to cancel. Use ListSteps to get steps and their states for the specified cluster.

stepCancellationOption

public final StepCancellationOption stepCancellationOption()

The option to choose to cancel RUNNING steps. By default, the value is SEND_INTERRUPT.

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

Returns:

The option to choose to cancel RUNNING steps. By default, the value is SEND_INTERRUPT.

See Also:

StepCancellationOption

stepCancellationOptionAsString

public final String stepCancellationOptionAsString()

The option to choose to cancel RUNNING steps. By default, the value is SEND_INTERRUPT.

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

Returns:

The option to choose to cancel RUNNING steps. By default, the value is SEND_INTERRUPT.

See Also:

StepCancellationOption

toBuilder

public CancelStepsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CancelStepsRequest.Builder,CancelStepsRequest>

Specified by:

toBuilder in class EmrRequest

builder

public static CancelStepsRequest.Builder builder()

serializableBuilderClass

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