Package software.amazon.awssdk.services.swf.model

Interface GetWorkflowExecutionHistoryRequest.Builder

All Superinterfaces:

CopyableBuilder<GetWorkflowExecutionHistoryRequest.Builder,GetWorkflowExecutionHistoryRequest>, SdkBuilder<GetWorkflowExecutionHistoryRequest.Builder,GetWorkflowExecutionHistoryRequest>

Enclosing class:

GetWorkflowExecutionHistoryRequest

public static interface GetWorkflowExecutionHistoryRequest.Builder
extends CopyableBuilder<GetWorkflowExecutionHistoryRequest.Builder,GetWorkflowExecutionHistoryRequest>

Method Summary

Modifier and Type	Method	Description
GetWorkflowExecutionHistoryRequest.Builder	domain(String domain)	The name of the domain containing the workflow execution.
GetWorkflowExecutionHistoryRequest.Builder	execution(WorkflowExecution execution)	Specifies the workflow execution for which to return the history.
GetWorkflowExecutionHistoryRequest.Builder	maximumPageSize(Integer maximumPageSize)	The maximum number of results that will be returned per call.
GetWorkflowExecutionHistoryRequest.Builder	nextPageToken(String nextPageToken)	If a NextPageToken was returned by a previous call, there are more results available.
GetWorkflowExecutionHistoryRequest.Builder	reverseOrder(Boolean reverseOrder)	When set to true, returns the events in reverse order.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

domain

GetWorkflowExecutionHistoryRequest.Builder domain(String domain)

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.

execution

GetWorkflowExecutionHistoryRequest.Builder execution(WorkflowExecution execution)

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.

nextPageToken

GetWorkflowExecutionHistoryRequest.Builder nextPageToken(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.

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:

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

maximumPageSize

GetWorkflowExecutionHistoryRequest.Builder maximumPageSize(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.

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.

reverseOrder

GetWorkflowExecutionHistoryRequest.Builder reverseOrder(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.

Returns:

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