Interface ListClosedWorkflowExecutionsRequest.Builder

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

  • Method Details

    • domain

      ListClosedWorkflowExecutionsRequest.Builder domain(String domain)

      The name of the domain that contains the workflow executions to list.

      Parameters:
      domain - The name of the domain that contains the workflow executions to list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTimeFilter

      ListClosedWorkflowExecutionsRequest.Builder startTimeFilter(ExecutionTimeFilter startTimeFilter)

      If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

      startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

      Parameters:
      startTimeFilter - If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

      startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

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

    • startTimeFilter

      default ListClosedWorkflowExecutionsRequest.Builder startTimeFilter(Consumer<ExecutionTimeFilter.Builder> startTimeFilter)

      If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

      startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

      This is a convenience method that creates an instance of the ExecutionTimeFilter.Builder avoiding the need to create one manually via ExecutionTimeFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to startTimeFilter(ExecutionTimeFilter).

      Parameters:
      startTimeFilter - a consumer that will call methods on ExecutionTimeFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • closeTimeFilter

      ListClosedWorkflowExecutionsRequest.Builder closeTimeFilter(ExecutionTimeFilter closeTimeFilter)

      If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

      startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

      Parameters:
      closeTimeFilter - If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

      startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

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

    • closeTimeFilter

      default ListClosedWorkflowExecutionsRequest.Builder closeTimeFilter(Consumer<ExecutionTimeFilter.Builder> closeTimeFilter)

      If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

      startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

      This is a convenience method that creates an instance of the ExecutionTimeFilter.Builder avoiding the need to create one manually via ExecutionTimeFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to closeTimeFilter(ExecutionTimeFilter).

      Parameters:
      closeTimeFilter - a consumer that will call methods on ExecutionTimeFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionFilter

      ListClosedWorkflowExecutionsRequest.Builder executionFilter(WorkflowExecutionFilter executionFilter)

      If specified, only workflow executions matching the workflow ID specified in the filter are returned.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

      Parameters:
      executionFilter - If specified, only workflow executions matching the workflow ID specified in the filter are returned.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

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

    • executionFilter

      default ListClosedWorkflowExecutionsRequest.Builder executionFilter(Consumer<WorkflowExecutionFilter.Builder> executionFilter)

      If specified, only workflow executions matching the workflow ID specified in the filter are returned.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

      This is a convenience method that creates an instance of the WorkflowExecutionFilter.Builder avoiding the need to create one manually via WorkflowExecutionFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to executionFilter(WorkflowExecutionFilter).

      Parameters:
      executionFilter - a consumer that will call methods on WorkflowExecutionFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • closeStatusFilter

      ListClosedWorkflowExecutionsRequest.Builder closeStatusFilter(CloseStatusFilter closeStatusFilter)

      If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

      Parameters:
      closeStatusFilter - If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

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

    • closeStatusFilter

      default ListClosedWorkflowExecutionsRequest.Builder closeStatusFilter(Consumer<CloseStatusFilter.Builder> closeStatusFilter)

      If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

      This is a convenience method that creates an instance of the CloseStatusFilter.Builder avoiding the need to create one manually via CloseStatusFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to closeStatusFilter(CloseStatusFilter).

      Parameters:
      closeStatusFilter - a consumer that will call methods on CloseStatusFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • typeFilter

      ListClosedWorkflowExecutionsRequest.Builder typeFilter(WorkflowTypeFilter typeFilter)

      If specified, only executions of the type specified in the filter are returned.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

      Parameters:
      typeFilter - If specified, only executions of the type specified in the filter are returned.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

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

    • typeFilter

      default ListClosedWorkflowExecutionsRequest.Builder typeFilter(Consumer<WorkflowTypeFilter.Builder> typeFilter)

      If specified, only executions of the type specified in the filter are returned.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

      This is a convenience method that creates an instance of the WorkflowTypeFilter.Builder avoiding the need to create one manually via WorkflowTypeFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to typeFilter(WorkflowTypeFilter).

      Parameters:
      typeFilter - a consumer that will call methods on WorkflowTypeFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tagFilter

      ListClosedWorkflowExecutionsRequest.Builder tagFilter(TagFilter tagFilter)

      If specified, only executions that have the matching tag are listed.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

      Parameters:
      tagFilter - If specified, only executions that have the matching tag are listed.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

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

    • tagFilter

      default ListClosedWorkflowExecutionsRequest.Builder tagFilter(Consumer<TagFilter.Builder> tagFilter)

      If specified, only executions that have the matching tag are listed.

      closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

      This is a convenience method that creates an instance of the TagFilter.Builder avoiding the need to create one manually via TagFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagFilter(TagFilter).

      Parameters:
      tagFilter - a consumer that will call methods on TagFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nextPageToken

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

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

      ListClosedWorkflowExecutionsRequest.Builder reverseOrder(Boolean reverseOrder)

      When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

      Parameters:
      reverseOrder - When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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