Hercules.API.Projects.Job

Documentation

data Job

Constructors

Job

Fields

• id :: Id Job
• projectId :: Id Project
• index :: Int64
• repoName :: Name Project
• ownerName :: Name Account
• forgeName :: Name Forge
• repoId :: Id Repo
• startTime :: UTCTime
• endTime :: Maybe UTCTime
• jobPhase :: JobPhase
• isCancelled :: Bool
• jobStatus :: JobStatus
• evaluationStatus :: JobStatus
• derivationStatus :: JobStatus
• effectsStatus :: JobStatus
• evaluationId :: Id Evaluation
• source :: GitCommitSource
• extraInputs :: Map Text ImmutableInput

  This is only correct when querying a single Job.

• jobType :: JobType
• jobName :: Maybe Text
• rerunOf :: Maybe (Id Job)
• rerunOfIndex :: Maybe Int
• startedBy :: Maybe (Id Account)
• cancelledBy :: Maybe (Id Account)
• mayCancel :: Bool
• mayRerun :: Bool

Instances

FromJSON Job

Defined in Hercules.API.Projects.Job

Methods

parseJSON :: Value -> Parser Job

parseJSONList :: Value -> Parser [Job]

ToJSON Job

Defined in Hercules.API.Projects.Job

Methods

toJSON :: Job -> Value

toEncoding :: Job -> Encoding

toJSONList :: [Job] -> Value

toEncodingList :: [Job] -> Encoding

Generic Job

Defined in Hercules.API.Projects.Job

Associated Types

type Rep Job :: Type -> Type

Methods

from :: Job -> Rep Job x

to :: Rep Job x -> Job

Show Job

Defined in Hercules.API.Projects.Job

Methods

showsPrec :: Int -> Job -> ShowS

show :: Job -> String

showList :: [Job] -> ShowS

NFData Job

Defined in Hercules.API.Projects.Job

Methods

rnf :: Job -> ()

Eq Job

Defined in Hercules.API.Projects.Job

Methods

(==) :: Job -> Job -> Bool

(/=) :: Job -> Job -> Bool

ToSchema Job

Defined in Hercules.API.Projects.Job

Methods

declareNamedSchema :: Proxy Job -> Declare (Definitions Schema) NamedSchema

ToSchema Job

Defined in Hercules.API.Projects.Job

Methods

declareNamedSchema :: Proxy Job -> Declare (Definitions Schema) NamedSchema

HasField "get" PagedJobs (PagedResponse Job)

Defined in Hercules.API.Projects

Methods

getField :: PagedJobs -> PagedResponse Job

type Rep Job

Defined in Hercules.API.Projects.Job

type Rep Job = D1 ('MetaData "Job" "Hercules.API.Projects.Job" "hercules-ci-api-0.8.4.0-inplace" 'False) (C1 ('MetaCons "Job" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Id Job)) :*: (S1 ('MetaSel ('Just "projectId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Id Project)) :*: S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64))) :*: (S1 ('MetaSel ('Just "repoName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Name Project)) :*: (S1 ('MetaSel ('Just "ownerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Name Account)) :*: S1 ('MetaSel ('Just "forgeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Name Forge))))) :*: ((S1 ('MetaSel ('Just "repoId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Id Repo)) :*: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe UTCTime)))) :*: ((S1 ('MetaSel ('Just "jobPhase") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JobPhase) :*: S1 ('MetaSel ('Just "isCancelled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JobStatus) :*: S1 ('MetaSel ('Just "evaluationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JobStatus))))) :*: (((S1 ('MetaSel ('Just "derivationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JobStatus) :*: (S1 ('MetaSel ('Just "effectsStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JobStatus) :*: S1 ('MetaSel ('Just "evaluationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Id Evaluation)))) :*: (S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GitCommitSource) :*: (S1 ('MetaSel ('Just "extraInputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text ImmutableInput)) :*: S1 ('MetaSel ('Just "jobType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JobType)))) :*: ((S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "rerunOf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Id Job))) :*: S1 ('MetaSel ('Just "rerunOfIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "startedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Id Account))) :*: S1 ('MetaSel ('Just "cancelledBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Id Account)))) :*: (S1 ('MetaSel ('Just "mayCancel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "mayRerun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))))))

data JobType

Constructors

Config

Legacy

OnPush

OnSchedule

Instances

FromJSON JobType

Defined in Hercules.API.Projects.Job

Methods

parseJSON :: Value -> Parser JobType

parseJSONList :: Value -> Parser [JobType]

ToJSON JobType

Defined in Hercules.API.Projects.Job

Methods

toJSON :: JobType -> Value

toEncoding :: JobType -> Encoding

toJSONList :: [JobType] -> Value

toEncodingList :: [JobType] -> Encoding

Bounded JobType

Defined in Hercules.API.Projects.Job

Methods

minBound :: JobType

maxBound :: JobType

Enum JobType

Defined in Hercules.API.Projects.Job

Methods

succ :: JobType -> JobType

pred :: JobType -> JobType

toEnum :: Int -> JobType

fromEnum :: JobType -> Int

enumFrom :: JobType -> [JobType]

enumFromThen :: JobType -> JobType -> [JobType]

enumFromTo :: JobType -> JobType -> [JobType]

enumFromThenTo :: JobType -> JobType -> JobType -> [JobType]

Generic JobType

Defined in Hercules.API.Projects.Job

Associated Types

type Rep JobType :: Type -> Type

Methods

from :: JobType -> Rep JobType x

to :: Rep JobType x -> JobType

Read JobType

Defined in Hercules.API.Projects.Job

Methods

readsPrec :: Int -> ReadS JobType

readList :: ReadS [JobType]

readPrec :: ReadPrec JobType

readListPrec :: ReadPrec [JobType]

Show JobType

Defined in Hercules.API.Projects.Job

Methods

showsPrec :: Int -> JobType -> ShowS

show :: JobType -> String

showList :: [JobType] -> ShowS

NFData JobType

Defined in Hercules.API.Projects.Job

Methods

rnf :: JobType -> ()

Eq JobType

Defined in Hercules.API.Projects.Job

Methods

(==) :: JobType -> JobType -> Bool

(/=) :: JobType -> JobType -> Bool

FromHttpApiData JobType

Defined in Hercules.API.Projects.Job

Methods

parseUrlPiece :: Text -> Either Text JobType

parseHeader :: ByteString -> Either Text JobType

parseQueryParam :: Text -> Either Text JobType

ToHttpApiData JobType

Defined in Hercules.API.Projects.Job

Methods

toUrlPiece :: JobType -> Text

toEncodedUrlPiece :: JobType -> Builder

toHeader :: JobType -> ByteString

toQueryParam :: JobType -> Text

toEncodedQueryParam :: JobType -> Builder

ToParamSchema JobType

Defined in Hercules.API.Projects.Job

Methods

toParamSchema :: Proxy JobType -> Schema

ToSchema JobType

Defined in Hercules.API.Projects.Job

Methods

declareNamedSchema :: Proxy JobType -> Declare (Definitions Schema) NamedSchema

ToParamSchema JobType

Defined in Hercules.API.Projects.Job

Methods

toParamSchema :: forall (t :: SwaggerKind Type). Proxy JobType -> ParamSchema t

ToSchema JobType

Defined in Hercules.API.Projects.Job

Methods

declareNamedSchema :: Proxy JobType -> Declare (Definitions Schema) NamedSchema

type Rep JobType

Defined in Hercules.API.Projects.Job

type Rep JobType = D1 ('MetaData "JobType" "Hercules.API.Projects.Job" "hercules-ci-api-0.8.4.0-inplace" 'False) ((C1 ('MetaCons "Config" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Legacy" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "OnPush" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OnSchedule" 'PrefixI 'False) (U1 :: Type -> Type)))

data ProjectAndJobs

Constructors

ProjectAndJobs

Fields

• project :: Project
• jobs :: [Job]

Instances

FromJSON ProjectAndJobs

Defined in Hercules.API.Projects.Job

Methods

parseJSON :: Value -> Parser ProjectAndJobs

parseJSONList :: Value -> Parser [ProjectAndJobs]

ToJSON ProjectAndJobs

Defined in Hercules.API.Projects.Job

Methods

toJSON :: ProjectAndJobs -> Value

toEncoding :: ProjectAndJobs -> Encoding

toJSONList :: [ProjectAndJobs] -> Value

toEncodingList :: [ProjectAndJobs] -> Encoding

Generic ProjectAndJobs

Defined in Hercules.API.Projects.Job

Associated Types

type Rep ProjectAndJobs :: Type -> Type

Methods

from :: ProjectAndJobs -> Rep ProjectAndJobs x

to :: Rep ProjectAndJobs x -> ProjectAndJobs

Show ProjectAndJobs

Defined in Hercules.API.Projects.Job

Methods

showsPrec :: Int -> ProjectAndJobs -> ShowS

show :: ProjectAndJobs -> String

showList :: [ProjectAndJobs] -> ShowS

NFData ProjectAndJobs

Defined in Hercules.API.Projects.Job

Methods

rnf :: ProjectAndJobs -> ()

Eq ProjectAndJobs

Defined in Hercules.API.Projects.Job

Methods

(==) :: ProjectAndJobs -> ProjectAndJobs -> Bool

(/=) :: ProjectAndJobs -> ProjectAndJobs -> Bool

ToSchema ProjectAndJobs

Defined in Hercules.API.Projects.Job

Methods

declareNamedSchema :: Proxy ProjectAndJobs -> Declare (Definitions Schema) NamedSchema

ToSchema ProjectAndJobs

Defined in Hercules.API.Projects.Job

Methods

declareNamedSchema :: Proxy ProjectAndJobs -> Declare (Definitions Schema) NamedSchema

type Rep ProjectAndJobs

Defined in Hercules.API.Projects.Job

type Rep ProjectAndJobs = D1 ('MetaData "ProjectAndJobs" "Hercules.API.Projects.Job" "hercules-ci-api-0.8.4.0-inplace" 'False) (C1 ('MetaCons "ProjectAndJobs" 'PrefixI 'True) (S1 ('MetaSel ('Just "project") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Project) :*: S1 ('MetaSel ('Just "jobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Job])))

data GitCommitSource

Constructors

GitCommitSource

Fields

• revision :: Text
• ref :: Text
• message :: Text
• gitCommitterName :: Text
• committer :: Maybe Account
• link :: Text

Instances

FromJSON GitCommitSource

Defined in Hercules.API.Projects.Job

Methods

parseJSON :: Value -> Parser GitCommitSource

parseJSONList :: Value -> Parser [GitCommitSource]

ToJSON GitCommitSource

Defined in Hercules.API.Projects.Job

Methods

toJSON :: GitCommitSource -> Value

toEncoding :: GitCommitSource -> Encoding

toJSONList :: [GitCommitSource] -> Value

toEncodingList :: [GitCommitSource] -> Encoding

Generic GitCommitSource

Defined in Hercules.API.Projects.Job

Associated Types

type Rep GitCommitSource :: Type -> Type

Methods

from :: GitCommitSource -> Rep GitCommitSource x

to :: Rep GitCommitSource x -> GitCommitSource

Show GitCommitSource

Defined in Hercules.API.Projects.Job

Methods

showsPrec :: Int -> GitCommitSource -> ShowS

show :: GitCommitSource -> String

showList :: [GitCommitSource] -> ShowS

NFData GitCommitSource

Defined in Hercules.API.Projects.Job

Methods

rnf :: GitCommitSource -> ()

Eq GitCommitSource

Defined in Hercules.API.Projects.Job

Methods

(==) :: GitCommitSource -> GitCommitSource -> Bool

(/=) :: GitCommitSource -> GitCommitSource -> Bool

ToSchema GitCommitSource

Defined in Hercules.API.Projects.Job

Methods

declareNamedSchema :: Proxy GitCommitSource -> Declare (Definitions Schema) NamedSchema

ToSchema GitCommitSource

Defined in Hercules.API.Projects.Job

Methods

declareNamedSchema :: Proxy GitCommitSource -> Declare (Definitions Schema) NamedSchema

type Rep GitCommitSource

Defined in Hercules.API.Projects.Job

type Rep GitCommitSource = D1 ('MetaData "GitCommitSource" "Hercules.API.Projects.Job" "hercules-ci-api-0.8.4.0-inplace" 'False) (C1 ('MetaCons "GitCommitSource" 'PrefixI 'True) ((S1 ('MetaSel ('Just "revision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "ref") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "gitCommitterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "committer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Account)) :*: S1 ('MetaSel ('Just "link") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))))

data JobStatus

Constructors

Pending

Failure

Success

Instances

FromJSON JobStatus

Defined in Hercules.API.Projects.SimpleJob

Methods

parseJSON :: Value -> Parser JobStatus

parseJSONList :: Value -> Parser [JobStatus]

ToJSON JobStatus

Defined in Hercules.API.Projects.SimpleJob

Methods

toJSON :: JobStatus -> Value

toEncoding :: JobStatus -> Encoding

toJSONList :: [JobStatus] -> Value

toEncodingList :: [JobStatus] -> Encoding

Monoid JobStatus

mappend: Whichever is "worse": Failure wins out, otherwise Pending wins out, otherwise all are Success.

mempty: Success

Defined in Hercules.API.Projects.SimpleJob

Methods

mempty :: JobStatus

mappend :: JobStatus -> JobStatus -> JobStatus

mconcat :: [JobStatus] -> JobStatus

Semigroup JobStatus

Whichever is "worse": Failure wins out, otherwise Pending wins out, otherwise all are Success.

Defined in Hercules.API.Projects.SimpleJob

Methods

(<>) :: JobStatus -> JobStatus -> JobStatus

sconcat :: NonEmpty JobStatus -> JobStatus

stimes :: Integral b => b -> JobStatus -> JobStatus

Generic JobStatus

Defined in Hercules.API.Projects.SimpleJob

Associated Types

type Rep JobStatus :: Type -> Type

Methods

from :: JobStatus -> Rep JobStatus x

to :: Rep JobStatus x -> JobStatus

Show JobStatus

Defined in Hercules.API.Projects.SimpleJob

Methods

showsPrec :: Int -> JobStatus -> ShowS

show :: JobStatus -> String

showList :: [JobStatus] -> ShowS

NFData JobStatus

Defined in Hercules.API.Projects.SimpleJob

Methods

rnf :: JobStatus -> ()

Eq JobStatus

Defined in Hercules.API.Projects.SimpleJob

Methods

(==) :: JobStatus -> JobStatus -> Bool

(/=) :: JobStatus -> JobStatus -> Bool

ToSchema JobStatus

Defined in Hercules.API.Projects.SimpleJob

Methods

declareNamedSchema :: Proxy JobStatus -> Declare (Definitions Schema) NamedSchema

ToSchema JobStatus

Defined in Hercules.API.Projects.SimpleJob

Methods

declareNamedSchema :: Proxy JobStatus -> Declare (Definitions Schema) NamedSchema

type Rep JobStatus

Defined in Hercules.API.Projects.SimpleJob

type Rep JobStatus = D1 ('MetaData "JobStatus" "Hercules.API.Projects.SimpleJob" "hercules-ci-api-0.8.4.0-inplace" 'False) (C1 ('MetaCons "Pending" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Failure" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Success" 'PrefixI 'False) (U1 :: Type -> Type)))

data JobPhase

Constructors

Queued

Evaluating

Building

Effects

Done

Instances

FromJSON JobPhase

Defined in Hercules.API.Projects.SimpleJob

Methods

parseJSON :: Value -> Parser JobPhase

parseJSONList :: Value -> Parser [JobPhase]

ToJSON JobPhase

Defined in Hercules.API.Projects.SimpleJob

Methods

toJSON :: JobPhase -> Value

toEncoding :: JobPhase -> Encoding

toJSONList :: [JobPhase] -> Value

toEncodingList :: [JobPhase] -> Encoding

Generic JobPhase

Defined in Hercules.API.Projects.SimpleJob

Associated Types

type Rep JobPhase :: Type -> Type

Methods

from :: JobPhase -> Rep JobPhase x

to :: Rep JobPhase x -> JobPhase

Show JobPhase

Defined in Hercules.API.Projects.SimpleJob

Methods

showsPrec :: Int -> JobPhase -> ShowS

show :: JobPhase -> String

showList :: [JobPhase] -> ShowS

NFData JobPhase

Defined in Hercules.API.Projects.SimpleJob

Methods

rnf :: JobPhase -> ()

Eq JobPhase

Defined in Hercules.API.Projects.SimpleJob

Methods

(==) :: JobPhase -> JobPhase -> Bool

(/=) :: JobPhase -> JobPhase -> Bool

ToSchema JobPhase

Defined in Hercules.API.Projects.SimpleJob

Methods

declareNamedSchema :: Proxy JobPhase -> Declare (Definitions Schema) NamedSchema

ToSchema JobPhase

Defined in Hercules.API.Projects.SimpleJob

Methods

declareNamedSchema :: Proxy JobPhase -> Declare (Definitions Schema) NamedSchema

type Rep JobPhase

Defined in Hercules.API.Projects.SimpleJob

type Rep JobPhase = D1 ('MetaData "JobPhase" "Hercules.API.Projects.SimpleJob" "hercules-ci-api-0.8.4.0-inplace" 'False) ((C1 ('MetaCons "Queued" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Evaluating" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Building" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Effects" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Done" 'PrefixI 'False) (U1 :: Type -> Type))))