Class GetWorkflowExecutionHistoryRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The name of the domain containing the workflow execution.Specifies the workflow execution for which to return the history.The maximum number of results that will be returned per call.If aNextPageToken
was returned by a previous call, there are more results available.When set totrue
, returns the events in reverse order.int
hashCode()
When set totrue
, returns the events in reverse order.void
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 aNextPageToken
was returned by a previous call, there are more results available.void
setReverseOrder
(Boolean reverseOrder) When set totrue
, returns the events in reverse order.toString()
Returns a string representation of this object; useful for testing and debugging.withDomain
(String domain) The name of the domain containing the workflow execution.withExecution
(WorkflowExecution execution) Specifies the workflow execution for which to return the history.withMaximumPageSize
(Integer maximumPageSize) The maximum number of results that will be returned per call.withNextPageToken
(String nextPageToken) If aNextPageToken
was returned by a previous call, there are more results available.withReverseOrder
(Boolean reverseOrder) When set totrue
, returns the events in reverse order.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
GetWorkflowExecutionHistoryRequest
public GetWorkflowExecutionHistoryRequest()
-
-
Method Details
-
setDomain
The name of the domain containing the workflow execution.
- Parameters:
domain
- The name of the domain containing the workflow execution.
-
getDomain
The name of the domain containing the workflow execution.
- Returns:
- The name of the domain containing the workflow execution.
-
withDomain
The name of the domain containing the workflow execution.
- Parameters:
domain
- The name of the domain containing the workflow execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setExecution
Specifies the workflow execution for which to return the history.
- Parameters:
execution
- Specifies the workflow execution for which to return the history.
-
getExecution
Specifies the workflow execution for which to return the history.
- Returns:
- Specifies the workflow execution for which to return the history.
-
withExecution
Specifies the workflow execution for which to return the history.
- Parameters:
execution
- Specifies the workflow execution for which to return the history.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNextPageToken
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 innextPageToken
. Keep all other arguments unchanged.The configured
maximumPageSize
determines how many results can be returned in a single call.- Parameters:
nextPageToken
- If aNextPageToken
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 innextPageToken
. Keep all other arguments unchanged.The configured
maximumPageSize
determines how many results can be returned in a single call.
-
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 innextPageToken
. Keep all other arguments unchanged.The configured
maximumPageSize
determines how many results can be returned in a single call.- 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 innextPageToken
. Keep all other arguments unchanged.The configured
maximumPageSize
determines how many results can be returned in a single call.
-
withNextPageToken
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 innextPageToken
. Keep all other arguments unchanged.The configured
maximumPageSize
determines how many results can be returned in a single call.- Parameters:
nextPageToken
- If aNextPageToken
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 innextPageToken
. Keep all other arguments unchanged.The configured
maximumPageSize
determines how many results can be returned in a single call.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMaximumPageSize
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.
- 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.
-
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.
- 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.
-
withMaximumPageSize
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setReverseOrder
When set to
true
, returns the events in reverse order. By default the results are returned in ascending order of theeventTimeStamp
of the events.- Parameters:
reverseOrder
- When set totrue
, returns the events in reverse order. By default the results are returned in ascending order of theeventTimeStamp
of the events.
-
getReverseOrder
When set to
true
, returns the events in reverse order. By default the results are returned in ascending order of theeventTimeStamp
of the events.- Returns:
- When set to
true
, returns the events in reverse order. By default the results are returned in ascending order of theeventTimeStamp
of the events.
-
withReverseOrder
When set to
true
, returns the events in reverse order. By default the results are returned in ascending order of theeventTimeStamp
of the events.- Parameters:
reverseOrder
- When set totrue
, returns the events in reverse order. By default the results are returned in ascending order of theeventTimeStamp
of the events.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isReverseOrder
When set to
true
, returns the events in reverse order. By default the results are returned in ascending order of theeventTimeStamp
of the events.- Returns:
- When set to
true
, returns the events in reverse order. By default the results are returned in ascending order of theeventTimeStamp
of the events.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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 classAmazonWebServiceRequest
- See Also:
-