Safe Haskell	Safe-Inferred
Language	Haskell2010

Gargantext.API.Admin.Orchestrator.Types

Contents

Orphan instances

Synopsis

data ExternalAPIs
- = OpenAlex
- | PubMed
- | Arxiv
- | HAL
- | IsTex
- | Isidore
- | EPO
externalAPIs :: [ExternalAPIs]
data ScraperInput = ScraperInput {
- _scin_spider :: !Text
- _scin_query :: !(Maybe Text)
- _scin_user :: !Text
- _scin_corpus :: !Int
- _scin_report_every :: !(Maybe Int)
- _scin_limit :: !(Maybe Int)
- _scin_local_file :: !(Maybe Text)
- _scin_count_only :: !(Maybe Bool)
}
scin_user :: Lens' ScraperInput Text
scin_spider :: Lens' ScraperInput Text
scin_report_every :: Lens' ScraperInput (Maybe Int)
scin_query :: Lens' ScraperInput (Maybe Text)
scin_local_file :: Lens' ScraperInput (Maybe Text)
scin_limit :: Lens' ScraperInput (Maybe Int)
scin_count_only :: Lens' ScraperInput (Maybe Bool)
scin_corpus :: Lens' ScraperInput Int
data ScraperEvent = ScraperEvent {
- _scev_message :: !(Maybe Text)
- _scev_level :: !(Maybe Text)
- _scev_date :: !(Maybe Text)
}
data JobLog = JobLog {
- _scst_succeeded :: !(Maybe Int)
- _scst_failed :: !(Maybe Int)
- _scst_remaining :: !(Maybe Int)
- _scst_events :: !(Maybe [ScraperEvent])
}
scst_succeeded :: Lens' JobLog (Maybe Int)
scst_remaining :: Lens' JobLog (Maybe Int)
scst_failed :: Lens' JobLog (Maybe Int)
scst_events :: Lens' JobLog (Maybe [ScraperEvent])
noJobLog :: JobLog
type ScrapersEnv = JobEnv JobLog JobLog
type ScraperAPI = AsyncJobsAPI JobLog ScraperInput JobLog
type AsyncJobs event ctI input output = AsyncJobsAPI' 'Unsafe 'Safe ctI '[JSON] Maybe event input output

Documentation

data ExternalAPIs #

Main Types TODO IsidoreAuth

Constructors

OpenAlex
PubMed
Arxiv
HAL
IsTex
Isidore
EPO

Instances

Instances details

Arbitrary ExternalAPIs #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods arbitrary :: Gen ExternalAPIs # shrink :: ExternalAPIs -> [ExternalAPIs] #
FromJSON ExternalAPIs #	Main Instances
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods parseJSON :: Value -> Parser ExternalAPIs # parseJSONList :: Value -> Parser [ExternalAPIs] #
ToJSON ExternalAPIs #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods toJSON :: ExternalAPIs -> Value # toEncoding :: ExternalAPIs -> Encoding # toJSONList :: [ExternalAPIs] -> Value # toEncodingList :: [ExternalAPIs] -> Encoding #
Bounded ExternalAPIs #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods minBound :: ExternalAPIs # maxBound :: ExternalAPIs #
Enum ExternalAPIs #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods succ :: ExternalAPIs -> ExternalAPIs # pred :: ExternalAPIs -> ExternalAPIs # toEnum :: Int -> ExternalAPIs # fromEnum :: ExternalAPIs -> Int # enumFrom :: ExternalAPIs -> [ExternalAPIs] # enumFromThen :: ExternalAPIs -> ExternalAPIs -> [ExternalAPIs] # enumFromTo :: ExternalAPIs -> ExternalAPIs -> [ExternalAPIs] # enumFromThenTo :: ExternalAPIs -> ExternalAPIs -> ExternalAPIs -> [ExternalAPIs] #
Generic ExternalAPIs #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Associated Types type Rep ExternalAPIs :: Type -> Type # Methods from :: ExternalAPIs -> Rep ExternalAPIs x # to :: Rep ExternalAPIs x -> ExternalAPIs #
Show ExternalAPIs #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods showsPrec :: Int -> ExternalAPIs -> ShowS # show :: ExternalAPIs -> String # showList :: [ExternalAPIs] -> ShowS #
Eq ExternalAPIs #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods (==) :: ExternalAPIs -> ExternalAPIs -> Bool # (/=) :: ExternalAPIs -> ExternalAPIs -> Bool #
ToSchema ExternalAPIs #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods declareNamedSchema :: Proxy ExternalAPIs -> Declare (Definitions Schema) NamedSchema #
type Rep ExternalAPIs #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types type Rep ExternalAPIs = D1 ('MetaData "ExternalAPIs" "Gargantext.API.Admin.Orchestrator.Types" "gargantext-0.0.7.1.5.3-inplace" 'False) ((C1 ('MetaCons "OpenAlex" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PubMed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Arxiv" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "HAL" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IsTex" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Isidore" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EPO" 'PrefixI 'False) (U1 :: Type -> Type))))

externalAPIs :: [ExternalAPIs] #

data ScraperInput #

Constructors

ScraperInput
Fields _scin_spider :: !Text _scin_query :: !(Maybe Text) _scin_user :: !Text _scin_corpus :: !Int _scin_report_every :: !(Maybe Int) _scin_limit :: !(Maybe Int) _scin_local_file :: !(Maybe Text) _scin_count_only :: !(Maybe Bool)

Instances

Instances details

FromJSON ScraperInput #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods parseJSON :: Value -> Parser ScraperInput # parseJSONList :: Value -> Parser [ScraperInput] #
Generic ScraperInput #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Associated Types type Rep ScraperInput :: Type -> Type # Methods from :: ScraperInput -> Rep ScraperInput x # to :: Rep ScraperInput x -> ScraperInput #
ToSchema ScraperInput #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods declareNamedSchema :: Proxy ScraperInput -> Declare (Definitions Schema) NamedSchema #
type Rep ScraperInput #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types type Rep ScraperInput = D1 ('MetaData "ScraperInput" "Gargantext.API.Admin.Orchestrator.Types" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "ScraperInput" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_scin_spider") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "_scin_query") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "_scin_user") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "_scin_corpus") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int))) :: ((S1 ('MetaSel ('Just "_scin_report_every") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "_scin_limit") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "_scin_local_file") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_scin_count_only") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Bool))))))

scin_user :: Lens' ScraperInput Text #

scin_spider :: Lens' ScraperInput Text #

scin_report_every :: Lens' ScraperInput (Maybe Int) #

scin_query :: Lens' ScraperInput (Maybe Text) #

scin_local_file :: Lens' ScraperInput (Maybe Text) #

scin_limit :: Lens' ScraperInput (Maybe Int) #

scin_count_only :: Lens' ScraperInput (Maybe Bool) #

scin_corpus :: Lens' ScraperInput Int #

data ScraperEvent #

Constructors

ScraperEvent
Fields _scev_message :: !(Maybe Text) _scev_level :: !(Maybe Text) _scev_date :: !(Maybe Text)

Instances

Instances details

Arbitrary ScraperEvent #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods arbitrary :: Gen ScraperEvent # shrink :: ScraperEvent -> [ScraperEvent] #
FromJSON ScraperEvent #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods parseJSON :: Value -> Parser ScraperEvent # parseJSONList :: Value -> Parser [ScraperEvent] #
ToJSON ScraperEvent #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods toJSON :: ScraperEvent -> Value # toEncoding :: ScraperEvent -> Encoding # toJSONList :: [ScraperEvent] -> Value # toEncodingList :: [ScraperEvent] -> Encoding #
Generic ScraperEvent #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Associated Types type Rep ScraperEvent :: Type -> Type # Methods from :: ScraperEvent -> Rep ScraperEvent x # to :: Rep ScraperEvent x -> ScraperEvent #
Show ScraperEvent #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods showsPrec :: Int -> ScraperEvent -> ShowS # show :: ScraperEvent -> String # showList :: [ScraperEvent] -> ShowS #
Eq ScraperEvent #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods (==) :: ScraperEvent -> ScraperEvent -> Bool # (/=) :: ScraperEvent -> ScraperEvent -> Bool #
GQLType ScraperEvent #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Associated Types type KIND ScraperEvent :: DerivingKind # Methods description :: f ScraperEvent -> Maybe Text # directives :: f ScraperEvent -> DirectiveUsages # getDescriptions :: f ScraperEvent -> Map Text Description # typeOptions :: f ScraperEvent -> GQLTypeOptions -> GQLTypeOptions # getDirectives :: f ScraperEvent -> Map Text (Directives CONST) # defaultValues :: f ScraperEvent -> Map Text (Value CONST) # __type :: f ScraperEvent -> TypeCategory -> TypeData
ToSchema ScraperEvent #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods declareNamedSchema :: Proxy ScraperEvent -> Declare (Definitions Schema) NamedSchema #
type Rep ScraperEvent #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types type Rep ScraperEvent = D1 ('MetaData "ScraperEvent" "Gargantext.API.Admin.Orchestrator.Types" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "ScraperEvent" 'PrefixI 'True) (S1 ('MetaSel ('Just "_scev_message") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "_scev_level") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "_scev_date") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)))))
type KIND ScraperEvent #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types type KIND ScraperEvent = TYPE

data JobLog #

Constructors

JobLog
Fields _scst_succeeded :: !(Maybe Int) _scst_failed :: !(Maybe Int) _scst_remaining :: !(Maybe Int) _scst_events :: !(Maybe [ScraperEvent])

Instances

Instances details

Arbitrary JobLog #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods arbitrary :: Gen JobLog # shrink :: JobLog -> [JobLog] #
FromJSON JobLog #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods parseJSON :: Value -> Parser JobLog # parseJSONList :: Value -> Parser [JobLog] #
ToJSON JobLog #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods toJSON :: JobLog -> Value # toEncoding :: JobLog -> Encoding # toJSONList :: [JobLog] -> Value # toEncodingList :: [JobLog] -> Encoding #
Generic JobLog #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Associated Types type Rep JobLog :: Type -> Type # Methods from :: JobLog -> Rep JobLog x # to :: Rep JobLog x -> JobLog #
Show JobLog #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods showsPrec :: Int -> JobLog -> ShowS # show :: JobLog -> String # showList :: [JobLog] -> ShowS #
Eq JobLog #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods (==) :: JobLog -> JobLog -> Bool # (/=) :: JobLog -> JobLog -> Bool #
GQLType JobLog #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Associated Types type KIND JobLog :: DerivingKind # Methods description :: f JobLog -> Maybe Text # directives :: f JobLog -> DirectiveUsages # getDescriptions :: f JobLog -> Map Text Description # typeOptions :: f JobLog -> GQLTypeOptions -> GQLTypeOptions # getDirectives :: f JobLog -> Map Text (Directives CONST) # defaultValues :: f JobLog -> Map Text (Value CONST) # __type :: f JobLog -> TypeCategory -> TypeData
ToSchema JobLog #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types Methods declareNamedSchema :: Proxy JobLog -> Declare (Definitions Schema) NamedSchema #
HasJobEnv Env JobLog JobLog #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods job_env :: Lens' Env (JobEnv JobLog JobLog) #
HasSwagger (WithCustomErrorScheme GargAPI) #
Instance details Defined in Gargantext.API.Routes Methods toSwagger :: Proxy (WithCustomErrorScheme GargAPI) -> Swagger #
HasEnv Env (Job JobLog JobLog) #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods _env :: Lens' Env (Env0 (Job JobLog JobLog)) #
MonadJob (GargM Env err) GargJob (Seq JobLog) JobLog #
Instance details Defined in Gargantext.API.Admin.EnvTypes Methods getJobEnv :: GargM Env err (JobEnv GargJob (Seq JobLog) JobLog) #
type Rep JobLog #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types type Rep JobLog = D1 ('MetaData "JobLog" "Gargantext.API.Admin.Orchestrator.Types" "gargantext-0.0.7.1.5.3-inplace" 'False) (C1 ('MetaCons "JobLog" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_scst_succeeded") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "_scst_failed") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "_scst_remaining") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "_scst_events") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe [ScraperEvent])))))
type KIND JobLog #
Instance details Defined in Gargantext.API.Admin.Orchestrator.Types type KIND JobLog = TYPE

scst_succeeded :: Lens' JobLog (Maybe Int) #

scst_remaining :: Lens' JobLog (Maybe Int) #

scst_failed :: Lens' JobLog (Maybe Int) #

scst_events :: Lens' JobLog (Maybe [ScraperEvent]) #

noJobLog :: JobLog #

type ScrapersEnv = JobEnv JobLog JobLog #

type ScraperAPI = AsyncJobsAPI JobLog ScraperInput JobLog #

type AsyncJobs event ctI input output = AsyncJobsAPI' 'Unsafe 'Safe ctI '[JSON] Maybe event input output #

Orphan instances

ToParamSchema Limit #
Instance details Methods toParamSchema :: forall (t :: SwaggerKind Type). Proxy Limit -> ParamSchema t #
ToParamSchema Offset #
Instance details Methods toParamSchema :: forall (t :: SwaggerKind Type). Proxy Offset -> ParamSchema t #
ToSchema URL #
Instance details Methods declareNamedSchema :: Proxy URL -> Declare (Definitions Schema) NamedSchema #
Arbitrary a => Arbitrary (JobOutput a) #
Instance details Methods arbitrary :: Gen (JobOutput a) # shrink :: JobOutput a -> [JobOutput a] #
Arbitrary a => Arbitrary (JobStatus 'Safe a) #
Instance details Methods arbitrary :: Gen (JobStatus 'Safe a) # shrink :: JobStatus 'Safe a -> [JobStatus 'Safe a] #