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

Interface ListOpenWorkflowExecutionsRequest.Builder

    • Method Detail

      • domain

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

        ListOpenWorkflowExecutionsRequest.Builder startTimeFilter​(ExecutionTimeFilter startTimeFilter)

        Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

        Parameters:
        startTimeFilter - Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • typeFilter

        ListOpenWorkflowExecutionsRequest.Builder typeFilter​(WorkflowTypeFilter typeFilter)

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

        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.

        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

        ListOpenWorkflowExecutionsRequest.Builder tagFilter​(TagFilter tagFilter)

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

        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.

        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

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

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

        ListOpenWorkflowExecutionsRequest.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 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 time of the executions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • executionFilter

        ListOpenWorkflowExecutionsRequest.Builder executionFilter​(WorkflowExecutionFilter executionFilter)

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

        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.

        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.