com.amazonaws.services.simpleworkflow.model

Class GetWorkflowExecutionHistoryRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.GetWorkflowExecutionHistoryRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class GetWorkflowExecutionHistoryRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

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. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. 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
GetWorkflowExecutionHistoryRequest	clone() Creates a shallow clone of this request.
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() The maximum number of results that will be returned per call.
String	getNextPageToken() If a NextPageToken was returned by a previous call, there are more results available.
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) The maximum number of results that will be returned per call.
void	setNextPageToken(String nextPageToken) If a NextPageToken was returned by a previous call, there are more results available.
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) The maximum number of results that will be returned per call.
GetWorkflowExecutionHistoryRequest	withNextPageToken(String nextPageToken) If a NextPageToken was returned by a previous call, there are more results available.
GetWorkflowExecutionHistoryRequest	withReverseOrder(Boolean reverseOrder) When set to true, returns the events in reverse order.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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 was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

Constraints:
Length: 0 - 2048

Returns:

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

setNextPageToken

public void setNextPageToken(String nextPageToken)

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

Constraints:
Length: 0 - 2048

Parameters:

nextPageToken - If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

withNextPageToken

public GetWorkflowExecutionHistoryRequest withNextPageToken(String nextPageToken)

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

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

Constraints:
Length: 0 - 2048

Parameters:

nextPageToken - If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

Returns:

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

getMaximumPageSize

public Integer getMaximumPageSize()

The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

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

Constraints:
Range: 0 - 1000

Returns:

The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

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

setMaximumPageSize

public void setMaximumPageSize(Integer maximumPageSize)

The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

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

Constraints:
Range: 0 - 1000

Parameters:

maximumPageSize - The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

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

withMaximumPageSize

public GetWorkflowExecutionHistoryRequest withMaximumPageSize(Integer maximumPageSize)

The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

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

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

Constraints:
Range: 0 - 1000

Parameters:

maximumPageSize - The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

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

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

clone

public GetWorkflowExecutionHistoryRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()