Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Documentation
data EffectsAPI auth f Source #
EffectsAPI | |
|
Instances
Generic (EffectsAPI auth f) Source # | |
Defined in Hercules.API.Effects from :: EffectsAPI auth f -> Rep (EffectsAPI auth f) x Source # to :: Rep (EffectsAPI auth f) x -> EffectsAPI auth f Source # | |
type Rep (EffectsAPI auth f) Source # | |
Defined in Hercules.API.Effects type Rep (EffectsAPI auth f) = D1 ('MetaData "EffectsAPI" "Hercules.API.Effects" "hercules-ci-api-0.8.1.0-inplace" 'False) (C1 ('MetaCons "EffectsAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "getEffect") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Read effect events" :> ("jobs" :> (Capture "jobId" (Id Job) :> ("effects" :> (Capture "attribute" AttributePath :> (auth :> Get '[JSON] EffectInfo)))))))) :*: (S1 ('MetaSel ('Just "getEffectLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Read all recorded log entries" :> ("jobs" :> (Capture "jobId" (Id Job) :> ("effects" :> (Capture "attribute" AttributePath :> ("log" :> ("lines" :> (QueryParam' '[Required] "logId" (Id "log") :> (QueryParam' '[Optional] "iMin" Int :> (auth :> Get '[JSON] Log)))))))))))) :*: S1 ('MetaSel ('Just "cancelEffect") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Cancel the effect. It will cause the Job to have a failed status." :> ("jobs" :> (Capture "jobId" (Id Job) :> ("effects" :> (Capture "attribute" AttributePath :> ("cancel" :> (auth :> Post '[JSON] NoContent)))))))))))) |