Package software.amazon.awssdk.services.appflow.model

Class CancelFlowExecutionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.appflow.model.AppflowRequest

software.amazon.awssdk.services.appflow.model.CancelFlowExecutionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CancelFlowExecutionsRequest.Builder,CancelFlowExecutionsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CancelFlowExecutionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CancelFlowExecutionsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	executionIds()	The ID of each active run to cancel.
String	flowName()	The name of a flow with active runs that you want to cancel.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExecutionIds()	For responses, this returns true if the service returned a value for the ExecutionIds property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CancelFlowExecutionsRequest.Builder>	serializableBuilderClass()
CancelFlowExecutionsRequest.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

flowName

public final String flowName()

The name of a flow with active runs that you want to cancel.

Returns:

The name of a flow with active runs that you want to cancel.

hasExecutionIds

public final boolean hasExecutionIds()

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

executionIds

public final List<String> executionIds()

The ID of each active run to cancel. These runs must belong to the flow you specify in your request.

If you omit this parameter, your request ends all active runs that belong to the flow.

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

Returns:

The ID of each active run to cancel. These runs must belong to the flow you specify in your request.

If you omit this parameter, your request ends all active runs that belong to the flow.

toBuilder

public CancelFlowExecutionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CancelFlowExecutionsRequest.Builder,CancelFlowExecutionsRequest>

Specified by:

toBuilder in class AppflowRequest

builder

public static CancelFlowExecutionsRequest.Builder builder()

serializableBuilderClass

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