Interface SessionStatus.Builder

    • Method Detail

      • startDateTime

        SessionStatus.Builder startDateTime​(Instant startDateTime)

        The date and time that the session started.

        Parameters:
        startDateTime - The date and time that the session started.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • lastModifiedDateTime

        SessionStatus.Builder lastModifiedDateTime​(Instant lastModifiedDateTime)

        The most recent date and time that the session was modified.

        Parameters:
        lastModifiedDateTime - The most recent date and time that the session was modified.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • endDateTime

        SessionStatus.Builder endDateTime​(Instant endDateTime)

        The date and time that the session ended.

        Parameters:
        endDateTime - The date and time that the session ended.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • idleSinceDateTime

        SessionStatus.Builder idleSinceDateTime​(Instant idleSinceDateTime)

        The date and time starting at which the session became idle. Can be empty if the session is not currently idle.

        Parameters:
        idleSinceDateTime - The date and time starting at which the session became idle. Can be empty if the session is not currently idle.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • state

        SessionStatus.Builder state​(String state)

        The state of the session. 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:
        state - The state of the session. 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
      • state

        SessionStatus.Builder state​(SessionState state)

        The state of the session. 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:
        state - The state of the session. 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
      • stateChangeReason

        SessionStatus.Builder stateChangeReason​(String stateChangeReason)

        The reason for the session state change (for example, canceled because the session was terminated).

        Parameters:
        stateChangeReason - The reason for the session state change (for example, canceled because the session was terminated).
        Returns:
        Returns a reference to this object so that method calls can be chained together.