Package software.amazon.awssdk.services.athena.model

Interface ListSessionsRequest.Builder

    • Method Detail

      • workGroup

        ListSessionsRequest.Builder workGroup​(String workGroup)

        The workgroup to which the session belongs.

        Parameters:
        workGroup - The workgroup to which the session belongs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stateFilter

        ListSessionsRequest.Builder stateFilter​(String stateFilter)

        A filter for a specific session state. A description of each state follows.

        CREATING - The session is being started, including acquiring resources.

        CREATED - The session has been started.

        IDLE - The session is able to accept a calculation.

        BUSY - The session is processing another task and is unable to accept a calculation.

        TERMINATING - The session is in the process of shutting down.

        TERMINATED - The session and its resources are no longer running.

        DEGRADED - The session has no healthy coordinators.

        FAILED - Due to a failure, the session and its resources are no longer running.

        Parameters:
        stateFilter - A filter for a specific session state. A description of each state follows.

        CREATING - The session is being started, including acquiring resources.

        CREATED - The session has been started.

        IDLE - The session is able to accept a calculation.

        BUSY - The session is processing another task and is unable to accept a calculation.

        TERMINATING - The session is in the process of shutting down.

        TERMINATED - The session and its resources are no longer running.

        DEGRADED - The session has no healthy coordinators.

        FAILED - Due to a failure, the session and its resources are no longer running.

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

      • stateFilter

        ListSessionsRequest.Builder stateFilter​(SessionState stateFilter)

        A filter for a specific session state. A description of each state follows.

        CREATING - The session is being started, including acquiring resources.

        CREATED - The session has been started.

        IDLE - The session is able to accept a calculation.

        BUSY - The session is processing another task and is unable to accept a calculation.

        TERMINATING - The session is in the process of shutting down.

        TERMINATED - The session and its resources are no longer running.

        DEGRADED - The session has no healthy coordinators.

        FAILED - Due to a failure, the session and its resources are no longer running.

        Parameters:
        stateFilter - A filter for a specific session state. A description of each state follows.

        CREATING - The session is being started, including acquiring resources.

        CREATED - The session has been started.

        IDLE - The session is able to accept a calculation.

        BUSY - The session is processing another task and is unable to accept a calculation.

        TERMINATING - The session is in the process of shutting down.

        TERMINATED - The session and its resources are no longer running.

        DEGRADED - The session has no healthy coordinators.

        FAILED - Due to a failure, the session and its resources are no longer running.

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

      • maxResults

        ListSessionsRequest.Builder maxResults​(Integer maxResults)

        The maximum number of sessions to return.

        Parameters:
        maxResults - The maximum number of sessions to return.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        ListSessionsRequest.Builder nextToken​(String nextToken)

        A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.

        Parameters:
        nextToken - A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
        Returns:
        Returns a reference to this object so that method calls can be chained together.