Copyright	(C) 2019 Earnest Research
License	MIT
Maintainer	Daniel Donohue <ddonohue@earnestresearch.com>
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Network.Livy.Client.Types.Session

Contents

Interactive sessions
- Lenses

Description

Synopsis

data Session = Session {
- _sId :: !SessionId
- _sAppId :: !(Maybe Text)
- _sOwner :: !(Maybe Text)
- _sProxyUser :: !(Maybe Text)
- _sKind :: !SessionKind
- _sLog :: ![Text]
- _sState :: !SessionState
- _sAppInfo :: !SessionAppInfo
}
newtype SessionId = SessionId Int
data SessionKind
- = SparkSession
- | PySparkSession
- | SparkRSession
- | SQLSession
- | SharedSession
data SessionState
- = SessionNotStarted
- | SessionStarting
- | SessionRecovering
- | SessionIdle
- | SessionRunning
- | SessionBusy
- | SessionShuttingDown
- | SessionError
- | SessionDead
- | SessionKilled
- | SessionSuccess
type SessionAppInfo = HashMap Text (Maybe Text)
sId :: Lens' Session SessionId
sAppId :: Lens' Session (Maybe Text)
sOwner :: Lens' Session (Maybe Text)
sProxyUser :: Lens' Session (Maybe Text)
sKind :: Lens' Session SessionKind
sLog :: Lens' Session [Text]
sState :: Lens' Session SessionState
sAppInfo :: Lens' Session SessionAppInfo

Interactive sessions

data Session Source #

An interactive session with Livy.

Constructors

Session

Fields

_sId :: !SessionId
The session id.
_sAppId :: !(Maybe Text)
The application id of this session.
_sOwner :: !(Maybe Text)
Remote user who submitted this session.
_sProxyUser :: !(Maybe Text)
User to impersonate when running.
_sKind :: !SessionKind
Session kind (spark, pyspark, sparkr, sql, shared).
_sLog :: ![Text]
The log lines.
_sState :: !SessionState
The session state.
_sAppInfo :: !SessionAppInfo
The detailed application info.

Instances

Eq Session Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods (==) :: Session -> Session -> Bool # (/=) :: Session -> Session -> Bool #
Show Session Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods showsPrec :: Int -> Session -> ShowS # show :: Session -> String # showList :: [Session] -> ShowS #
ToJSON Session Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods toJSON :: Session -> Value # toEncoding :: Session -> Encoding # toJSONList :: [Session] -> Value # toEncodingList :: [Session] -> Encoding #
FromJSON Session Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods parseJSON :: Value -> Parser Session # parseJSONList :: Value -> Parser [Session] #

newtype SessionId Source #

The id of this interactive session.

Constructors

SessionId Int

Instances

Eq SessionId Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods (==) :: SessionId -> SessionId -> Bool # (/=) :: SessionId -> SessionId -> Bool #
Show SessionId Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods showsPrec :: Int -> SessionId -> ShowS # show :: SessionId -> String # showList :: [SessionId] -> ShowS #
ToJSON SessionId Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods toJSON :: SessionId -> Value # toEncoding :: SessionId -> Encoding # toJSONList :: [SessionId] -> Value # toEncodingList :: [SessionId] -> Encoding #
FromJSON SessionId Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods parseJSON :: Value -> Parser SessionId # parseJSONList :: Value -> Parser [SessionId] #
ToText SessionId Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods toText :: SessionId -> Text Source #

data SessionKind Source #

The kind of Livy session.

Constructors

SparkSession	A Scala Spark session.
PySparkSession	A PySpark session.
SparkRSession	A SparkR session.
SQLSession	A Spark SQL session.
SharedSession	A session that supports all types.

Instances

Bounded SessionKind Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods minBound :: SessionKind # maxBound :: SessionKind #
Enum SessionKind Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods succ :: SessionKind -> SessionKind # pred :: SessionKind -> SessionKind # toEnum :: Int -> SessionKind # fromEnum :: SessionKind -> Int # enumFrom :: SessionKind -> [SessionKind] # enumFromThen :: SessionKind -> SessionKind -> [SessionKind] # enumFromTo :: SessionKind -> SessionKind -> [SessionKind] # enumFromThenTo :: SessionKind -> SessionKind -> SessionKind -> [SessionKind] #
Eq SessionKind Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods (==) :: SessionKind -> SessionKind -> Bool # (/=) :: SessionKind -> SessionKind -> Bool #
Show SessionKind Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods showsPrec :: Int -> SessionKind -> ShowS # show :: SessionKind -> String # showList :: [SessionKind] -> ShowS #
ToJSON SessionKind Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods toJSON :: SessionKind -> Value # toEncoding :: SessionKind -> Encoding # toJSONList :: [SessionKind] -> Value # toEncodingList :: [SessionKind] -> Encoding #
FromJSON SessionKind Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods parseJSON :: Value -> Parser SessionKind # parseJSONList :: Value -> Parser [SessionKind] #
ToText SessionKind Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods toText :: SessionKind -> Text Source #

data SessionState Source #

The present state of a session.

Constructors

SessionNotStarted	Session has not been started.
SessionStarting	Session is starting.
SessionRecovering	Session is recovering.
SessionIdle	Session is waiting for input.
SessionRunning	Session is running.
SessionBusy	Session is executing a statement.
SessionShuttingDown	Session is shutting down.
SessionError	Session errored out.
SessionDead	Session has exited.
SessionKilled	Session is killed.
SessionSuccess	Session is successfully stopped.

Instances

Bounded SessionState Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods minBound :: SessionState # maxBound :: SessionState #
Enum SessionState Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods succ :: SessionState -> SessionState # pred :: SessionState -> SessionState # toEnum :: Int -> SessionState # fromEnum :: SessionState -> Int # enumFrom :: SessionState -> [SessionState] # enumFromThen :: SessionState -> SessionState -> [SessionState] # enumFromTo :: SessionState -> SessionState -> [SessionState] # enumFromThenTo :: SessionState -> SessionState -> SessionState -> [SessionState] #
Eq SessionState Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods (==) :: SessionState -> SessionState -> Bool # (/=) :: SessionState -> SessionState -> Bool #
Show SessionState Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods showsPrec :: Int -> SessionState -> ShowS # show :: SessionState -> String # showList :: [SessionState] -> ShowS #
ToJSON SessionState Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods toJSON :: SessionState -> Value # toEncoding :: SessionState -> Encoding # toJSONList :: [SessionState] -> Value # toEncodingList :: [SessionState] -> Encoding #
FromJSON SessionState Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods parseJSON :: Value -> Parser SessionState # parseJSONList :: Value -> Parser [SessionState] #
ToText SessionState Source #
Instance details Defined in Network.Livy.Client.Types.Session Methods toText :: SessionState -> Text Source #

type SessionAppInfo = HashMap Text (Maybe Text) Source #

Detailed application information.

Lenses

sId :: Lens' Session SessionId Source #

sAppId :: Lens' Session (Maybe Text) Source #

sOwner :: Lens' Session (Maybe Text) Source #

sProxyUser :: Lens' Session (Maybe Text) Source #

sKind :: Lens' Session SessionKind Source #

sLog :: Lens' Session [Text] Source #

sState :: Lens' Session SessionState Source #

sAppInfo :: Lens' Session SessionAppInfo Source #