Safe Haskell	None
Language	Haskell2010

Hercules.API.Agent.LifeCycle

Synopsis

data LifeCycleAPI auth f = LifeCycleAPI {
- agentSessionCreate :: f :- (Summary "Create a new agent session." :> (Description "Authenticated using the cluster join token acquired through POST /accounts/:accountId/clusterJoinTokens" :> ("agent" :> ("session" :> (ReqBody '[JSON] CreateAgentSession :> (auth :> Post '[JSON] Text))))))
- hello :: f :- (Summary "Update an agent session wrt features, versions, capabilities etc." :> (Description "Authenticated using the agent session token acquired through agentSessionCreate." :> ("agent" :> ("hello" :> (ReqBody '[JSON] Hello :> (auth :> Post '[JSON] NoContent))))))
- heartbeat :: f :- (Summary "Update an agent session to indicate liveness." :> (Description "Authenticated using the agent session token acquired through agentSessionCreate." :> ("agent" :> ("heartbeat" :> (ReqBody '[JSON] StartInfo :> (auth :> Post '[JSON] NoContent))))))
- goodbye :: f :- (Summary "Report that an agent has stopped." :> (Description "Authenticated using the agent session token acquired through agentSessionCreate." :> ("agent" :> ("goodbye" :> (ReqBody '[JSON] StartInfo :> (auth :> Post '[JSON] NoContent))))))
- getServiceInfo :: f :- (Summary "Service version and configuration." :> ("agent" :> ("service-info" :> Get '[JSON] ServiceInfo)))
}

Documentation

data LifeCycleAPI auth f Source #

Agent session and "connection" endpoints

Constructors

LifeCycleAPI

Fields

agentSessionCreate :: f :- (Summary "Create a new agent session." :> (Description "Authenticated using the cluster join token acquired through POST /accounts/:accountId/clusterJoinTokens" :> ("agent" :> ("session" :> (ReqBody '[JSON] CreateAgentSession :> (auth :> Post '[JSON] Text))))))
This is also available in the client API as agentSessionCreateV2
hello :: f :- (Summary "Update an agent session wrt features, versions, capabilities etc." :> (Description "Authenticated using the agent session token acquired through agentSessionCreate." :> ("agent" :> ("hello" :> (ReqBody '[JSON] Hello :> (auth :> Post '[JSON] NoContent))))))
heartbeat :: f :- (Summary "Update an agent session to indicate liveness." :> (Description "Authenticated using the agent session token acquired through agentSessionCreate." :> ("agent" :> ("heartbeat" :> (ReqBody '[JSON] StartInfo :> (auth :> Post '[JSON] NoContent))))))
goodbye :: f :- (Summary "Report that an agent has stopped." :> (Description "Authenticated using the agent session token acquired through agentSessionCreate." :> ("agent" :> ("goodbye" :> (ReqBody '[JSON] StartInfo :> (auth :> Post '[JSON] NoContent))))))
getServiceInfo :: f :- (Summary "Service version and configuration." :> ("agent" :> ("service-info" :> Get '[JSON] ServiceInfo)))

Instances

Generic (LifeCycleAPI auth f) Source #
Instance details Defined in Hercules.API.Agent.LifeCycle Associated Types type Rep (LifeCycleAPI auth f) :: Type -> Type # Methods from :: LifeCycleAPI auth f -> Rep (LifeCycleAPI auth f) x # to :: Rep (LifeCycleAPI auth f) x -> LifeCycleAPI auth f #
type Rep (LifeCycleAPI auth f) Source #
Instance details Defined in Hercules.API.Agent.LifeCycle type Rep (LifeCycleAPI auth f) = D1 (MetaData "LifeCycleAPI" "Hercules.API.Agent.LifeCycle" "hercules-ci-api-agent-0.2.2.0-H8XBgIW1mHxGazLTBa2ark" False) (C1 (MetaCons "LifeCycleAPI" PrefixI True) ((S1 (MetaSel (Just "agentSessionCreate") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (f :- (Summary "Create a new agent session." :> (Description "Authenticated using the cluster join token acquired through POST /accounts/:accountId/clusterJoinTokens" :> ("agent" :> ("session" :> (ReqBody (JSON ': ([] :: [Type])) CreateAgentSession :> (auth :> Post (JSON ': ([] :: [Type])) Text)))))))) :: S1 (MetaSel (Just "hello") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (f :- (Summary "Update an agent session wrt features, versions, capabilities etc." :> (Description "Authenticated using the agent session token acquired through agentSessionCreate." :> ("agent" :> ("hello" :> (ReqBody (JSON ': ([] :: [Type])) Hello :> (auth :> Post (JSON ': ([] :: [Type])) NoContent))))))))) :: (S1 (MetaSel (Just "heartbeat") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (f :- (Summary "Update an agent session to indicate liveness." :> (Description "Authenticated using the agent session token acquired through agentSessionCreate." :> ("agent" :> ("heartbeat" :> (ReqBody (JSON ': ([] :: [Type])) StartInfo :> (auth :> Post (JSON ': ([] :: [Type])) NoContent)))))))) :: (S1 (MetaSel (Just "goodbye") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (f :- (Summary "Report that an agent has stopped." :> (Description "Authenticated using the agent session token acquired through agentSessionCreate." :> ("agent" :> ("goodbye" :> (ReqBody (JSON ': ([] :: [Type])) StartInfo :> (auth :> Post (JSON ': ([] :: [Type])) NoContent)))))))) :: S1 (MetaSel (Just "getServiceInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (f :- (Summary "Service version and configuration." :> ("agent" :> ("service-info" :> Get (JSON ': ([] :: [Type])) ServiceInfo)))))))))