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

Method Summary

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

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

Returns:

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

hasStepIds

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

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

Returns:

The list of StepIDs to cancel. Use ListSteps to get steps and their states for the specified cluster.

stepCancellationOption

public StepCancellationOption stepCancellationOption()

The option to choose for cancelling 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 for cancelling RUNNING steps. By default, the value is SEND_INTERRUPT.

See Also:

StepCancellationOption

stepCancellationOptionAsString

public String stepCancellationOptionAsString()

The option to choose for cancelling 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 for cancelling RUNNING steps. By default, the value is SEND_INTERRUPT.

See Also:

StepCancellationOption

toBuilder

public CancelStepsRequest.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<CancelStepsRequest.Builder,CancelStepsRequest>

Specified by:

toBuilder in class EmrRequest

Returns:

a builder for type T

builder

public static CancelStepsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CancelStepsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

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