Safe Haskell	Safe-Inferred
Language	Haskell2010

Hercules.API.Effects

Documentation

data EffectsAPI auth f Source #

Constructors

EffectsAPI

Fields

getEffect :: f :- (Summary "Read effect events" :> ("jobs" :> (Capture "jobId" (Id Job) :> ("effects" :> (Capture "attribute" AttributePath :> (auth :> Get '[JSON] EffectInfo))))))
getEffectLog :: 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))))))))))
cancelEffect :: 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)))))))

Instances

Instances details

Generic (EffectsAPI auth f) Source #
Instance details Defined in Hercules.API.Effects Associated Types type Rep (EffectsAPI auth f) :: Type -> Type # Methods from :: EffectsAPI auth f -> Rep (EffectsAPI auth f) x # to :: Rep (EffectsAPI auth f) x -> EffectsAPI auth f #
type Rep (EffectsAPI auth f) Source #
Instance details Defined in Hercules.API.Effects type Rep (EffectsAPI auth f) = D1 ('MetaData "EffectsAPI" "Hercules.API.Effects" "hercules-ci-api-0.8.0.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))))))))))))