com.amazonaws.services.simpleworkflow.model

Class GetWorkflowExecutionHistoryRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.GetWorkflowExecutionHistoryRequest

All Implemented Interfaces:

Serializable

public class GetWorkflowExecutionHistoryRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the GetWorkflowExecutionHistory operation.

Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.
• Use an Action element to allow or deny permission to call this action.
• You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

See Also:

AmazonSimpleWorkflow.getWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetWorkflowExecutionHistoryRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDomain() The name of the domain containing the workflow execution.
WorkflowExecution	getExecution() Specifies the workflow execution for which to return the history.
Integer	getMaximumPageSize() Specifies the maximum number of history events returned in one page.
String	getNextPageToken() If a NextPageToken is returned, the result has more than one pages.
Boolean	getReverseOrder() When set to true, returns the events in reverse order.
int	hashCode()
Boolean	isReverseOrder() When set to true, returns the events in reverse order.
void	setDomain(String domain) The name of the domain containing the workflow execution.
void	setExecution(WorkflowExecution execution) Specifies the workflow execution for which to return the history.
void	setMaximumPageSize(Integer maximumPageSize) Specifies the maximum number of history events returned in one page.
void	setNextPageToken(String nextPageToken) If a NextPageToken is returned, the result has more than one pages.
void	setReverseOrder(Boolean reverseOrder) When set to true, returns the events in reverse order.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetWorkflowExecutionHistoryRequest	withDomain(String domain) The name of the domain containing the workflow execution.
GetWorkflowExecutionHistoryRequest	withExecution(WorkflowExecution execution) Specifies the workflow execution for which to return the history.
GetWorkflowExecutionHistoryRequest	withMaximumPageSize(Integer maximumPageSize) Specifies the maximum number of history events returned in one page.
GetWorkflowExecutionHistoryRequest	withNextPageToken(String nextPageToken) If a NextPageToken is returned, the result has more than one pages.
GetWorkflowExecutionHistoryRequest	withReverseOrder(Boolean reverseOrder) When set to true, returns the events in reverse order.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetWorkflowExecutionHistoryRequest

public GetWorkflowExecutionHistoryRequest()

Method Detail

getDomain

public String getDomain()

The name of the domain containing the workflow execution.

Constraints:
Length: 1 - 256

Returns:

The name of the domain containing the workflow execution.

setDomain

public void setDomain(String domain)

The name of the domain containing the workflow execution.

Constraints:
Length: 1 - 256

Parameters:

domain - The name of the domain containing the workflow execution.

withDomain

public GetWorkflowExecutionHistoryRequest withDomain(String domain)

The name of the domain containing the workflow execution.

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

Constraints:
Length: 1 - 256

Parameters:

domain - The name of the domain containing the workflow execution.

Returns:

A reference to this updated object so that method calls can be chained together.

getExecution

public WorkflowExecution getExecution()

Specifies the workflow execution for which to return the history.

Returns:

Specifies the workflow execution for which to return the history.

setExecution

public void setExecution(WorkflowExecution execution)

Specifies the workflow execution for which to return the history.

Parameters:

execution - Specifies the workflow execution for which to return the history.

withExecution

public GetWorkflowExecutionHistoryRequest withExecution(WorkflowExecution execution)

Specifies the workflow execution for which to return the history.

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

Parameters:

execution - Specifies the workflow execution for which to return the history.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextPageToken

public String getNextPageToken()

If a NextPageToken is returned, the result has more than one pages. To get the next page, repeat the call and specify the nextPageToken with all other arguments unchanged.

Constraints:
Length: 0 - 2048

Returns:

If a NextPageToken is returned, the result has more than one pages. To get the next page, repeat the call and specify the nextPageToken with all other arguments unchanged.

setNextPageToken

public void setNextPageToken(String nextPageToken)

If a NextPageToken is returned, the result has more than one pages. To get the next page, repeat the call and specify the nextPageToken with all other arguments unchanged.

Constraints:
Length: 0 - 2048

Parameters:

nextPageToken - If a NextPageToken is returned, the result has more than one pages. To get the next page, repeat the call and specify the nextPageToken with all other arguments unchanged.

withNextPageToken

public GetWorkflowExecutionHistoryRequest withNextPageToken(String nextPageToken)

If a NextPageToken is returned, the result has more than one pages. To get the next page, repeat the call and specify the nextPageToken with all other arguments unchanged.

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

Constraints:
Length: 0 - 2048

Parameters:

nextPageToken - If a NextPageToken is returned, the result has more than one pages. To get the next page, repeat the call and specify the nextPageToken with all other arguments unchanged.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaximumPageSize

public Integer getMaximumPageSize()

Specifies the maximum number of history events returned in one page. The next page in the result is identified by the NextPageToken returned. By default 100 history events are returned in a page but the caller can override this value to a page size smaller than the default. You cannot specify a page size larger than 100. Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

Constraints:
Range: 0 - 1000

Returns:

Specifies the maximum number of history events returned in one page. The next page in the result is identified by the NextPageToken returned. By default 100 history events are returned in a page but the caller can override this value to a page size smaller than the default. You cannot specify a page size larger than 100. Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

setMaximumPageSize

public void setMaximumPageSize(Integer maximumPageSize)

Specifies the maximum number of history events returned in one page. The next page in the result is identified by the NextPageToken returned. By default 100 history events are returned in a page but the caller can override this value to a page size smaller than the default. You cannot specify a page size larger than 100. Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

Constraints:
Range: 0 - 1000

Parameters:

maximumPageSize - Specifies the maximum number of history events returned in one page. The next page in the result is identified by the NextPageToken returned. By default 100 history events are returned in a page but the caller can override this value to a page size smaller than the default. You cannot specify a page size larger than 100. Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

withMaximumPageSize

public GetWorkflowExecutionHistoryRequest withMaximumPageSize(Integer maximumPageSize)

Specifies the maximum number of history events returned in one page. The next page in the result is identified by the NextPageToken returned. By default 100 history events are returned in a page but the caller can override this value to a page size smaller than the default. You cannot specify a page size larger than 100. Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

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

Constraints:
Range: 0 - 1000

Parameters:

maximumPageSize - Specifies the maximum number of history events returned in one page. The next page in the result is identified by the NextPageToken returned. By default 100 history events are returned in a page but the caller can override this value to a page size smaller than the default. You cannot specify a page size larger than 100. Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

Returns:

A reference to this updated object so that method calls can be chained together.

isReverseOrder

public Boolean isReverseOrder()

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

Returns:

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

setReverseOrder

public void setReverseOrder(Boolean reverseOrder)

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

Parameters:

reverseOrder - When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

withReverseOrder

public GetWorkflowExecutionHistoryRequest withReverseOrder(Boolean reverseOrder)

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

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

Parameters:

reverseOrder - When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

Returns:

A reference to this updated object so that method calls can be chained together.

getReverseOrder

public Boolean getReverseOrder()

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

Returns:

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object