com.amazonaws.services.stepfunctions.model

Class ListExecutionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.stepfunctions.model.ListExecutionsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListExecutionsRequest
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
ListExecutionsRequest()

Method Summary

Modifier and Type	Method and Description
ListExecutionsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getMapRunArn() The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions.
Integer	getMaxResults() The maximum number of results that are returned per call.
String	getNextToken() If nextToken is returned, there are more results available.
String	getRedriveFilter() Sets a filter to list executions based on whether or not they have been redriven.
String	getStateMachineArn() The Amazon Resource Name (ARN) of the state machine whose executions is listed.
String	getStatusFilter() If specified, only list the executions whose current execution status matches the given filter.
int	hashCode()
void	setMapRunArn(String mapRunArn) The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions.
void	setMaxResults(Integer maxResults) The maximum number of results that are returned per call.
void	setNextToken(String nextToken) If nextToken is returned, there are more results available.
void	setRedriveFilter(ExecutionRedriveFilter redriveFilter) Sets a filter to list executions based on whether or not they have been redriven.
void	setRedriveFilter(String redriveFilter) Sets a filter to list executions based on whether or not they have been redriven.
void	setStateMachineArn(String stateMachineArn) The Amazon Resource Name (ARN) of the state machine whose executions is listed.
void	setStatusFilter(ExecutionStatus statusFilter) If specified, only list the executions whose current execution status matches the given filter.
void	setStatusFilter(String statusFilter) If specified, only list the executions whose current execution status matches the given filter.
String	toString() Returns a string representation of this object.
ListExecutionsRequest	withMapRunArn(String mapRunArn) The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions.
ListExecutionsRequest	withMaxResults(Integer maxResults) The maximum number of results that are returned per call.
ListExecutionsRequest	withNextToken(String nextToken) If nextToken is returned, there are more results available.
ListExecutionsRequest	withRedriveFilter(ExecutionRedriveFilter redriveFilter) Sets a filter to list executions based on whether or not they have been redriven.
ListExecutionsRequest	withRedriveFilter(String redriveFilter) Sets a filter to list executions based on whether or not they have been redriven.
ListExecutionsRequest	withStateMachineArn(String stateMachineArn) The Amazon Resource Name (ARN) of the state machine whose executions is listed.
ListExecutionsRequest	withStatusFilter(ExecutionStatus statusFilter) If specified, only list the executions whose current execution status matches the given filter.
ListExecutionsRequest	withStatusFilter(String statusFilter) If specified, only list the executions whose current execution status matches the given filter.

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

ListExecutionsRequest

public ListExecutionsRequest()

Method Detail

setStateMachineArn

public void setStateMachineArn(String stateMachineArn)

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

You can specify either a mapRunArn or a stateMachineArn, but not both.

You can also return a list of executions associated with a specific alias or version, by specifying an alias ARN or a version ARN in the stateMachineArn parameter.

Parameters:

stateMachineArn - The Amazon Resource Name (ARN) of the state machine whose executions is listed.

You can specify either a mapRunArn or a stateMachineArn, but not both.

You can also return a list of executions associated with a specific alias or version< /a>, by specifying an alias ARN or a version ARN in the stateMachineArn parameter.

getStateMachineArn

public String getStateMachineArn()

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

You can specify either a mapRunArn or a stateMachineArn, but not both.

You can also return a list of executions associated with a specific alias or version, by specifying an alias ARN or a version ARN in the stateMachineArn parameter.

Returns:

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

You can specify either a mapRunArn or a stateMachineArn, but not both.

You can also return a list of executions associated with a specific alias or version , by specifying an alias ARN or a version ARN in the stateMachineArn parameter.

withStateMachineArn

public ListExecutionsRequest withStateMachineArn(String stateMachineArn)

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

You can specify either a mapRunArn or a stateMachineArn, but not both.

You can also return a list of executions associated with a specific alias or version, by specifying an alias ARN or a version ARN in the stateMachineArn parameter.

Parameters:

stateMachineArn - The Amazon Resource Name (ARN) of the state machine whose executions is listed.

You can specify either a mapRunArn or a stateMachineArn, but not both.

You can also return a list of executions associated with a specific alias or version< /a>, by specifying an alias ARN or a version ARN in the stateMachineArn parameter.

Returns:

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

setStatusFilter

public void setStatusFilter(String statusFilter)

If specified, only list the executions whose current execution status matches the given filter.

Parameters:

statusFilter - If specified, only list the executions whose current execution status matches the given filter.

See Also:

ExecutionStatus

getStatusFilter

public String getStatusFilter()

If specified, only list the executions whose current execution status matches the given filter.

Returns:

If specified, only list the executions whose current execution status matches the given filter.

See Also:

ExecutionStatus

withStatusFilter

public ListExecutionsRequest withStatusFilter(String statusFilter)

If specified, only list the executions whose current execution status matches the given filter.

Parameters:

statusFilter - If specified, only list the executions whose current execution status matches the given filter.

Returns:

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

See Also:

ExecutionStatus

setStatusFilter

public void setStatusFilter(ExecutionStatus statusFilter)

If specified, only list the executions whose current execution status matches the given filter.

Parameters:

statusFilter - If specified, only list the executions whose current execution status matches the given filter.

See Also:

ExecutionStatus

withStatusFilter

public ListExecutionsRequest withStatusFilter(ExecutionStatus statusFilter)

If specified, only list the executions whose current execution status matches the given filter.

Parameters:

statusFilter - If specified, only list the executions whose current execution status matches the given filter.

Returns:

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

See Also:

ExecutionStatus

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Parameters:

maxResults - The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

getMaxResults

public Integer getMaxResults()

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Returns:

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

withMaxResults

public ListExecutionsRequest withMaxResults(Integer maxResults)

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Parameters:

maxResults - The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Parameters:

nextToken - If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

getNextToken

public String getNextToken()

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

withNextToken

public ListExecutionsRequest withNextToken(String nextToken)

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Parameters:

nextToken - If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

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

setMapRunArn

public void setMapRunArn(String mapRunArn)

The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.

You can specify either a mapRunArn or a stateMachineArn, but not both.

Parameters:

mapRunArn - The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.

You can specify either a mapRunArn or a stateMachineArn, but not both.

getMapRunArn

public String getMapRunArn()

The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.

You can specify either a mapRunArn or a stateMachineArn, but not both.

Returns:

The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.

You can specify either a mapRunArn or a stateMachineArn, but not both.

withMapRunArn

public ListExecutionsRequest withMapRunArn(String mapRunArn)

The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.

You can specify either a mapRunArn or a stateMachineArn, but not both.

Parameters:

mapRunArn - The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.

You can specify either a mapRunArn or a stateMachineArn, but not both.

Returns:

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

setRedriveFilter

public void setRedriveFilter(String redriveFilter)

Sets a filter to list executions based on whether or not they have been redriven.

For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.

If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.

If you provide a state machine ARN in redriveFilter, the API returns a validation exception.

Parameters:

redriveFilter - Sets a filter to list executions based on whether or not they have been redriven.

For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.

If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.

If you provide a state machine ARN in redriveFilter, the API returns a validation exception.

See Also:

ExecutionRedriveFilter

getRedriveFilter

public String getRedriveFilter()

Sets a filter to list executions based on whether or not they have been redriven.

For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.

If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.

If you provide a state machine ARN in redriveFilter, the API returns a validation exception.

Returns:

Sets a filter to list executions based on whether or not they have been redriven.

For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.

If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.

If you provide a state machine ARN in redriveFilter, the API returns a validation exception.

See Also:

ExecutionRedriveFilter

withRedriveFilter

public ListExecutionsRequest withRedriveFilter(String redriveFilter)

Sets a filter to list executions based on whether or not they have been redriven.

For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.

If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.

If you provide a state machine ARN in redriveFilter, the API returns a validation exception.

Parameters:

redriveFilter - Sets a filter to list executions based on whether or not they have been redriven.

For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.

If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.

If you provide a state machine ARN in redriveFilter, the API returns a validation exception.

Returns:

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

See Also:

ExecutionRedriveFilter

setRedriveFilter

public void setRedriveFilter(ExecutionRedriveFilter redriveFilter)

Sets a filter to list executions based on whether or not they have been redriven.

For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.

If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.

If you provide a state machine ARN in redriveFilter, the API returns a validation exception.

Parameters:

redriveFilter - Sets a filter to list executions based on whether or not they have been redriven.

For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.

If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.

If you provide a state machine ARN in redriveFilter, the API returns a validation exception.

See Also:

ExecutionRedriveFilter

withRedriveFilter

public ListExecutionsRequest withRedriveFilter(ExecutionRedriveFilter redriveFilter)

Sets a filter to list executions based on whether or not they have been redriven.

For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.

If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.

If you provide a state machine ARN in redriveFilter, the API returns a validation exception.

Parameters:

redriveFilter - Sets a filter to list executions based on whether or not they have been redriven.

For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.

If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.

If you provide a state machine ARN in redriveFilter, the API returns a validation exception.

Returns:

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

See Also:

ExecutionRedriveFilter

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 ListExecutionsRequest 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()