software.amazon.awssdk.services.swf.model

Interface GetWorkflowExecutionHistoryRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<GetWorkflowExecutionHistoryRequest.Builder,GetWorkflowExecutionHistoryRequest>, SdkBuilder<GetWorkflowExecutionHistoryRequest.Builder,GetWorkflowExecutionHistoryRequest>, SdkRequest.Builder, SWFRequest.Builder

Enclosing class:

GetWorkflowExecutionHistoryRequest

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

Method Summary

Modifier and Type	Method and Description
GetWorkflowExecutionHistoryRequest.Builder	domain(String domain) The name of the domain containing the workflow execution.
default GetWorkflowExecutionHistoryRequest.Builder	execution(Consumer<WorkflowExecution.Builder> execution) Specifies the workflow execution for which to return the history.
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 are returned per call.
GetWorkflowExecutionHistoryRequest.Builder	nextPageToken(String nextPageToken) If a NextPageToken was returned by a previous call, there are more results available.
GetWorkflowExecutionHistoryRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
GetWorkflowExecutionHistoryRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
GetWorkflowExecutionHistoryRequest.Builder	reverseOrder(Boolean reverseOrder) When set to true, returns the events in reverse order.

Methods inherited from interface software.amazon.awssdk.services.swf.model.SWFRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

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.

execution

default GetWorkflowExecutionHistoryRequest.Builder execution(Consumer<WorkflowExecution.Builder> execution)

Specifies the workflow execution for which to return the history.

This is a convenience that creates an instance of the WorkflowExecution.Builder avoiding the need to create one manually via WorkflowExecution.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to execution(WorkflowExecution).

Parameters:

execution - a consumer that will call methods on WorkflowExecution.Builder

Returns:

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

See Also:

execution(WorkflowExecution)

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 are 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 are 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.

requestOverrideConfig

GetWorkflowExecutionHistoryRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

GetWorkflowExecutionHistoryRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.