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

Interface ListClosedWorkflowExecutionsRequest.Builder

    • Method Detail

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

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

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

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

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

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

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