Hercules.API.Agent.State

Documentation

type ContentLength = Header "Content-Length" Integer

data StateAPI auth f

Constructors

StateAPI

Fields

• getState :: f :- ("current-task" :> ("state" :> (Capture' '[Required] "name" Text :> ("data" :> (auth :> StreamGet NoFraming OctetStream (Headers '[ContentLength] (SourceIO ByteString)))))))
• putState :: f :- ("current-task" :> ("state" :> (Capture' '[Required] "name" Text :> ("data" :> (StreamBody NoFraming OctetStream (SourceIO ByteString) :> (ContentLength :> (auth :> Put '[JSON] NoContent)))))))

Instances

Generic (StateAPI auth f)

Defined in Hercules.API.Agent.State

Associated Types

type Rep (StateAPI auth f) :: Type -> Type

Methods

from :: StateAPI auth f -> Rep (StateAPI auth f) x

to :: Rep (StateAPI auth f) x -> StateAPI auth f

type Rep (StateAPI auth f)

Defined in Hercules.API.Agent.State

type Rep (StateAPI auth f) = D1 ('MetaData "StateAPI" "Hercules.API.Agent.State" "hercules-ci-api-agent-0.5.0.0-inplace" 'False) (C1 ('MetaCons "StateAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "getState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- ("current-task" :> ("state" :> (Capture' '[Required] "name" Text :> ("data" :> (auth :> StreamGet NoFraming OctetStream (Headers '[ContentLength] (SourceIO ByteString))))))))) :*: S1 ('MetaSel ('Just "putState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- ("current-task" :> ("state" :> (Capture' '[Required] "name" Text :> ("data" :> (StreamBody NoFraming OctetStream (SourceIO ByteString) :> (ContentLength :> (auth :> Put '[JSON] NoContent)))))))))))