com.amazonaws.services.appflow.model

Class CancelFlowExecutionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.appflow.model.CancelFlowExecutionsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CancelFlowExecutionsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CancelFlowExecutionsRequest()

Method Summary

Modifier and Type	Method and Description
CancelFlowExecutionsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getExecutionIds() The ID of each active run to cancel.
String	getFlowName() The name of a flow with active runs that you want to cancel.
int	hashCode()
void	setExecutionIds(Collection<String> executionIds) The ID of each active run to cancel.
void	setFlowName(String flowName) The name of a flow with active runs that you want to cancel.
String	toString() Returns a string representation of this object.
CancelFlowExecutionsRequest	withExecutionIds(Collection<String> executionIds) The ID of each active run to cancel.
CancelFlowExecutionsRequest	withExecutionIds(String... executionIds) The ID of each active run to cancel.
CancelFlowExecutionsRequest	withFlowName(String flowName) The name of a flow with active runs that you want to cancel.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CancelFlowExecutionsRequest

public CancelFlowExecutionsRequest()

Method Detail

setFlowName

public void setFlowName(String flowName)

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

Parameters:

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

getFlowName

public String getFlowName()

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.

withFlowName

public CancelFlowExecutionsRequest withFlowName(String flowName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getExecutionIds

public List<String> getExecutionIds()

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.

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.

setExecutionIds

public void setExecutionIds(Collection<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.

Parameters:

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.

withExecutionIds

public CancelFlowExecutionsRequest withExecutionIds(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.

NOTE: This method appends the values to the existing list (if any). Use setExecutionIds(java.util.Collection) or withExecutionIds(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withExecutionIds

public CancelFlowExecutionsRequest withExecutionIds(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CancelFlowExecutionsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()