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

Interface GetWorkflowExecutionHistoryRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetWorkflowExecutionHistoryRequest.Builder,GetWorkflowExecutionHistoryRequest>, SdkBuilder<GetWorkflowExecutionHistoryRequest.Builder,GetWorkflowExecutionHistoryRequest>, SdkPojo, SdkRequest.Builder, SwfRequest.Builder
Enclosing class:
GetWorkflowExecutionHistoryRequest
public static interface GetWorkflowExecutionHistoryRequest.Builder extends SwfRequest.Builder, SdkPojo, CopyableBuilder<GetWorkflowExecutionHistoryRequest.Builder,GetWorkflowExecutionHistoryRequest>

  • Method Details

    • 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 method 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:

    • nextPageToken

      GetWorkflowExecutionHistoryRequest.Builder nextPageToken(String nextPageToken)

      If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: " Specified token has exceeded its maximum lifetime".

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

      Parameters:
      nextPageToken - If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: " Specified token has exceeded its maximum lifetime".

      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. Use nextPageToken to obtain further pages of results.

      Parameters:
      maximumPageSize - The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.
      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.

    • overrideConfiguration

      GetWorkflowExecutionHistoryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetWorkflowExecutionHistoryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.