Safe Haskell	None
Language	GHC2024

Arbiter.Servant.Types

Contents

Jobs
DLQ and archive
Pages
Leases
Queues and stats
Maintenance
Cron and workers
Admission policies
Health
Re-exported core types

Description

Request and response types for the Arbiter REST API.

Synopsis

data ApiJobWithStatus payload = ApiJobWithStatus {
- ajwsJob :: JobRead payload
- ajwsStatus :: JobStatus
}
newtype ApiJobWrite payload = ApiJobWrite {
- unApiJobWrite :: JobWrite payload
}
newtype JobResponse a = JobResponse {
- job :: a
}
data JobsResponse payload = JobsResponse {
- jobsPage :: Page (ApiJobWithStatus (Stored payload))
- childCounts :: Map Int64 Int64
- pausedParents :: [Int64]
- dlqChildCounts :: Map Int64 Int64
}
newtype RescheduleRequest = RescheduleRequest {
- runAt :: UTCTime
}
newtype DLQRetentionRequest = DLQRetentionRequest {
- retentionSeconds :: Maybe Double
}
newtype BatchInsertRequest payload = BatchInsertRequest {
- jobs :: [ApiJobWrite payload]
}
data BatchInsertResponse payload = BatchInsertResponse {
- inserted :: [JobRead payload]
- insertedCount :: Int
}
newtype PayloadEdit payload = PayloadEdit {
- editPayload :: payload
}
data OptionalJSON
newtype BatchDeleteRequest = BatchDeleteRequest {
- ids :: [Int64]
}
newtype BatchDeleteResponse = BatchDeleteResponse {
- deleted :: Int64
}
newtype BatchRetryRequest = BatchRetryRequest {
- ids :: [Int64]
}
newtype BatchRetryResponse = BatchRetryResponse {
- retried :: Int64
}
data Page a = Page {
- pageItems :: [a]
- pageTotal :: Int
- pageOffset :: Int
- pageLimit :: Int
}
newtype PageSize (def :: Nat) = PageSize {
- unPageSize :: Int
}
type PageLimit = PageSize 50
type KeyPageLimit = PageSize 100
pageSizeDefault :: forall (def :: Nat) proxy. KnownNat def => proxy def -> Int
pageLimitRange :: (Int, Int)
newtype Items a = Items {
- items :: [a]
}
type ArchiveResponse payload = Page (ArchiveJob (Stored payload))
type DLQResponse payload = Page (DLQJob (Stored payload))
type GroupsResponse = Page GroupSummary
data ClaimRequest = ClaimRequest {
- maxJobs :: Maybe Int
- leaseSeconds :: Maybe Double
}
claimJobsRange :: (Int, Int)
defaultClaimJobs :: Int
leaseSecondsRange :: (Double, Double)
defaultLeaseSeconds :: Double
newtype ClaimResponse payload = ClaimResponse {
- jobs :: [JobRead payload]
}
data JobLease = JobLease {
- jlClaimSeq :: Int64
- jlClaimedBy :: UUID
}
data AckRequest result = AckRequest {
- arLease :: JobLease
- arResult :: Maybe result
}
data ExtendRequest = ExtendRequest {
- erLease :: JobLease
- erSeconds :: Double
}
data StatsResponse = StatsResponse {
- stats :: QueueStats
- timestamp :: UTCTime
}
newtype AllStatsResponse = AllStatsResponse {
- queues :: [QueueOverview]
}
newtype QueuesResponse = QueuesResponse {
- queues :: [Text]
}
data MaintenanceResponse = MaintenanceResponse {
- maintenanceOps :: Map Text Int64
- maintenanceFailed :: [Text]
}
data CronScheduleView = CronScheduleView {
- schedule :: CronScheduleRow
- nextRunAt :: Maybe UTCTime
}
newtype CronSchedulesResponse = CronSchedulesResponse {
- schedules :: [CronScheduleView]
}
newtype WorkersResponse = WorkersResponse {
- workers :: [WorkerRow]
}
newtype RateLimitPoliciesResponse = RateLimitPoliciesResponse {
- policies :: [RateLimitPolicyView]
}
type RateLimitBucketsResponse = Items RateLimitBucketView
newtype RateLimitResetResponse = RateLimitResetResponse {
- reset :: Int64
}
newtype AddTokensRequest = AddTokensRequest {
- addedTokens :: Double
}
newtype AddTokensResponse = AddTokensResponse {
- woken :: Int64
}
newtype PruneResponse = PruneResponse {
- pruned :: Int64
}
newtype ConcurrencyPoliciesResponse = ConcurrencyPoliciesResponse {
- policies :: [ConcurrencyPolicyView]
}
type ConcurrencyKeysResponse = Items ConcurrencyKeyView
newtype ConcurrencyReconcileResponse = ConcurrencyReconcileResponse {
- reconciled :: Int64
}
data HealthStatus
- = Ok
- | Down
healthStatusToText :: HealthStatus -> Text
data HealthResponse = HealthResponse {
- status :: HealthStatus
- schemaName :: Text
- checkedAt :: UTCTime
- dbLatencyMs :: Maybe Double
- db :: Maybe PgDbHealth
}
newtype LivenessResponse = LivenessResponse {
- alive :: Bool
}
data CronScheduleRow = CronScheduleRow {
- name :: Text
- queueName :: Text
- defaultExpression :: Text
- defaultOverlap :: Text
- defaultTimezone :: Maybe Text
- overrideExpression :: Maybe Text
- overrideOverlap :: Maybe Text
- overrideTimezone :: Maybe Text
- enabled :: Bool
- lastFiredAt :: Maybe UTCTime
- lastCheckedAt :: Maybe UTCTime
- runRequestedAt :: Maybe UTCTime
- lastManualRunAt :: Maybe UTCTime
- createdAt :: UTCTime
- updatedAt :: UTCTime
}
data CronScheduleUpdate = CronScheduleUpdate {
- overrideExpression :: Maybe (Maybe Text)
- overrideOverlap :: Maybe (Maybe Text)
- overrideTimezone :: Maybe (Maybe Text)
- enabled :: Maybe Bool
}
data QueueOverview = QueueOverview {
- overviewQueue :: Text
- overviewStats :: QueueStats
- overviewQueuePaused :: Bool
- overviewWorkersLive :: Int64
- overviewWorkersPaused :: Int64
}
data QueueStats = QueueStats {
- totalJobs :: Int64
- readyJobs :: Int64
- inFlightJobs :: Int64
- scheduledJobs :: Int64
- backoffJobs :: Int64
- throttledJobs :: Int64
- suspendedJobs :: Int64
- cancelledJobs :: Int64
- exhaustedJobs :: Int64
- blockedJobs :: Int64
- oldestReadyAgeSeconds :: Maybe Double
- oldestInFlightAgeSeconds :: Maybe Double
- dlqJobs :: Int64
- kindCounts :: Map Text Int64
- dlqKindCounts :: Map Text Int64
}
data QueueRow = QueueRow {
- queueName :: Text
- paused :: Bool
- pausedAt :: Maybe UTCTime
- metadata :: Maybe Value
- createdAt :: UTCTime
- updatedAt :: UTCTime
- dlqRetention :: Maybe NominalDiffTime
}
data WorkerRow = WorkerRow {
- workerId :: UUID
- queueName :: Text
- hostName :: Maybe Text
- workerCount :: Maybe Int32
- startedAt :: UTCTime
- lastHeartbeat :: UTCTime
- shuttingDown :: Bool
- paused :: Bool
- staleThresholdSecs :: Double
- metadata :: Maybe Value
- health :: WorkerHealth
}
data RateLimitPolicyView = RateLimitPolicyView {
- prefix :: Text
- defaultMaxTokens :: Double
- defaultRefillAmount :: Double
- defaultInterval :: Double
- overrideMaxTokens :: Maybe Double
- overrideRefillAmount :: Maybe Double
- overrideInterval :: Maybe Double
- bucketCount :: Int64
- throttledCount :: Int64
- throttledQueues :: [Text]
- minTokens :: Maybe Double
- avgTokens :: Maybe Double
}
data RateLimitBucketView = RateLimitBucketView {
- rateLimitKey :: Text
- rateLimitPrefix :: Text
- tokens :: Double
- maxTokens :: Double
- fillFraction :: Maybe Double
- lastRefill :: UTCTime
}
data RateLimitPolicyUpdate = RateLimitPolicyUpdate {
- overrideMaxTokens :: Maybe (Maybe Double)
- overrideRefillAmount :: Maybe (Maybe Double)
- overrideInterval :: Maybe (Maybe Double)
}
data ConcurrencyPolicyView = ConcurrencyPolicyView {
- prefix :: Text
- defaultLimit :: Int32
- overrideLimit :: Maybe Int32
- keyCount :: Int64
- totalInFlight :: Int64
- maxInFlight :: Maybe Int32
}
data ConcurrencyKeyView = ConcurrencyKeyView {
- concurrencyKey :: Text
- concurrencyPrefix :: Text
- inFlight :: Int32
- effectiveLimit :: Int32
- fillFraction :: Maybe Double
}
data ConcurrencyPolicyUpdate = ConcurrencyPolicyUpdate {
- overrideLimit :: Maybe (Maybe Int32)
}
data PgDbHealth = PgDbHealth {
- numBackends :: Int64
- connActive :: Int64
- connIdle :: Int64
- connIdleInTxn :: Int64
- connIdleInTxnAborted :: Int64
- connBlocked :: Int64
- connOther :: Int64
- oldestTxnAge :: Double
- oldestQueryAge :: Double
}
data GroupSummary = GroupSummary {
- gsGroupKey :: Text
- gsJobCount :: Int64
- gsReadyCount :: Int64
- gsNextDue :: Maybe UTCTime
- gsInFlightUntil :: Maybe UTCTime
- gsInFlight :: Bool
- gsHeadJobId :: Maybe Int64
- gsHeadStatus :: Maybe JobStatus
- gsHeadBlocked :: Bool
}

Jobs

data ApiJobWithStatus payloadSource #

A job row plus its SQL-derived status, for the list and detail endpoints.

Constructors

ApiJobWithStatus
Fields ajwsJob :: JobRead payload The job. Its fields are flattened into the object. ajwsStatus :: JobStatus

Instances

Instances details

FromJSON payload => FromJSON (ApiJobWithStatus payload) Source #
Instance details Defined in Arbiter.Servant.Types Methods parseJSON :: Value -> Parser (ApiJobWithStatus payload)# parseJSONList :: Value -> Parser [ApiJobWithStatus payload]# omittedField :: Maybe (ApiJobWithStatus payload)#
ToJSON payload => ToJSON (ApiJobWithStatus payload) Source #
Instance details Defined in Arbiter.Servant.Types Methods toJSON :: ApiJobWithStatus payload -> Value# toEncoding :: ApiJobWithStatus payload -> Encoding# toJSONList :: [ApiJobWithStatus payload] -> Value# toEncodingList :: [ApiJobWithStatus payload] -> Encoding# omitField :: ApiJobWithStatus payload -> Bool#
Eq payload => Eq (ApiJobWithStatus payload) Source #
Instance details Defined in Arbiter.Servant.Types Methods (==) :: ApiJobWithStatus payload -> ApiJobWithStatus payload -> Bool# (/=) :: ApiJobWithStatus payload -> ApiJobWithStatus payload -> Bool#
Show payload => Show (ApiJobWithStatus payload) Source #
Instance details Defined in Arbiter.Servant.Types Methods showsPrec :: Int -> ApiJobWithStatus payload -> ShowS# show :: ApiJobWithStatus payload -> String# showList :: [ApiJobWithStatus payload] -> ShowS#

newtype ApiJobWrite payloadSource #

Write-side job for REST insertion. Lineage, suspension and trace fields are not settable.

Constructors

ApiJobWrite
Fields unApiJobWrite :: JobWrite payload The job to insert. Its settable fields are flattened into the object.

Instances

Instances details

FromJSON payload => FromJSON (ApiJobWrite payload) Source #
Instance details Defined in Arbiter.Servant.Types Methods parseJSON :: Value -> Parser (ApiJobWrite payload)# parseJSONList :: Value -> Parser [ApiJobWrite payload]# omittedField :: Maybe (ApiJobWrite payload)#
ToJSON payload => ToJSON (ApiJobWrite payload) Source #
Instance details Defined in Arbiter.Servant.Types Methods toJSON :: ApiJobWrite payload -> Value# toEncoding :: ApiJobWrite payload -> Encoding# toJSONList :: [ApiJobWrite payload] -> Value# toEncodingList :: [ApiJobWrite payload] -> Encoding# omitField :: ApiJobWrite payload -> Bool#
Eq payload => Eq (ApiJobWrite payload) Source #
Instance details Defined in Arbiter.Servant.Types Methods (==) :: ApiJobWrite payload -> ApiJobWrite payload -> Bool# (/=) :: ApiJobWrite payload -> ApiJobWrite payload -> Bool#
Show payload => Show (ApiJobWrite payload) Source #
Instance details Defined in Arbiter.Servant.Types Methods showsPrec :: Int -> ApiJobWrite payload -> ShowS# show :: ApiJobWrite payload -> String# showList :: [ApiJobWrite payload] -> ShowS#

newtype JobResponse aSource #

Single-job response envelope, parameterized over the job representation (JobRead for insert, ApiJobWithStatus for the detail endpoint).

Constructors

JobResponse
Fields job :: a

Instances

Instances details

FromJSON a => FromJSON (JobResponse a) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser (JobResponse a)#

parseJSONList :: Value -> Parser [JobResponse a]#

omittedField :: Maybe (JobResponse a)#

ToJSON a => ToJSON (JobResponse a) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: JobResponse a -> Value#

toEncoding :: JobResponse a -> Encoding#

toJSONList :: [JobResponse a] -> Value#

toEncodingList :: [JobResponse a] -> Encoding#

omitField :: JobResponse a -> Bool#

Eq a => Eq (JobResponse a) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: JobResponse a -> JobResponse a -> Bool#

(/=) :: JobResponse a -> JobResponse a -> Bool#

Generic (JobResponse a) Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep (JobResponse a)
Instance details Defined in Arbiter.Servant.Types type Rep (JobResponse a) = D1 ('MetaData "JobResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "JobResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "job") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

Methods

from :: JobResponse a -> Rep (JobResponse a) x#

to :: Rep (JobResponse a) x -> JobResponse a#

Show a => Show (JobResponse a) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> JobResponse a -> ShowS#

show :: JobResponse a -> String#

showList :: [JobResponse a] -> ShowS#

type Rep (JobResponse a) Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep (JobResponse a) = D1 ('MetaData "JobResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "JobResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "job") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

data JobsResponse payloadSource #

A page of jobs with their tree counts.

Constructors

JobsResponse
Fields jobsPage :: Page (ApiJobWithStatus (Stored payload)) The page. Its fields are flattened into the object. childCounts :: Map Int64 Int64 Child count, keyed by the id of each parent on the page. pausedParents :: [Int64] Ids of the parents on the page whose children are all paused. dlqChildCounts :: Map Int64 Int64 DLQ child count, keyed by the id of each parent on the page.

Instances

Instances details

FromJSON (JobsResponse payload) Source #
Instance details Defined in Arbiter.Servant.Types Methods parseJSON :: Value -> Parser (JobsResponse payload)# parseJSONList :: Value -> Parser [JobsResponse payload]# omittedField :: Maybe (JobsResponse payload)#
ToJSON (JobsResponse payload) Source #
Instance details Defined in Arbiter.Servant.Types Methods toJSON :: JobsResponse payload -> Value# toEncoding :: JobsResponse payload -> Encoding# toJSONList :: [JobsResponse payload] -> Value# toEncodingList :: [JobsResponse payload] -> Encoding# omitField :: JobsResponse payload -> Bool#
Eq (JobsResponse payload) Source #
Instance details Defined in Arbiter.Servant.Types Methods (==) :: JobsResponse payload -> JobsResponse payload -> Bool# (/=) :: JobsResponse payload -> JobsResponse payload -> Bool#
Show (JobsResponse payload) Source #
Instance details Defined in Arbiter.Servant.Types Methods showsPrec :: Int -> JobsResponse payload -> ShowS# show :: JobsResponse payload -> String# showList :: [JobsResponse payload] -> ShowS#

newtype RescheduleRequestSource #

When a rescheduled job becomes visible.

Constructors

RescheduleRequest
Fields runAt :: UTCTime

Instances

Instances details

FromJSON RescheduleRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser RescheduleRequest#

parseJSONList :: Value -> Parser [RescheduleRequest]#

omittedField :: Maybe RescheduleRequest#

ToJSON RescheduleRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: RescheduleRequest -> Value#

toEncoding :: RescheduleRequest -> Encoding#

toJSONList :: [RescheduleRequest] -> Value#

toEncodingList :: [RescheduleRequest] -> Encoding#

omitField :: RescheduleRequest -> Bool#

Eq RescheduleRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: RescheduleRequest -> RescheduleRequest -> Bool#

(/=) :: RescheduleRequest -> RescheduleRequest -> Bool#

Generic RescheduleRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep RescheduleRequest
Instance details Defined in Arbiter.Servant.Types type Rep RescheduleRequest = D1 ('MetaData "RescheduleRequest" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "RescheduleRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "runAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))

Methods

from :: RescheduleRequest -> Rep RescheduleRequest x#

to :: Rep RescheduleRequest x -> RescheduleRequest#

Show RescheduleRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> RescheduleRequest -> ShowS#

show :: RescheduleRequest -> String#

showList :: [RescheduleRequest] -> ShowS#

type Rep RescheduleRequest Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep RescheduleRequest = D1 ('MetaData "RescheduleRequest" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "RescheduleRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "runAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))

newtype DLQRetentionRequestSource #

Request body for setting a queue's DLQ retention.

Constructors

DLQRetentionRequest
Fields retentionSeconds :: Maybe Double

Instances

Instances details

FromJSON DLQRetentionRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser DLQRetentionRequest#

parseJSONList :: Value -> Parser [DLQRetentionRequest]#

omittedField :: Maybe DLQRetentionRequest#

ToJSON DLQRetentionRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: DLQRetentionRequest -> Value#

toEncoding :: DLQRetentionRequest -> Encoding#

toJSONList :: [DLQRetentionRequest] -> Value#

toEncodingList :: [DLQRetentionRequest] -> Encoding#

omitField :: DLQRetentionRequest -> Bool#

Eq DLQRetentionRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: DLQRetentionRequest -> DLQRetentionRequest -> Bool#

(/=) :: DLQRetentionRequest -> DLQRetentionRequest -> Bool#

Generic DLQRetentionRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep DLQRetentionRequest
Instance details Defined in Arbiter.Servant.Types type Rep DLQRetentionRequest = D1 ('MetaData "DLQRetentionRequest" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "DLQRetentionRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "retentionSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double))))

Methods

from :: DLQRetentionRequest -> Rep DLQRetentionRequest x#

to :: Rep DLQRetentionRequest x -> DLQRetentionRequest#

Show DLQRetentionRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> DLQRetentionRequest -> ShowS#

show :: DLQRetentionRequest -> String#

showList :: [DLQRetentionRequest] -> ShowS#

type Rep DLQRetentionRequest Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep DLQRetentionRequest = D1 ('MetaData "DLQRetentionRequest" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "DLQRetentionRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "retentionSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double))))

newtype BatchInsertRequest payloadSource #

Request body for batch job insert.

Constructors

BatchInsertRequest
Fields jobs :: [ApiJobWrite payload]

Instances

Instances details

FromJSON payload => FromJSON (BatchInsertRequest payload) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser (BatchInsertRequest payload)#

parseJSONList :: Value -> Parser [BatchInsertRequest payload]#

omittedField :: Maybe (BatchInsertRequest payload)#

ToJSON payload => ToJSON (BatchInsertRequest payload) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: BatchInsertRequest payload -> Value#

toEncoding :: BatchInsertRequest payload -> Encoding#

toJSONList :: [BatchInsertRequest payload] -> Value#

toEncodingList :: [BatchInsertRequest payload] -> Encoding#

omitField :: BatchInsertRequest payload -> Bool#

Eq payload => Eq (BatchInsertRequest payload) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: BatchInsertRequest payload -> BatchInsertRequest payload -> Bool#

(/=) :: BatchInsertRequest payload -> BatchInsertRequest payload -> Bool#

Generic (BatchInsertRequest payload) Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep (BatchInsertRequest payload)
Instance details Defined in Arbiter.Servant.Types type Rep (BatchInsertRequest payload) = D1 ('MetaData "BatchInsertRequest" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "BatchInsertRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ApiJobWrite payload])))

Methods

from :: BatchInsertRequest payload -> Rep (BatchInsertRequest payload) x#

to :: Rep (BatchInsertRequest payload) x -> BatchInsertRequest payload#

Show payload => Show (BatchInsertRequest payload) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> BatchInsertRequest payload -> ShowS#

show :: BatchInsertRequest payload -> String#

showList :: [BatchInsertRequest payload] -> ShowS#

type Rep (BatchInsertRequest payload) Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep (BatchInsertRequest payload) = D1 ('MetaData "BatchInsertRequest" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "BatchInsertRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ApiJobWrite payload])))

data BatchInsertResponse payloadSource #

Response body for batch job insert.

Constructors

BatchInsertResponse
Fields inserted :: [JobRead payload] insertedCount :: Int

Instances

Instances details

FromJSON payload => FromJSON (BatchInsertResponse payload) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser (BatchInsertResponse payload)#

parseJSONList :: Value -> Parser [BatchInsertResponse payload]#

omittedField :: Maybe (BatchInsertResponse payload)#

ToJSON payload => ToJSON (BatchInsertResponse payload) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: BatchInsertResponse payload -> Value#

toEncoding :: BatchInsertResponse payload -> Encoding#

toJSONList :: [BatchInsertResponse payload] -> Value#

toEncodingList :: [BatchInsertResponse payload] -> Encoding#

omitField :: BatchInsertResponse payload -> Bool#

Eq payload => Eq (BatchInsertResponse payload) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: BatchInsertResponse payload -> BatchInsertResponse payload -> Bool#

(/=) :: BatchInsertResponse payload -> BatchInsertResponse payload -> Bool#

Generic (BatchInsertResponse payload) Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep (BatchInsertResponse payload)

Instance details

Defined in Arbiter.Servant.Types

type Rep (BatchInsertResponse payload) = D1 ('MetaData "BatchInsertResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'False) (C1 ('MetaCons "BatchInsertResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "inserted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [JobRead payload]) :*: S1 ('MetaSel ('Just "insertedCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

Methods

from :: BatchInsertResponse payload -> Rep (BatchInsertResponse payload) x#

to :: Rep (BatchInsertResponse payload) x -> BatchInsertResponse payload#

Show payload => Show (BatchInsertResponse payload) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> BatchInsertResponse payload -> ShowS#

show :: BatchInsertResponse payload -> String#

showList :: [BatchInsertResponse payload] -> ShowS#

type Rep (BatchInsertResponse payload) Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep (BatchInsertResponse payload) = D1 ('MetaData "BatchInsertResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'False) (C1 ('MetaCons "BatchInsertResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "inserted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [JobRead payload]) :*: S1 ('MetaSel ('Just "insertedCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

DLQ and archive

newtype PayloadEdit payloadSource #

A replacement payload for a retry or a re-enqueue.

Constructors

PayloadEdit
Fields editPayload :: payload

Instances

Instances details

FromJSON payload => FromJSON (PayloadEdit payload) Source #
Instance details Defined in Arbiter.Servant.Types Methods parseJSON :: Value -> Parser (PayloadEdit payload)# parseJSONList :: Value -> Parser [PayloadEdit payload]# omittedField :: Maybe (PayloadEdit payload)#
ToJSON payload => ToJSON (PayloadEdit payload) Source #
Instance details Defined in Arbiter.Servant.Types Methods toJSON :: PayloadEdit payload -> Value# toEncoding :: PayloadEdit payload -> Encoding# toJSONList :: [PayloadEdit payload] -> Value# toEncodingList :: [PayloadEdit payload] -> Encoding# omitField :: PayloadEdit payload -> Bool#
Eq payload => Eq (PayloadEdit payload) Source #
Instance details Defined in Arbiter.Servant.Types Methods (==) :: PayloadEdit payload -> PayloadEdit payload -> Bool# (/=) :: PayloadEdit payload -> PayloadEdit payload -> Bool#
Show payload => Show (PayloadEdit payload) Source #
Instance details Defined in Arbiter.Servant.Types Methods showsPrec :: Int -> PayloadEdit payload -> ShowS# show :: PayloadEdit payload -> String# showList :: [PayloadEdit payload] -> ShowS#

data OptionalJSONSource #

JSON that a request can leave out. An empty body decodes as Nothing. A request with no content type is read as this type and must have an empty body.

Instances

Instances details

Accept OptionalJSON Source #
Instance details Defined in Arbiter.Servant.Types Methods contentType :: Proxy OptionalJSON -> MediaType# contentTypes :: Proxy OptionalJSON -> NonEmpty MediaType#
ToJSON a => MimeRender OptionalJSON (Maybe a) Source #	`Nothing` renders an empty body.
Instance details Defined in Arbiter.Servant.Types Methods mimeRender :: Proxy OptionalJSON -> Maybe a -> ByteString#
FromJSON a => MimeUnrender OptionalJSON (Maybe a) Source #
Instance details Defined in Arbiter.Servant.Types Methods mimeUnrender :: Proxy OptionalJSON -> ByteString -> Either String (Maybe a)# mimeUnrenderWithType :: Proxy OptionalJSON -> MediaType -> ByteString -> Either String (Maybe a)#

newtype BatchDeleteRequestSource #

Request body for a batch DLQ or archive delete.

Constructors

BatchDeleteRequest
Fields ids :: [Int64]

Instances

Instances details

FromJSON BatchDeleteRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser BatchDeleteRequest#

parseJSONList :: Value -> Parser [BatchDeleteRequest]#

omittedField :: Maybe BatchDeleteRequest#

ToJSON BatchDeleteRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: BatchDeleteRequest -> Value#

toEncoding :: BatchDeleteRequest -> Encoding#

toJSONList :: [BatchDeleteRequest] -> Value#

toEncodingList :: [BatchDeleteRequest] -> Encoding#

omitField :: BatchDeleteRequest -> Bool#

Eq BatchDeleteRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: BatchDeleteRequest -> BatchDeleteRequest -> Bool#

(/=) :: BatchDeleteRequest -> BatchDeleteRequest -> Bool#

Generic BatchDeleteRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep BatchDeleteRequest
Instance details Defined in Arbiter.Servant.Types type Rep BatchDeleteRequest = D1 ('MetaData "BatchDeleteRequest" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "BatchDeleteRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Int64])))

Methods

from :: BatchDeleteRequest -> Rep BatchDeleteRequest x#

to :: Rep BatchDeleteRequest x -> BatchDeleteRequest#

Show BatchDeleteRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> BatchDeleteRequest -> ShowS#

show :: BatchDeleteRequest -> String#

showList :: [BatchDeleteRequest] -> ShowS#

type Rep BatchDeleteRequest Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep BatchDeleteRequest = D1 ('MetaData "BatchDeleteRequest" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "BatchDeleteRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Int64])))

newtype BatchDeleteResponseSource #

Response body for a batch DLQ or archive delete.

Constructors

BatchDeleteResponse
Fields deleted :: Int64

Instances

Instances details

FromJSON BatchDeleteResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser BatchDeleteResponse#

parseJSONList :: Value -> Parser [BatchDeleteResponse]#

omittedField :: Maybe BatchDeleteResponse#

ToJSON BatchDeleteResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: BatchDeleteResponse -> Value#

toEncoding :: BatchDeleteResponse -> Encoding#

toJSONList :: [BatchDeleteResponse] -> Value#

toEncodingList :: [BatchDeleteResponse] -> Encoding#

omitField :: BatchDeleteResponse -> Bool#

Eq BatchDeleteResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: BatchDeleteResponse -> BatchDeleteResponse -> Bool#

(/=) :: BatchDeleteResponse -> BatchDeleteResponse -> Bool#

Generic BatchDeleteResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep BatchDeleteResponse
Instance details Defined in Arbiter.Servant.Types type Rep BatchDeleteResponse = D1 ('MetaData "BatchDeleteResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "BatchDeleteResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "deleted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)))

Methods

from :: BatchDeleteResponse -> Rep BatchDeleteResponse x#

to :: Rep BatchDeleteResponse x -> BatchDeleteResponse#

Show BatchDeleteResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> BatchDeleteResponse -> ShowS#

show :: BatchDeleteResponse -> String#

showList :: [BatchDeleteResponse] -> ShowS#

type Rep BatchDeleteResponse Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep BatchDeleteResponse = D1 ('MetaData "BatchDeleteResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "BatchDeleteResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "deleted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)))

newtype BatchRetryRequestSource #

Request body for a batch DLQ retry.

Constructors

BatchRetryRequest
Fields ids :: [Int64]

Instances

Instances details

FromJSON BatchRetryRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser BatchRetryRequest#

parseJSONList :: Value -> Parser [BatchRetryRequest]#

omittedField :: Maybe BatchRetryRequest#

ToJSON BatchRetryRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: BatchRetryRequest -> Value#

toEncoding :: BatchRetryRequest -> Encoding#

toJSONList :: [BatchRetryRequest] -> Value#

toEncodingList :: [BatchRetryRequest] -> Encoding#

omitField :: BatchRetryRequest -> Bool#

Eq BatchRetryRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: BatchRetryRequest -> BatchRetryRequest -> Bool#

(/=) :: BatchRetryRequest -> BatchRetryRequest -> Bool#

Generic BatchRetryRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep BatchRetryRequest
Instance details Defined in Arbiter.Servant.Types type Rep BatchRetryRequest = D1 ('MetaData "BatchRetryRequest" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "BatchRetryRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Int64])))

Methods

from :: BatchRetryRequest -> Rep BatchRetryRequest x#

to :: Rep BatchRetryRequest x -> BatchRetryRequest#

Show BatchRetryRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> BatchRetryRequest -> ShowS#

show :: BatchRetryRequest -> String#

showList :: [BatchRetryRequest] -> ShowS#

type Rep BatchRetryRequest Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep BatchRetryRequest = D1 ('MetaData "BatchRetryRequest" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "BatchRetryRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Int64])))

newtype BatchRetryResponseSource #

Response body for a batch or filtered DLQ retry.

Constructors

BatchRetryResponse
Fields retried :: Int64

Instances

Instances details

FromJSON BatchRetryResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser BatchRetryResponse#

parseJSONList :: Value -> Parser [BatchRetryResponse]#

omittedField :: Maybe BatchRetryResponse#

ToJSON BatchRetryResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: BatchRetryResponse -> Value#

toEncoding :: BatchRetryResponse -> Encoding#

toJSONList :: [BatchRetryResponse] -> Value#

toEncodingList :: [BatchRetryResponse] -> Encoding#

omitField :: BatchRetryResponse -> Bool#

Eq BatchRetryResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: BatchRetryResponse -> BatchRetryResponse -> Bool#

(/=) :: BatchRetryResponse -> BatchRetryResponse -> Bool#

Generic BatchRetryResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep BatchRetryResponse
Instance details Defined in Arbiter.Servant.Types type Rep BatchRetryResponse = D1 ('MetaData "BatchRetryResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "BatchRetryResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "retried") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)))

Methods

from :: BatchRetryResponse -> Rep BatchRetryResponse x#

to :: Rep BatchRetryResponse x -> BatchRetryResponse#

Show BatchRetryResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> BatchRetryResponse -> ShowS#

show :: BatchRetryResponse -> String#

showList :: [BatchRetryResponse] -> ShowS#

type Rep BatchRetryResponse Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep BatchRetryResponse = D1 ('MetaData "BatchRetryResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "BatchRetryResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "retried") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)))

Pages

data Page aSource #

One page of a list, with the size of the full list.

Constructors

Page
Fields pageItems :: [a] pageTotal :: Int Rows that match the filters, across all pages. pageOffset :: Int pageLimit :: Int Page size, clamped to `pageLimitRange`.

Instances

Instances details

FromJSON a => FromJSON (Page a) Source #
Instance details Defined in Arbiter.Servant.Types Methods parseJSON :: Value -> Parser (Page a)# parseJSONList :: Value -> Parser [Page a]# omittedField :: Maybe (Page a)#
ToJSON a => ToJSON (Page a) Source #
Instance details Defined in Arbiter.Servant.Types Methods toJSON :: Page a -> Value# toEncoding :: Page a -> Encoding# toJSONList :: [Page a] -> Value# toEncodingList :: [Page a] -> Encoding# omitField :: Page a -> Bool#
Eq a => Eq (Page a) Source #
Instance details Defined in Arbiter.Servant.Types Methods (==) :: Page a -> Page a -> Bool# (/=) :: Page a -> Page a -> Bool#
Show a => Show (Page a) Source #
Instance details Defined in Arbiter.Servant.Types Methods showsPrec :: Int -> Page a -> ShowS# show :: Page a -> String# showList :: [Page a] -> ShowS#

newtype PageSize (def :: Nat)Source #

Page size of a listing, with the size it takes when the request omits it.

Constructors

PageSize
Fields unPageSize :: Int

Instances

Instances details

Eq (PageSize def) Source #
Instance details Defined in Arbiter.Servant.Types Methods (==) :: PageSize def -> PageSize def -> Bool# (/=) :: PageSize def -> PageSize def -> Bool#
Show (PageSize def) Source #
Instance details Defined in Arbiter.Servant.Types Methods showsPrec :: Int -> PageSize def -> ShowS# show :: PageSize def -> String# showList :: [PageSize def] -> ShowS#
FromHttpApiData (PageSize def) Source #
Instance details Defined in Arbiter.Servant.Types Methods parseUrlPiece :: Text -> Either Text (PageSize def)# parseHeader :: ByteString -> Either Text (PageSize def)# parseQueryParam :: Text -> Either Text (PageSize def)#
ToHttpApiData (PageSize def) Source #
Instance details Defined in Arbiter.Servant.Types Methods toUrlPiece :: PageSize def -> Text# toEncodedUrlPiece :: PageSize def -> Builder# toHeader :: PageSize def -> ByteString# toQueryParam :: PageSize def -> Text# toEncodedQueryParam :: PageSize def -> Builder#

type PageLimit = PageSize 50Source #

Page size of a job, DLQ, archive or group listing.

type KeyPageLimit = PageSize 100Source #

Page size of a bucket or key listing.

pageSizeDefault :: forall (def :: Nat) proxy. KnownNat def => proxy def -> IntSource #

The page size a listing takes when the request omits it.

pageLimitRange :: (Int, Int)Source #

Bounds on page size.

newtype Items aSource #

A list of rows without a total.

Constructors

Items
Fields items :: [a]

Instances

Instances details

FromJSON a => FromJSON (Items a) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser (Items a)#

parseJSONList :: Value -> Parser [Items a]#

omittedField :: Maybe (Items a)#

ToJSON a => ToJSON (Items a) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: Items a -> Value#

toEncoding :: Items a -> Encoding#

toJSONList :: [Items a] -> Value#

toEncodingList :: [Items a] -> Encoding#

omitField :: Items a -> Bool#

Eq a => Eq (Items a) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: Items a -> Items a -> Bool#

(/=) :: Items a -> Items a -> Bool#

Generic (Items a) Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep (Items a)
Instance details Defined in Arbiter.Servant.Types type Rep (Items a) = D1 ('MetaData "Items" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "Items" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a])))

Methods

from :: Items a -> Rep (Items a) x#

to :: Rep (Items a) x -> Items a#

Show a => Show (Items a) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> Items a -> ShowS#

show :: Items a -> String#

showList :: [Items a] -> ShowS#

type Rep (Items a) Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep (Items a) = D1 ('MetaData "Items" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "Items" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a])))

type ArchiveResponse payload = Page (ArchiveJob (Stored payload))Source #

A page of archived jobs.

type DLQResponse payload = Page (DLQJob (Stored payload))Source #

A page of DLQ jobs.

type GroupsResponse = Page GroupSummarySource #

A page of a queue's open groups.

Leases

data ClaimRequestSource #

A consumer's request to lease visible jobs.

Constructors

ClaimRequest
Fields maxJobs :: Maybe Int Jobs to claim. See `defaultClaimJobs` and `claimJobsRange`. leaseSeconds :: Maybe Double Lease length in seconds. See `defaultLeaseSeconds` and `leaseSecondsRange`.

Instances

Instances details

FromJSON ClaimRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser ClaimRequest#

parseJSONList :: Value -> Parser [ClaimRequest]#

omittedField :: Maybe ClaimRequest#

ToJSON ClaimRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: ClaimRequest -> Value#

toEncoding :: ClaimRequest -> Encoding#

toJSONList :: [ClaimRequest] -> Value#

toEncodingList :: [ClaimRequest] -> Encoding#

omitField :: ClaimRequest -> Bool#

Eq ClaimRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: ClaimRequest -> ClaimRequest -> Bool#

(/=) :: ClaimRequest -> ClaimRequest -> Bool#

Generic ClaimRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep ClaimRequest

Instance details

Defined in Arbiter.Servant.Types

type Rep ClaimRequest = D1 ('MetaData "ClaimRequest" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ClaimRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxJobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "leaseSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double))))

Methods

from :: ClaimRequest -> Rep ClaimRequest x#

to :: Rep ClaimRequest x -> ClaimRequest#

Show ClaimRequest Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> ClaimRequest -> ShowS#

show :: ClaimRequest -> String#

showList :: [ClaimRequest] -> ShowS#

type Rep ClaimRequest Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep ClaimRequest = D1 ('MetaData "ClaimRequest" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ClaimRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxJobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "leaseSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double))))

claimJobsRange :: (Int, Int)Source #

Bounds on jobs per claim.

defaultClaimJobs :: IntSource #

Jobs per claim when the request omits it.

leaseSecondsRange :: (Double, Double)Source #

Bounds on lease seconds.

defaultLeaseSeconds :: DoubleSource #

Lease seconds when the request omits it.

newtype ClaimResponse payloadSource #

Jobs returned by one claim. Each job contains the lease fields required for finalization.

Constructors

ClaimResponse
Fields jobs :: [JobRead payload]

Instances

Instances details

FromJSON payload => FromJSON (ClaimResponse payload) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser (ClaimResponse payload)#

parseJSONList :: Value -> Parser [ClaimResponse payload]#

omittedField :: Maybe (ClaimResponse payload)#

ToJSON payload => ToJSON (ClaimResponse payload) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: ClaimResponse payload -> Value#

toEncoding :: ClaimResponse payload -> Encoding#

toJSONList :: [ClaimResponse payload] -> Value#

toEncodingList :: [ClaimResponse payload] -> Encoding#

omitField :: ClaimResponse payload -> Bool#

Eq payload => Eq (ClaimResponse payload) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: ClaimResponse payload -> ClaimResponse payload -> Bool#

(/=) :: ClaimResponse payload -> ClaimResponse payload -> Bool#

Generic (ClaimResponse payload) Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep (ClaimResponse payload)
Instance details Defined in Arbiter.Servant.Types type Rep (ClaimResponse payload) = D1 ('MetaData "ClaimResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "ClaimResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [JobRead payload])))

Methods

from :: ClaimResponse payload -> Rep (ClaimResponse payload) x#

to :: Rep (ClaimResponse payload) x -> ClaimResponse payload#

Show payload => Show (ClaimResponse payload) Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> ClaimResponse payload -> ShowS#

show :: ClaimResponse payload -> String#

showList :: [ClaimResponse payload] -> ShowS#

type Rep (ClaimResponse payload) Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep (ClaimResponse payload) = D1 ('MetaData "ClaimResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "ClaimResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [JobRead payload])))

data JobLeaseSource #

Proof that the caller still holds a claimed job.

Constructors

JobLease
Fields jlClaimSeq :: Int64 jlClaimedBy :: UUID

Instances

Instances details

FromJSON JobLease Source #
Instance details Defined in Arbiter.Servant.Types Methods parseJSON :: Value -> Parser JobLease# parseJSONList :: Value -> Parser [JobLease]# omittedField :: Maybe JobLease#
ToJSON JobLease Source #
Instance details Defined in Arbiter.Servant.Types Methods toJSON :: JobLease -> Value# toEncoding :: JobLease -> Encoding# toJSONList :: [JobLease] -> Value# toEncodingList :: [JobLease] -> Encoding# omitField :: JobLease -> Bool#
Eq JobLease Source #
Instance details Defined in Arbiter.Servant.Types Methods (==) :: JobLease -> JobLease -> Bool# (/=) :: JobLease -> JobLease -> Bool#
Show JobLease Source #
Instance details Defined in Arbiter.Servant.Types Methods showsPrec :: Int -> JobLease -> ShowS# show :: JobLease -> String# showList :: [JobLease] -> ShowS#

data AckRequest resultSource #

A lease and an optional stored result. An absent result performs a plain ack.

Constructors

AckRequest
Fields arLease :: JobLease The lease. Its fields are flattened into the object. arResult :: Maybe result

Instances

Instances details

FromJSON result => FromJSON (AckRequest result) Source #
Instance details Defined in Arbiter.Servant.Types Methods parseJSON :: Value -> Parser (AckRequest result)# parseJSONList :: Value -> Parser [AckRequest result]# omittedField :: Maybe (AckRequest result)#
ToJSON result => ToJSON (AckRequest result) Source #
Instance details Defined in Arbiter.Servant.Types Methods toJSON :: AckRequest result -> Value# toEncoding :: AckRequest result -> Encoding# toJSONList :: [AckRequest result] -> Value# toEncodingList :: [AckRequest result] -> Encoding# omitField :: AckRequest result -> Bool#
Eq result => Eq (AckRequest result) Source #
Instance details Defined in Arbiter.Servant.Types Methods (==) :: AckRequest result -> AckRequest result -> Bool# (/=) :: AckRequest result -> AckRequest result -> Bool#
Show result => Show (AckRequest result) Source #
Instance details Defined in Arbiter.Servant.Types Methods showsPrec :: Int -> AckRequest result -> ShowS# show :: AckRequest result -> String# showList :: [AckRequest result] -> ShowS#

data ExtendRequestSource #

A lease plus the window to hide the job for, counted from now.

Constructors

ExtendRequest
Fields erLease :: JobLease The lease. Its fields are flattened into the object. erSeconds :: Double Clamped to `leaseSecondsRange`.

Instances

Instances details

FromJSON ExtendRequest Source #
Instance details Defined in Arbiter.Servant.Types Methods parseJSON :: Value -> Parser ExtendRequest# parseJSONList :: Value -> Parser [ExtendRequest]# omittedField :: Maybe ExtendRequest#
ToJSON ExtendRequest Source #
Instance details Defined in Arbiter.Servant.Types Methods toJSON :: ExtendRequest -> Value# toEncoding :: ExtendRequest -> Encoding# toJSONList :: [ExtendRequest] -> Value# toEncodingList :: [ExtendRequest] -> Encoding# omitField :: ExtendRequest -> Bool#
Eq ExtendRequest Source #
Instance details Defined in Arbiter.Servant.Types Methods (==) :: ExtendRequest -> ExtendRequest -> Bool# (/=) :: ExtendRequest -> ExtendRequest -> Bool#
Show ExtendRequest Source #
Instance details Defined in Arbiter.Servant.Types Methods showsPrec :: Int -> ExtendRequest -> ShowS# show :: ExtendRequest -> String# showList :: [ExtendRequest] -> ShowS#

Queues and stats

data StatsResponseSource #

Queue statistics response.

Constructors

StatsResponse
Fields stats :: QueueStats timestamp :: UTCTime When the stats were read.

Instances

Instances details

FromJSON StatsResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser StatsResponse#

parseJSONList :: Value -> Parser [StatsResponse]#

omittedField :: Maybe StatsResponse#

ToJSON StatsResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: StatsResponse -> Value#

toEncoding :: StatsResponse -> Encoding#

toJSONList :: [StatsResponse] -> Value#

toEncodingList :: [StatsResponse] -> Encoding#

omitField :: StatsResponse -> Bool#

Eq StatsResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: StatsResponse -> StatsResponse -> Bool#

(/=) :: StatsResponse -> StatsResponse -> Bool#

Generic StatsResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep StatsResponse

Instance details

Defined in Arbiter.Servant.Types

type Rep StatsResponse = D1 ('MetaData "StatsResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'False) (C1 ('MetaCons "StatsResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "stats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 QueueStats) :*: S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))

Methods

from :: StatsResponse -> Rep StatsResponse x#

to :: Rep StatsResponse x -> StatsResponse#

Show StatsResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> StatsResponse -> ShowS#

show :: StatsResponse -> String#

showList :: [StatsResponse] -> ShowS#

type Rep StatsResponse Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep StatsResponse = D1 ('MetaData "StatsResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'False) (C1 ('MetaCons "StatsResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "stats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 QueueStats) :*: S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))

newtype AllStatsResponseSource #

Every queue's stats, for the landing overview.

Constructors

AllStatsResponse
Fields queues :: [QueueOverview]

Instances

Instances details

FromJSON AllStatsResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser AllStatsResponse#

parseJSONList :: Value -> Parser [AllStatsResponse]#

omittedField :: Maybe AllStatsResponse#

ToJSON AllStatsResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: AllStatsResponse -> Value#

toEncoding :: AllStatsResponse -> Encoding#

toJSONList :: [AllStatsResponse] -> Value#

toEncodingList :: [AllStatsResponse] -> Encoding#

omitField :: AllStatsResponse -> Bool#

Eq AllStatsResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: AllStatsResponse -> AllStatsResponse -> Bool#

(/=) :: AllStatsResponse -> AllStatsResponse -> Bool#

Generic AllStatsResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep AllStatsResponse
Instance details Defined in Arbiter.Servant.Types type Rep AllStatsResponse = D1 ('MetaData "AllStatsResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "AllStatsResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "queues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [QueueOverview])))

Methods

from :: AllStatsResponse -> Rep AllStatsResponse x#

to :: Rep AllStatsResponse x -> AllStatsResponse#

Show AllStatsResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> AllStatsResponse -> ShowS#

show :: AllStatsResponse -> String#

showList :: [AllStatsResponse] -> ShowS#

type Rep AllStatsResponse Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep AllStatsResponse = D1 ('MetaData "AllStatsResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "AllStatsResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "queues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [QueueOverview])))

newtype QueuesResponseSource #

Queues list response.

Constructors

QueuesResponse
Fields queues :: [Text] Registry queue names.

Instances

Instances details

FromJSON QueuesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser QueuesResponse#

parseJSONList :: Value -> Parser [QueuesResponse]#

omittedField :: Maybe QueuesResponse#

ToJSON QueuesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: QueuesResponse -> Value#

toEncoding :: QueuesResponse -> Encoding#

toJSONList :: [QueuesResponse] -> Value#

toEncodingList :: [QueuesResponse] -> Encoding#

omitField :: QueuesResponse -> Bool#

Eq QueuesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: QueuesResponse -> QueuesResponse -> Bool#

(/=) :: QueuesResponse -> QueuesResponse -> Bool#

Generic QueuesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep QueuesResponse
Instance details Defined in Arbiter.Servant.Types type Rep QueuesResponse = D1 ('MetaData "QueuesResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "QueuesResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "queues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))

Methods

from :: QueuesResponse -> Rep QueuesResponse x#

to :: Rep QueuesResponse x -> QueuesResponse#

Show QueuesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> QueuesResponse -> ShowS#

show :: QueuesResponse -> String#

showList :: [QueuesResponse] -> ShowS#

type Rep QueuesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep QueuesResponse = D1 ('MetaData "QueuesResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "QueuesResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "queues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))

Maintenance

data MaintenanceResponseSource #

Rows each maintenance operation touched, and the operations that raised. An operation in neither was skipped.

Constructors

MaintenanceResponse
Fields maintenanceOps :: Map Text Int64 Rows touched, keyed by operation name. maintenanceFailed :: [Text] Names of the operations that raised.

Instances

Instances details

FromJSON MaintenanceResponse Source #
Instance details Defined in Arbiter.Servant.Types Methods parseJSON :: Value -> Parser MaintenanceResponse# parseJSONList :: Value -> Parser [MaintenanceResponse]# omittedField :: Maybe MaintenanceResponse#
ToJSON MaintenanceResponse Source #
Instance details Defined in Arbiter.Servant.Types Methods toJSON :: MaintenanceResponse -> Value# toEncoding :: MaintenanceResponse -> Encoding# toJSONList :: [MaintenanceResponse] -> Value# toEncodingList :: [MaintenanceResponse] -> Encoding# omitField :: MaintenanceResponse -> Bool#
Eq MaintenanceResponse Source #
Instance details Defined in Arbiter.Servant.Types Methods (==) :: MaintenanceResponse -> MaintenanceResponse -> Bool# (/=) :: MaintenanceResponse -> MaintenanceResponse -> Bool#
Show MaintenanceResponse Source #
Instance details Defined in Arbiter.Servant.Types Methods showsPrec :: Int -> MaintenanceResponse -> ShowS# show :: MaintenanceResponse -> String# showList :: [MaintenanceResponse] -> ShowS#

Cron and workers

data CronScheduleViewSource #

A cron schedule row plus the next tick its effective expression fires at. A disabled schedule, an expression that never fires again, or one the server cannot parse has none.

Constructors

CronScheduleView
Fields schedule :: CronScheduleRow The row. Its fields are flattened into the object. nextRunAt :: Maybe UTCTime

Instances

Instances details

FromJSON CronScheduleView Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser CronScheduleView#

parseJSONList :: Value -> Parser [CronScheduleView]#

omittedField :: Maybe CronScheduleView#

ToJSON CronScheduleView Source #

The row's own fields, with nextRunAt alongside them.

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: CronScheduleView -> Value#

toEncoding :: CronScheduleView -> Encoding#

toJSONList :: [CronScheduleView] -> Value#

toEncodingList :: [CronScheduleView] -> Encoding#

omitField :: CronScheduleView -> Bool#

Eq CronScheduleView Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: CronScheduleView -> CronScheduleView -> Bool#

(/=) :: CronScheduleView -> CronScheduleView -> Bool#

Generic CronScheduleView Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep CronScheduleView

Instance details

Defined in Arbiter.Servant.Types

type Rep CronScheduleView = D1 ('MetaData "CronScheduleView" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'False) (C1 ('MetaCons "CronScheduleView" 'PrefixI 'True) (S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CronScheduleRow) :*: S1 ('MetaSel ('Just "nextRunAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe UTCTime))))

Methods

from :: CronScheduleView -> Rep CronScheduleView x#

to :: Rep CronScheduleView x -> CronScheduleView#

Show CronScheduleView Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> CronScheduleView -> ShowS#

show :: CronScheduleView -> String#

showList :: [CronScheduleView] -> ShowS#

type Rep CronScheduleView Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep CronScheduleView = D1 ('MetaData "CronScheduleView" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'False) (C1 ('MetaCons "CronScheduleView" 'PrefixI 'True) (S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CronScheduleRow) :*: S1 ('MetaSel ('Just "nextRunAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe UTCTime))))

newtype CronSchedulesResponseSource #

Cron schedules response.

Constructors

CronSchedulesResponse
Fields schedules :: [CronScheduleView]

Instances

Instances details

FromJSON CronSchedulesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser CronSchedulesResponse#

parseJSONList :: Value -> Parser [CronSchedulesResponse]#

omittedField :: Maybe CronSchedulesResponse#

ToJSON CronSchedulesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: CronSchedulesResponse -> Value#

toEncoding :: CronSchedulesResponse -> Encoding#

toJSONList :: [CronSchedulesResponse] -> Value#

toEncodingList :: [CronSchedulesResponse] -> Encoding#

omitField :: CronSchedulesResponse -> Bool#

Eq CronSchedulesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: CronSchedulesResponse -> CronSchedulesResponse -> Bool#

(/=) :: CronSchedulesResponse -> CronSchedulesResponse -> Bool#

Generic CronSchedulesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep CronSchedulesResponse
Instance details Defined in Arbiter.Servant.Types type Rep CronSchedulesResponse = D1 ('MetaData "CronSchedulesResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "CronSchedulesResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "schedules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [CronScheduleView])))

Methods

from :: CronSchedulesResponse -> Rep CronSchedulesResponse x#

to :: Rep CronSchedulesResponse x -> CronSchedulesResponse#

Show CronSchedulesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> CronSchedulesResponse -> ShowS#

show :: CronSchedulesResponse -> String#

showList :: [CronSchedulesResponse] -> ShowS#

type Rep CronSchedulesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep CronSchedulesResponse = D1 ('MetaData "CronSchedulesResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "CronSchedulesResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "schedules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [CronScheduleView])))

newtype WorkersResponseSource #

Worker registry response.

Constructors

WorkersResponse
Fields workers :: [WorkerRow]

Instances

Instances details

FromJSON WorkersResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser WorkersResponse#

parseJSONList :: Value -> Parser [WorkersResponse]#

omittedField :: Maybe WorkersResponse#

ToJSON WorkersResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: WorkersResponse -> Value#

toEncoding :: WorkersResponse -> Encoding#

toJSONList :: [WorkersResponse] -> Value#

toEncodingList :: [WorkersResponse] -> Encoding#

omitField :: WorkersResponse -> Bool#

Eq WorkersResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: WorkersResponse -> WorkersResponse -> Bool#

(/=) :: WorkersResponse -> WorkersResponse -> Bool#

Generic WorkersResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep WorkersResponse
Instance details Defined in Arbiter.Servant.Types type Rep WorkersResponse = D1 ('MetaData "WorkersResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "WorkersResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "workers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [WorkerRow])))

Methods

from :: WorkersResponse -> Rep WorkersResponse x#

to :: Rep WorkersResponse x -> WorkersResponse#

Show WorkersResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> WorkersResponse -> ShowS#

show :: WorkersResponse -> String#

showList :: [WorkersResponse] -> ShowS#

type Rep WorkersResponse Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep WorkersResponse = D1 ('MetaData "WorkersResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "WorkersResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "workers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [WorkerRow])))

Admission policies

newtype RateLimitPoliciesResponseSource #

Rate-limit policies response.

Constructors

RateLimitPoliciesResponse
Fields policies :: [RateLimitPolicyView]

Instances

Instances details

FromJSON RateLimitPoliciesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser RateLimitPoliciesResponse#

parseJSONList :: Value -> Parser [RateLimitPoliciesResponse]#

omittedField :: Maybe RateLimitPoliciesResponse#

ToJSON RateLimitPoliciesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: RateLimitPoliciesResponse -> Value#

toEncoding :: RateLimitPoliciesResponse -> Encoding#

toJSONList :: [RateLimitPoliciesResponse] -> Value#

toEncodingList :: [RateLimitPoliciesResponse] -> Encoding#

omitField :: RateLimitPoliciesResponse -> Bool#

Eq RateLimitPoliciesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: RateLimitPoliciesResponse -> RateLimitPoliciesResponse -> Bool#

(/=) :: RateLimitPoliciesResponse -> RateLimitPoliciesResponse -> Bool#

Generic RateLimitPoliciesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep RateLimitPoliciesResponse
Instance details Defined in Arbiter.Servant.Types type Rep RateLimitPoliciesResponse = D1 ('MetaData "RateLimitPoliciesResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "RateLimitPoliciesResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "policies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [RateLimitPolicyView])))

Methods

from :: RateLimitPoliciesResponse -> Rep RateLimitPoliciesResponse x#

to :: Rep RateLimitPoliciesResponse x -> RateLimitPoliciesResponse#

Show RateLimitPoliciesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> RateLimitPoliciesResponse -> ShowS#

show :: RateLimitPoliciesResponse -> String#

showList :: [RateLimitPoliciesResponse] -> ShowS#

type Rep RateLimitPoliciesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep RateLimitPoliciesResponse = D1 ('MetaData "RateLimitPoliciesResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "RateLimitPoliciesResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "policies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [RateLimitPolicyView])))

type RateLimitBucketsResponse = Items RateLimitBucketViewSource #

Rate-limit buckets response (one prefix's keys).

newtype RateLimitResetResponseSource #

Number of buckets a reset refilled to full.

Constructors

RateLimitResetResponse
Fields reset :: Int64

Instances

Instances details

FromJSON RateLimitResetResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser RateLimitResetResponse#

parseJSONList :: Value -> Parser [RateLimitResetResponse]#

omittedField :: Maybe RateLimitResetResponse#

ToJSON RateLimitResetResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: RateLimitResetResponse -> Value#

toEncoding :: RateLimitResetResponse -> Encoding#

toJSONList :: [RateLimitResetResponse] -> Value#

toEncodingList :: [RateLimitResetResponse] -> Encoding#

omitField :: RateLimitResetResponse -> Bool#

Eq RateLimitResetResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: RateLimitResetResponse -> RateLimitResetResponse -> Bool#

(/=) :: RateLimitResetResponse -> RateLimitResetResponse -> Bool#

Generic RateLimitResetResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep RateLimitResetResponse
Instance details Defined in Arbiter.Servant.Types type Rep RateLimitResetResponse = D1 ('MetaData "RateLimitResetResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "RateLimitResetResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "reset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)))

Methods

from :: RateLimitResetResponse -> Rep RateLimitResetResponse x#

to :: Rep RateLimitResetResponse x -> RateLimitResetResponse#

Show RateLimitResetResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> RateLimitResetResponse -> ShowS#

show :: RateLimitResetResponse -> String#

showList :: [RateLimitResetResponse] -> ShowS#

type Rep RateLimitResetResponse Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep RateLimitResetResponse = D1 ('MetaData "RateLimitResetResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "RateLimitResetResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "reset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)))

newtype AddTokensRequestSource #

Tokens to add to one rate-limit bucket.

Constructors

AddTokensRequest
Fields addedTokens :: Double

Instances

Instances details

FromJSON AddTokensRequest Source #
Instance details Defined in Arbiter.Servant.Types Methods parseJSON :: Value -> Parser AddTokensRequest# parseJSONList :: Value -> Parser [AddTokensRequest]# omittedField :: Maybe AddTokensRequest#
ToJSON AddTokensRequest Source #
Instance details Defined in Arbiter.Servant.Types Methods toJSON :: AddTokensRequest -> Value# toEncoding :: AddTokensRequest -> Encoding# toJSONList :: [AddTokensRequest] -> Value# toEncodingList :: [AddTokensRequest] -> Encoding# omitField :: AddTokensRequest -> Bool#
Eq AddTokensRequest Source #
Instance details Defined in Arbiter.Servant.Types Methods (==) :: AddTokensRequest -> AddTokensRequest -> Bool# (/=) :: AddTokensRequest -> AddTokensRequest -> Bool#
Show AddTokensRequest Source #
Instance details Defined in Arbiter.Servant.Types Methods showsPrec :: Int -> AddTokensRequest -> ShowS# show :: AddTokensRequest -> String# showList :: [AddTokensRequest] -> ShowS#

newtype AddTokensResponseSource #

Jobs a token grant made claimable again.

Constructors

AddTokensResponse
Fields woken :: Int64

Instances

Instances details

FromJSON AddTokensResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser AddTokensResponse#

parseJSONList :: Value -> Parser [AddTokensResponse]#

omittedField :: Maybe AddTokensResponse#

ToJSON AddTokensResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: AddTokensResponse -> Value#

toEncoding :: AddTokensResponse -> Encoding#

toJSONList :: [AddTokensResponse] -> Value#

toEncodingList :: [AddTokensResponse] -> Encoding#

omitField :: AddTokensResponse -> Bool#

Eq AddTokensResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: AddTokensResponse -> AddTokensResponse -> Bool#

(/=) :: AddTokensResponse -> AddTokensResponse -> Bool#

Generic AddTokensResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep AddTokensResponse
Instance details Defined in Arbiter.Servant.Types type Rep AddTokensResponse = D1 ('MetaData "AddTokensResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "AddTokensResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "woken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)))

Methods

from :: AddTokensResponse -> Rep AddTokensResponse x#

to :: Rep AddTokensResponse x -> AddTokensResponse#

Show AddTokensResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> AddTokensResponse -> ShowS#

show :: AddTokensResponse -> String#

showList :: [AddTokensResponse] -> ShowS#

type Rep AddTokensResponse Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep AddTokensResponse = D1 ('MetaData "AddTokensResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "AddTokensResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "woken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)))

newtype PruneResponseSource #

Rows a prune deleted.

Constructors

PruneResponse
Fields pruned :: Int64

Instances

Instances details

FromJSON PruneResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser PruneResponse#

parseJSONList :: Value -> Parser [PruneResponse]#

omittedField :: Maybe PruneResponse#

ToJSON PruneResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: PruneResponse -> Value#

toEncoding :: PruneResponse -> Encoding#

toJSONList :: [PruneResponse] -> Value#

toEncodingList :: [PruneResponse] -> Encoding#

omitField :: PruneResponse -> Bool#

Eq PruneResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: PruneResponse -> PruneResponse -> Bool#

(/=) :: PruneResponse -> PruneResponse -> Bool#

Generic PruneResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep PruneResponse
Instance details Defined in Arbiter.Servant.Types type Rep PruneResponse = D1 ('MetaData "PruneResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "PruneResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "pruned") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)))

Methods

from :: PruneResponse -> Rep PruneResponse x#

to :: Rep PruneResponse x -> PruneResponse#

Show PruneResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> PruneResponse -> ShowS#

show :: PruneResponse -> String#

showList :: [PruneResponse] -> ShowS#

type Rep PruneResponse Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep PruneResponse = D1 ('MetaData "PruneResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "PruneResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "pruned") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)))

newtype ConcurrencyPoliciesResponseSource #

Concurrency policies response.

Constructors

ConcurrencyPoliciesResponse
Fields policies :: [ConcurrencyPolicyView]

Instances

Instances details

FromJSON ConcurrencyPoliciesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser ConcurrencyPoliciesResponse#

parseJSONList :: Value -> Parser [ConcurrencyPoliciesResponse]#

omittedField :: Maybe ConcurrencyPoliciesResponse#

ToJSON ConcurrencyPoliciesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: ConcurrencyPoliciesResponse -> Value#

toEncoding :: ConcurrencyPoliciesResponse -> Encoding#

toJSONList :: [ConcurrencyPoliciesResponse] -> Value#

toEncodingList :: [ConcurrencyPoliciesResponse] -> Encoding#

omitField :: ConcurrencyPoliciesResponse -> Bool#

Eq ConcurrencyPoliciesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: ConcurrencyPoliciesResponse -> ConcurrencyPoliciesResponse -> Bool#

(/=) :: ConcurrencyPoliciesResponse -> ConcurrencyPoliciesResponse -> Bool#

Generic ConcurrencyPoliciesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep ConcurrencyPoliciesResponse
Instance details Defined in Arbiter.Servant.Types type Rep ConcurrencyPoliciesResponse = D1 ('MetaData "ConcurrencyPoliciesResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "ConcurrencyPoliciesResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "policies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ConcurrencyPolicyView])))

Methods

from :: ConcurrencyPoliciesResponse -> Rep ConcurrencyPoliciesResponse x#

to :: Rep ConcurrencyPoliciesResponse x -> ConcurrencyPoliciesResponse#

Show ConcurrencyPoliciesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> ConcurrencyPoliciesResponse -> ShowS#

show :: ConcurrencyPoliciesResponse -> String#

showList :: [ConcurrencyPoliciesResponse] -> ShowS#

type Rep ConcurrencyPoliciesResponse Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep ConcurrencyPoliciesResponse = D1 ('MetaData "ConcurrencyPoliciesResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "ConcurrencyPoliciesResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "policies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ConcurrencyPolicyView])))

type ConcurrencyKeysResponse = Items ConcurrencyKeyViewSource #

Concurrency keys response (one prefix's keys).

newtype ConcurrencyReconcileResponseSource #

Number of count rows repaired from live jobs.

Constructors

ConcurrencyReconcileResponse
Fields reconciled :: Int64

Instances

Instances details

FromJSON ConcurrencyReconcileResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser ConcurrencyReconcileResponse#

parseJSONList :: Value -> Parser [ConcurrencyReconcileResponse]#

omittedField :: Maybe ConcurrencyReconcileResponse#

ToJSON ConcurrencyReconcileResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: ConcurrencyReconcileResponse -> Value#

toEncoding :: ConcurrencyReconcileResponse -> Encoding#

toJSONList :: [ConcurrencyReconcileResponse] -> Value#

toEncodingList :: [ConcurrencyReconcileResponse] -> Encoding#

omitField :: ConcurrencyReconcileResponse -> Bool#

Eq ConcurrencyReconcileResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: ConcurrencyReconcileResponse -> ConcurrencyReconcileResponse -> Bool#

(/=) :: ConcurrencyReconcileResponse -> ConcurrencyReconcileResponse -> Bool#

Generic ConcurrencyReconcileResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep ConcurrencyReconcileResponse
Instance details Defined in Arbiter.Servant.Types type Rep ConcurrencyReconcileResponse = D1 ('MetaData "ConcurrencyReconcileResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "ConcurrencyReconcileResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "reconciled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)))

Methods

from :: ConcurrencyReconcileResponse -> Rep ConcurrencyReconcileResponse x#

to :: Rep ConcurrencyReconcileResponse x -> ConcurrencyReconcileResponse#

Show ConcurrencyReconcileResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> ConcurrencyReconcileResponse -> ShowS#

show :: ConcurrencyReconcileResponse -> String#

showList :: [ConcurrencyReconcileResponse] -> ShowS#

type Rep ConcurrencyReconcileResponse Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep ConcurrencyReconcileResponse = D1 ('MetaData "ConcurrencyReconcileResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "ConcurrencyReconcileResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "reconciled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)))

Health

data HealthStatusSource #

Whether the API can reach its database.

Constructors

Ok	The database answered.
Down	The database did not answer.

Instances

Instances details

FromJSON HealthStatus Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser HealthStatus#

parseJSONList :: Value -> Parser [HealthStatus]#

omittedField :: Maybe HealthStatus#

ToJSON HealthStatus Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: HealthStatus -> Value#

toEncoding :: HealthStatus -> Encoding#

toJSONList :: [HealthStatus] -> Value#

toEncodingList :: [HealthStatus] -> Encoding#

omitField :: HealthStatus -> Bool#

Eq HealthStatus Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: HealthStatus -> HealthStatus -> Bool#

(/=) :: HealthStatus -> HealthStatus -> Bool#

Bounded HealthStatus Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

minBound :: HealthStatus#

maxBound :: HealthStatus#

Enum HealthStatus Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

succ :: HealthStatus -> HealthStatus#

pred :: HealthStatus -> HealthStatus#

toEnum :: Int -> HealthStatus#

fromEnum :: HealthStatus -> Int#

enumFrom :: HealthStatus -> [HealthStatus]#

enumFromThen :: HealthStatus -> HealthStatus -> [HealthStatus]#

enumFromTo :: HealthStatus -> HealthStatus -> [HealthStatus]#

enumFromThenTo :: HealthStatus -> HealthStatus -> HealthStatus -> [HealthStatus]#

Generic HealthStatus Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep HealthStatus
Instance details Defined in Arbiter.Servant.Types type Rep HealthStatus = D1 ('MetaData "HealthStatus" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'False) (C1 ('MetaCons "Ok" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Down" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: HealthStatus -> Rep HealthStatus x#

to :: Rep HealthStatus x -> HealthStatus#

Show HealthStatus Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> HealthStatus -> ShowS#

show :: HealthStatus -> String#

showList :: [HealthStatus] -> ShowS#

type Rep HealthStatus Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep HealthStatus = D1 ('MetaData "HealthStatus" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'False) (C1 ('MetaCons "Ok" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Down" 'PrefixI 'False) (U1 :: Type -> Type))

healthStatusToText :: HealthStatus -> TextSource #

The JSON text of a status: ok or down.

data HealthResponseSource #

Readiness of the API and the database behind it.

Constructors

HealthResponse
Fields status :: HealthStatus schemaName :: Text The schema the API serves. checkedAt :: UTCTime When the probe finished. dbLatencyMs :: Maybe Double Null when the database could not be reached. db :: Maybe PgDbHealth Connection and age counters. Null when the database is unreachable or reports no row.

Instances

Instances details

FromJSON HealthResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser HealthResponse#

parseJSONList :: Value -> Parser [HealthResponse]#

omittedField :: Maybe HealthResponse#

ToJSON HealthResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: HealthResponse -> Value#

toEncoding :: HealthResponse -> Encoding#

toJSONList :: [HealthResponse] -> Value#

toEncodingList :: [HealthResponse] -> Encoding#

omitField :: HealthResponse -> Bool#

Eq HealthResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: HealthResponse -> HealthResponse -> Bool#

(/=) :: HealthResponse -> HealthResponse -> Bool#

Generic HealthResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep HealthResponse

Instance details

Defined in Arbiter.Servant.Types

type Rep HealthResponse = D1 ('MetaData "HealthResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'False) (C1 ('MetaCons "HealthResponse" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HealthStatus) :*: S1 ('MetaSel ('Just "schemaName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "checkedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: (S1 ('MetaSel ('Just "dbLatencyMs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "db") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe PgDbHealth))))))

Methods

from :: HealthResponse -> Rep HealthResponse x#

to :: Rep HealthResponse x -> HealthResponse#

Show HealthResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> HealthResponse -> ShowS#

show :: HealthResponse -> String#

showList :: [HealthResponse] -> ShowS#

type Rep HealthResponse Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep HealthResponse = D1 ('MetaData "HealthResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'False) (C1 ('MetaCons "HealthResponse" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HealthStatus) :*: S1 ('MetaSel ('Just "schemaName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "checkedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: (S1 ('MetaSel ('Just "dbLatencyMs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "db") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe PgDbHealth))))))

newtype LivenessResponseSource #

The process is running. Answered without touching the database.

Constructors

LivenessResponse
Fields alive :: Bool

Instances

Instances details

FromJSON LivenessResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

parseJSON :: Value -> Parser LivenessResponse#

parseJSONList :: Value -> Parser [LivenessResponse]#

omittedField :: Maybe LivenessResponse#

ToJSON LivenessResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

toJSON :: LivenessResponse -> Value#

toEncoding :: LivenessResponse -> Encoding#

toJSONList :: [LivenessResponse] -> Value#

toEncodingList :: [LivenessResponse] -> Encoding#

omitField :: LivenessResponse -> Bool#

Eq LivenessResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

(==) :: LivenessResponse -> LivenessResponse -> Bool#

(/=) :: LivenessResponse -> LivenessResponse -> Bool#

Generic LivenessResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Associated Types

type Rep LivenessResponse
Instance details Defined in Arbiter.Servant.Types type Rep LivenessResponse = D1 ('MetaData "LivenessResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "LivenessResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "alive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))

Methods

from :: LivenessResponse -> Rep LivenessResponse x#

to :: Rep LivenessResponse x -> LivenessResponse#

Show LivenessResponse Source #

Instance details

Defined in Arbiter.Servant.Types

Methods

showsPrec :: Int -> LivenessResponse -> ShowS#

show :: LivenessResponse -> String#

showList :: [LivenessResponse] -> ShowS#

type Rep LivenessResponse Source #

Instance details

Defined in Arbiter.Servant.Types

type Rep LivenessResponse = D1 ('MetaData "LivenessResponse" "Arbiter.Servant.Types" "arbiter-servant-0.1.0.0-inplace" 'True) (C1 ('MetaCons "LivenessResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "alive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))

Re-exported core types

data CronScheduleRow#

A row from the cron_schedules table.

Constructors

CronScheduleRow

Fields

name :: Text
Schedule name.
queueName :: Text
The queue the schedule inserts into.
defaultExpression :: Text
Code-defined cron expression.
defaultOverlap :: Text
Code-defined overlap policy: SkipOverlap or AllowOverlap.
defaultTimezone :: Maybe Text
Code-defined IANA tz name. Nothing means UTC.
overrideExpression :: Maybe Text
User override. Nothing uses the default.
overrideOverlap :: Maybe Text
User override: SkipOverlap or AllowOverlap. Nothing uses the default.
overrideTimezone :: Maybe Text
User override. Nothing uses the default. To force UTC when the default is not UTC, set to "UTC".
enabled :: Bool
A disabled schedule fires no jobs.
lastFiredAt :: Maybe UTCTime
The minute of the last tick that fired. Nothing when it never fired.
lastCheckedAt :: Maybe UTCTime
How far the scheduler has checked for ticks. Nothing when it never checked.
runRequestedAt :: Maybe UTCTime
Manual run awaiting a worker pool. Nothing when none is pending.
lastManualRunAt :: Maybe UTCTime
When a manual run last fired a job. Nothing when it never fired.
createdAt :: UTCTime
When the row was created.
updatedAt :: UTCTime
When the row last changed.

Instances

Instances details

FromJSON CronScheduleRow #

Instance details

Defined in Arbiter.Core.CronSchedule

Methods

parseJSON :: Value -> Parser CronScheduleRow#

parseJSONList :: Value -> Parser [CronScheduleRow]#

omittedField :: Maybe CronScheduleRow#

ToJSON CronScheduleRow #

Instance details

Defined in Arbiter.Core.CronSchedule

Methods

toJSON :: CronScheduleRow -> Value#

toEncoding :: CronScheduleRow -> Encoding#

toJSONList :: [CronScheduleRow] -> Value#

toEncodingList :: [CronScheduleRow] -> Encoding#

omitField :: CronScheduleRow -> Bool#

Eq CronScheduleRow #

Instance details

Defined in Arbiter.Core.CronSchedule

Methods

(==) :: CronScheduleRow -> CronScheduleRow -> Bool#

(/=) :: CronScheduleRow -> CronScheduleRow -> Bool#

Generic CronScheduleRow #

Instance details

Defined in Arbiter.Core.CronSchedule

Associated Types

type Rep CronScheduleRow

Instance details

Defined in Arbiter.Core.CronSchedule

Methods

from :: CronScheduleRow -> Rep CronScheduleRow x#

to :: Rep CronScheduleRow x -> CronScheduleRow#

Show CronScheduleRow #

Instance details

Defined in Arbiter.Core.CronSchedule

Methods

showsPrec :: Int -> CronScheduleRow -> ShowS#

show :: CronScheduleRow -> String#

showList :: [CronScheduleRow] -> ShowS#

type Rep CronScheduleRow #

Instance details

Defined in Arbiter.Core.CronSchedule

data CronScheduleUpdate#

A patch over a cron schedule's overrides. Nothing leaves a field unchanged, Just Nothing clears the override back to the default, Just (Just v) sets it.

Constructors

CronScheduleUpdate
Fields overrideExpression :: Maybe (Maybe Text) The cron expression override. overrideOverlap :: Maybe (Maybe Text) The overlap policy override. overrideTimezone :: Maybe (Maybe Text) The timezone override. enabled :: Maybe Bool The enabled flag. `Just` sets it.

Instances

Instances details

FromJSON CronScheduleUpdate #

Instance details

Defined in Arbiter.Core.CronSchedule

Methods

parseJSON :: Value -> Parser CronScheduleUpdate#

parseJSONList :: Value -> Parser [CronScheduleUpdate]#

omittedField :: Maybe CronScheduleUpdate#

ToJSON CronScheduleUpdate #

Instance details

Defined in Arbiter.Core.CronSchedule

Methods

toJSON :: CronScheduleUpdate -> Value#

toEncoding :: CronScheduleUpdate -> Encoding#

toJSONList :: [CronScheduleUpdate] -> Value#

toEncodingList :: [CronScheduleUpdate] -> Encoding#

omitField :: CronScheduleUpdate -> Bool#

Eq CronScheduleUpdate #

Instance details

Defined in Arbiter.Core.CronSchedule

Methods

(==) :: CronScheduleUpdate -> CronScheduleUpdate -> Bool#

(/=) :: CronScheduleUpdate -> CronScheduleUpdate -> Bool#

Generic CronScheduleUpdate #

Instance details

Defined in Arbiter.Core.CronSchedule

Associated Types

type Rep CronScheduleUpdate

Instance details

Defined in Arbiter.Core.CronSchedule

type Rep CronScheduleUpdate = D1 ('MetaData "CronScheduleUpdate" "Arbiter.Core.CronSchedule" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "CronScheduleUpdate" 'PrefixI 'True) ((S1 ('MetaSel ('Just "overrideExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe Text))) :*: S1 ('MetaSel ('Just "overrideOverlap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe Text)))) :*: (S1 ('MetaSel ('Just "overrideTimezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe Text))) :*: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

Methods

from :: CronScheduleUpdate -> Rep CronScheduleUpdate x#

to :: Rep CronScheduleUpdate x -> CronScheduleUpdate#

Show CronScheduleUpdate #

Instance details

Defined in Arbiter.Core.CronSchedule

Methods

showsPrec :: Int -> CronScheduleUpdate -> ShowS#

show :: CronScheduleUpdate -> String#

showList :: [CronScheduleUpdate] -> ShowS#

type Rep CronScheduleUpdate #

Instance details

Defined in Arbiter.Core.CronSchedule

type Rep CronScheduleUpdate = D1 ('MetaData "CronScheduleUpdate" "Arbiter.Core.CronSchedule" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "CronScheduleUpdate" 'PrefixI 'True) ((S1 ('MetaSel ('Just "overrideExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe Text))) :*: S1 ('MetaSel ('Just "overrideOverlap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe Text)))) :*: (S1 ('MetaSel ('Just "overrideTimezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe Text))) :*: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

data QueueOverview#

A landing-overview row: a queue's stats, pause flag and worker counts.

Constructors

QueueOverview
Fields overviewQueue :: Text Queue name. overviewStats :: QueueStats The queue's per-status counts. overviewQueuePaused :: Bool The queue's pause flag. overviewWorkersLive :: Int64 Workers with a fresh heartbeat that are not draining. overviewWorkersPaused :: Int64 Live workers whose pause flag is set.

Instances

Instances details

FromJSON QueueOverview #

Instance details

Defined in Arbiter.Core.Operations

Methods

parseJSON :: Value -> Parser QueueOverview#

parseJSONList :: Value -> Parser [QueueOverview]#

omittedField :: Maybe QueueOverview#

ToJSON QueueOverview #

Instance details

Defined in Arbiter.Core.Operations

Methods

toJSON :: QueueOverview -> Value#

toEncoding :: QueueOverview -> Encoding#

toJSONList :: [QueueOverview] -> Value#

toEncodingList :: [QueueOverview] -> Encoding#

omitField :: QueueOverview -> Bool#

Eq QueueOverview #

Instance details

Defined in Arbiter.Core.Operations

Methods

(==) :: QueueOverview -> QueueOverview -> Bool#

(/=) :: QueueOverview -> QueueOverview -> Bool#

Generic QueueOverview #

Instance details

Defined in Arbiter.Core.Operations

Associated Types

type Rep QueueOverview

Instance details

Defined in Arbiter.Core.Operations

type Rep QueueOverview = D1 ('MetaData "QueueOverview" "Arbiter.Core.Operations" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "QueueOverview" 'PrefixI 'True) ((S1 ('MetaSel ('Just "overviewQueue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "overviewStats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 QueueStats)) :*: (S1 ('MetaSel ('Just "overviewQueuePaused") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "overviewWorkersLive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: S1 ('MetaSel ('Just "overviewWorkersPaused") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)))))

Methods

from :: QueueOverview -> Rep QueueOverview x#

to :: Rep QueueOverview x -> QueueOverview#

Show QueueOverview #

Instance details

Defined in Arbiter.Core.Operations

Methods

showsPrec :: Int -> QueueOverview -> ShowS#

show :: QueueOverview -> String#

showList :: [QueueOverview] -> ShowS#

type Rep QueueOverview #

Instance details

Defined in Arbiter.Core.Operations

type Rep QueueOverview = D1 ('MetaData "QueueOverview" "Arbiter.Core.Operations" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "QueueOverview" 'PrefixI 'True) ((S1 ('MetaSel ('Just "overviewQueue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "overviewStats") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 QueueStats)) :*: (S1 ('MetaSel ('Just "overviewQueuePaused") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "overviewWorkersLive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: S1 ('MetaSel ('Just "overviewWorkersPaused") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)))))

data QueueStats#

Per-status breakdown of a queue. The per-status counts partition the queue and sum to totalJobs.

Constructors

QueueStats

Fields

totalJobs :: Int64
Total number of jobs in the queue.
readyJobs :: Int64
Jobs claimable right now (visible, unleased and not blocked).
inFlightJobs :: Int64
Jobs currently leased by a worker.
scheduledJobs :: Int64
Jobs with no attempt used, delayed until a future not_visible_until.
backoffJobs :: Int64
Unclaimed jobs with an attempt spent, waiting out a delay.
throttledJobs :: Int64
Jobs parked by a rate limit until tokens refill.
suspendedJobs :: Int64
Suspended jobs (for example rollup finalizers awaiting their children).
cancelledJobs :: Int64
Force-cancelled jobs flagged for teardown and awaiting the reaper.
exhaustedJobs :: Int64
Visible jobs out of attempts, awaiting the reaper's DLQ sweep.
blockedJobs :: Int64
Visible jobs a single claim would skip: behind a group's head, or behind a full concurrency or rate-limit key.
oldestReadyAgeSeconds :: Maybe Double
Seconds since the oldest ready or blocked job became visible (Nothing when none wait).
oldestInFlightAgeSeconds :: Maybe Double
Seconds since the oldest in-flight job was claimed (Nothing when none are leased). Measures work still running.
dlqJobs :: Int64
Entries in the companion DLQ table. Outside the status partition and totalJobs.
kindCounts :: Map Text Int64
Depth by declared payload variant. Rows with no declared label are left out.
dlqKindCounts :: Map Text Int64
DLQ entries by declared payload variant. Rows with no declared label are left out. Empty in the stats for all queues.

Instances

Instances details

FromJSON QueueStats #

Instance details

Defined in Arbiter.Core.Operations

Methods

parseJSON :: Value -> Parser QueueStats#

parseJSONList :: Value -> Parser [QueueStats]#

omittedField :: Maybe QueueStats#

ToJSON QueueStats #

Instance details

Defined in Arbiter.Core.Operations

Methods

toJSON :: QueueStats -> Value#

toEncoding :: QueueStats -> Encoding#

toJSONList :: [QueueStats] -> Value#

toEncodingList :: [QueueStats] -> Encoding#

omitField :: QueueStats -> Bool#

Eq QueueStats #

Instance details

Defined in Arbiter.Core.Operations

Methods

(==) :: QueueStats -> QueueStats -> Bool#

(/=) :: QueueStats -> QueueStats -> Bool#

Generic QueueStats #

Instance details

Defined in Arbiter.Core.Operations

Associated Types

type Rep QueueStats

Instance details

Defined in Arbiter.Core.Operations

Methods

from :: QueueStats -> Rep QueueStats x#

to :: Rep QueueStats x -> QueueStats#

Show QueueStats #

Instance details

Defined in Arbiter.Core.Operations

Methods

showsPrec :: Int -> QueueStats -> ShowS#

show :: QueueStats -> String#

showList :: [QueueStats] -> ShowS#

type Rep QueueStats #

Instance details

Defined in Arbiter.Core.Operations

data QueueRow#

A row of the arbiter_queues table.

Constructors

QueueRow

Fields

queueName :: Text
The queue's table name.
paused :: Bool
Whether the queue is paused.
pausedAt :: Maybe UTCTime
When the queue was paused. Nothing while it runs.
metadata :: Maybe Value
Free-form metadata.
createdAt :: UTCTime
When the row was created.
updatedAt :: UTCTime
When the row last changed.
dlqRetention :: Maybe NominalDiffTime
Age in seconds at which the reaper purges the queue's DLQ jobs. Nothing keeps them.

Instances

Instances details

FromJSON QueueRow #

Instance details

Defined in Arbiter.Core.Queues

Methods

parseJSON :: Value -> Parser QueueRow#

parseJSONList :: Value -> Parser [QueueRow]#

omittedField :: Maybe QueueRow#

ToJSON QueueRow #

Instance details

Defined in Arbiter.Core.Queues

Methods

toJSON :: QueueRow -> Value#

toEncoding :: QueueRow -> Encoding#

toJSONList :: [QueueRow] -> Value#

toEncodingList :: [QueueRow] -> Encoding#

omitField :: QueueRow -> Bool#

Eq QueueRow #

Instance details

Defined in Arbiter.Core.Queues

Methods

(==) :: QueueRow -> QueueRow -> Bool#

(/=) :: QueueRow -> QueueRow -> Bool#

Generic QueueRow #

Instance details

Defined in Arbiter.Core.Queues

Associated Types

type Rep QueueRow

Instance details

Defined in Arbiter.Core.Queues

type Rep QueueRow = D1 ('MetaData "QueueRow" "Arbiter.Core.Queues" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "QueueRow" 'PrefixI 'True) ((S1 ('MetaSel ('Just "queueName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "paused") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "pausedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe UTCTime)))) :*: ((S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)) :*: (S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "dlqRetention") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe NominalDiffTime))))))

Methods

from :: QueueRow -> Rep QueueRow x#

to :: Rep QueueRow x -> QueueRow#

Show QueueRow #

Instance details

Defined in Arbiter.Core.Queues

Methods

showsPrec :: Int -> QueueRow -> ShowS#

show :: QueueRow -> String#

showList :: [QueueRow] -> ShowS#

type Rep QueueRow #

Instance details

Defined in Arbiter.Core.Queues

type Rep QueueRow = D1 ('MetaData "QueueRow" "Arbiter.Core.Queues" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "QueueRow" 'PrefixI 'True) ((S1 ('MetaSel ('Just "queueName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "paused") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "pausedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe UTCTime)))) :*: ((S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)) :*: (S1 ('MetaSel ('Just "updatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "dlqRetention") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe NominalDiffTime))))))

data WorkerRow#

A row in the worker registry. One row per running worker.

Constructors

WorkerRow

Fields

workerId :: UUID
The worker's id.
queueName :: Text
The queue the worker works.
hostName :: Maybe Text
The host the worker runs on.
workerCount :: Maybe Int32
The worker's thread count.
startedAt :: UTCTime
When the worker registered.
lastHeartbeat :: UTCTime
When the worker last sent a heartbeat.
shuttingDown :: Bool
Whether the worker is draining.
paused :: Bool
The worker's own pause flag. The queue's flag is separate.
staleThresholdSecs :: Double
Heartbeat age in seconds after which the worker counts as stale.
metadata :: Maybe Value
Free-form metadata the worker registered.
health :: WorkerHealth
Health derived from the heartbeat and the shutdown flag.

Instances

Instances details

FromJSON WorkerRow #

Instance details

Defined in Arbiter.Core.Worker

Methods

parseJSON :: Value -> Parser WorkerRow#

parseJSONList :: Value -> Parser [WorkerRow]#

omittedField :: Maybe WorkerRow#

ToJSON WorkerRow #

Instance details

Defined in Arbiter.Core.Worker

Methods

toJSON :: WorkerRow -> Value#

toEncoding :: WorkerRow -> Encoding#

toJSONList :: [WorkerRow] -> Value#

toEncodingList :: [WorkerRow] -> Encoding#

omitField :: WorkerRow -> Bool#

Eq WorkerRow #

Instance details

Defined in Arbiter.Core.Worker

Methods

(==) :: WorkerRow -> WorkerRow -> Bool#

(/=) :: WorkerRow -> WorkerRow -> Bool#

Generic WorkerRow #

Instance details

Defined in Arbiter.Core.Worker

Associated Types

type Rep WorkerRow

Instance details

Defined in Arbiter.Core.Worker

Methods

from :: WorkerRow -> Rep WorkerRow x#

to :: Rep WorkerRow x -> WorkerRow#

Show WorkerRow #

Instance details

Defined in Arbiter.Core.Worker

Methods

showsPrec :: Int -> WorkerRow -> ShowS#

show :: WorkerRow -> String#

showList :: [WorkerRow] -> ShowS#

type Rep WorkerRow #

Instance details

Defined in Arbiter.Core.Worker

data RateLimitPolicyView#

A policy with its default and override params plus live bucket and throttle stats. Each effective param is its override* field when set, else its default* field.

Constructors

RateLimitPolicyView

Fields

prefix :: Text
The policy's key prefix.
defaultMaxTokens :: Double
The declared bucket capacity, in tokens.
defaultRefillAmount :: Double
The declared tokens added per interval.
defaultInterval :: Double
The declared refill interval, in seconds.
overrideMaxTokens :: Maybe Double
The operator's bucket capacity, in tokens. Nothing when unset.
overrideRefillAmount :: Maybe Double
The operator's tokens added per interval. Nothing when unset.
overrideInterval :: Maybe Double
The operator's refill interval, in seconds. Nothing when unset.
bucketCount :: Int64
Buckets under the prefix.
throttledCount :: Int64
Jobs the policy holds throttled, over every registry queue.
throttledQueues :: [Text]
The queues that hold throttled jobs, the most first.
minTokens :: Maybe Double
The lowest token count of one bucket, refill included. Nothing when the prefix has no bucket.
avgTokens :: Maybe Double
The mean token count over the buckets, refill included. Nothing when the prefix has no bucket.

Instances

Instances details

FromJSON RateLimitPolicyView #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

parseJSON :: Value -> Parser RateLimitPolicyView#

parseJSONList :: Value -> Parser [RateLimitPolicyView]#

omittedField :: Maybe RateLimitPolicyView#

ToJSON RateLimitPolicyView #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

toJSON :: RateLimitPolicyView -> Value#

toEncoding :: RateLimitPolicyView -> Encoding#

toJSONList :: [RateLimitPolicyView] -> Value#

toEncodingList :: [RateLimitPolicyView] -> Encoding#

omitField :: RateLimitPolicyView -> Bool#

Eq RateLimitPolicyView #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

(==) :: RateLimitPolicyView -> RateLimitPolicyView -> Bool#

(/=) :: RateLimitPolicyView -> RateLimitPolicyView -> Bool#

Generic RateLimitPolicyView #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Associated Types

type Rep RateLimitPolicyView

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

from :: RateLimitPolicyView -> Rep RateLimitPolicyView x#

to :: Rep RateLimitPolicyView x -> RateLimitPolicyView#

Show RateLimitPolicyView #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

showsPrec :: Int -> RateLimitPolicyView -> ShowS#

show :: RateLimitPolicyView -> String#

showList :: [RateLimitPolicyView] -> ShowS#

type Rep RateLimitPolicyView #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

data RateLimitBucketView#

A single key's bucket: current tokens, effective max, and fill fraction.

Constructors

RateLimitBucketView
Fields rateLimitKey :: Text The full `prefix:suffix` key. rateLimitPrefix :: Text The policy's key prefix. tokens :: Double Tokens available now, refill included. maxTokens :: Double The effective bucket capacity, in tokens. fillFraction :: Maybe Double Tokens divided by capacity. `Nothing` when the capacity is 0. lastRefill :: UTCTime When the bucket last stored a refill.

Instances

Instances details

FromJSON RateLimitBucketView #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

parseJSON :: Value -> Parser RateLimitBucketView#

parseJSONList :: Value -> Parser [RateLimitBucketView]#

omittedField :: Maybe RateLimitBucketView#

ToJSON RateLimitBucketView #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

toJSON :: RateLimitBucketView -> Value#

toEncoding :: RateLimitBucketView -> Encoding#

toJSONList :: [RateLimitBucketView] -> Value#

toEncodingList :: [RateLimitBucketView] -> Encoding#

omitField :: RateLimitBucketView -> Bool#

Eq RateLimitBucketView #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

(==) :: RateLimitBucketView -> RateLimitBucketView -> Bool#

(/=) :: RateLimitBucketView -> RateLimitBucketView -> Bool#

Generic RateLimitBucketView #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Associated Types

type Rep RateLimitBucketView

Instance details

Defined in Arbiter.Core.RateLimit.Stats

type Rep RateLimitBucketView = D1 ('MetaData "RateLimitBucketView" "Arbiter.Core.RateLimit.Stats" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "RateLimitBucketView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rateLimitKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "rateLimitPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double))) :*: (S1 ('MetaSel ('Just "maxTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: (S1 ('MetaSel ('Just "fillFraction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "lastRefill") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))))

Methods

from :: RateLimitBucketView -> Rep RateLimitBucketView x#

to :: Rep RateLimitBucketView x -> RateLimitBucketView#

Show RateLimitBucketView #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

showsPrec :: Int -> RateLimitBucketView -> ShowS#

show :: RateLimitBucketView -> String#

showList :: [RateLimitBucketView] -> ShowS#

type Rep RateLimitBucketView #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

type Rep RateLimitBucketView = D1 ('MetaData "RateLimitBucketView" "Arbiter.Core.RateLimit.Stats" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "RateLimitBucketView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rateLimitKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "rateLimitPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "tokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double))) :*: (S1 ('MetaSel ('Just "maxTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: (S1 ('MetaSel ('Just "fillFraction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "lastRefill") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))))

data RateLimitPolicyUpdate#

A patch over a policy's override params. Per field: Nothing leaves it unchanged, Just Nothing clears the override (reverts to the default), and Just (Just v) sets it.

Constructors

RateLimitPolicyUpdate
Fields overrideMaxTokens :: Maybe (Maybe Double) The bucket capacity override, in tokens. overrideRefillAmount :: Maybe (Maybe Double) The tokens-per-interval override. overrideInterval :: Maybe (Maybe Double) The refill interval override, in seconds.

Instances

Instances details

FromJSON RateLimitPolicyUpdate #

A missing key leaves the field unchanged. An explicit null clears the override.

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

parseJSON :: Value -> Parser RateLimitPolicyUpdate#

parseJSONList :: Value -> Parser [RateLimitPolicyUpdate]#

omittedField :: Maybe RateLimitPolicyUpdate#

ToJSON RateLimitPolicyUpdate #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

toJSON :: RateLimitPolicyUpdate -> Value#

toEncoding :: RateLimitPolicyUpdate -> Encoding#

toJSONList :: [RateLimitPolicyUpdate] -> Value#

toEncodingList :: [RateLimitPolicyUpdate] -> Encoding#

omitField :: RateLimitPolicyUpdate -> Bool#

Eq RateLimitPolicyUpdate #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

(==) :: RateLimitPolicyUpdate -> RateLimitPolicyUpdate -> Bool#

(/=) :: RateLimitPolicyUpdate -> RateLimitPolicyUpdate -> Bool#

Generic RateLimitPolicyUpdate #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Associated Types

type Rep RateLimitPolicyUpdate

Instance details

Defined in Arbiter.Core.RateLimit.Stats

type Rep RateLimitPolicyUpdate = D1 ('MetaData "RateLimitPolicyUpdate" "Arbiter.Core.RateLimit.Stats" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "RateLimitPolicyUpdate" 'PrefixI 'True) (S1 ('MetaSel ('Just "overrideMaxTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe Double))) :*: (S1 ('MetaSel ('Just "overrideRefillAmount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe Double))) :*: S1 ('MetaSel ('Just "overrideInterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe Double))))))

Methods

from :: RateLimitPolicyUpdate -> Rep RateLimitPolicyUpdate x#

to :: Rep RateLimitPolicyUpdate x -> RateLimitPolicyUpdate#

Show RateLimitPolicyUpdate #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

Methods

showsPrec :: Int -> RateLimitPolicyUpdate -> ShowS#

show :: RateLimitPolicyUpdate -> String#

showList :: [RateLimitPolicyUpdate] -> ShowS#

type Rep RateLimitPolicyUpdate #

Instance details

Defined in Arbiter.Core.RateLimit.Stats

type Rep RateLimitPolicyUpdate = D1 ('MetaData "RateLimitPolicyUpdate" "Arbiter.Core.RateLimit.Stats" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "RateLimitPolicyUpdate" 'PrefixI 'True) (S1 ('MetaSel ('Just "overrideMaxTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe Double))) :*: (S1 ('MetaSel ('Just "overrideRefillAmount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe Double))) :*: S1 ('MetaSel ('Just "overrideInterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe Double))))))

data ConcurrencyPolicyView#

A concurrency policy with its default and override limits plus live key and in-flight stats. The effective cap is overrideLimit when set, else defaultLimit.

Constructors

ConcurrencyPolicyView

Fields

prefix :: Text
The policy's key prefix.
defaultLimit :: Int32
The declared per-key limit, in jobs.
overrideLimit :: Maybe Int32
The operator's per-key limit, in jobs. Nothing when unset.
keyCount :: Int64
Keys tracked under the prefix.
totalInFlight :: Int64
In-flight jobs summed over every key.
maxInFlight :: Maybe Int32
The highest in-flight count of one key. Nothing when the prefix has no key.

Instances

Instances details

FromJSON ConcurrencyPolicyView #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

parseJSON :: Value -> Parser ConcurrencyPolicyView#

parseJSONList :: Value -> Parser [ConcurrencyPolicyView]#

omittedField :: Maybe ConcurrencyPolicyView#

ToJSON ConcurrencyPolicyView #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

toJSON :: ConcurrencyPolicyView -> Value#

toEncoding :: ConcurrencyPolicyView -> Encoding#

toJSONList :: [ConcurrencyPolicyView] -> Value#

toEncodingList :: [ConcurrencyPolicyView] -> Encoding#

omitField :: ConcurrencyPolicyView -> Bool#

Eq ConcurrencyPolicyView #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

(==) :: ConcurrencyPolicyView -> ConcurrencyPolicyView -> Bool#

(/=) :: ConcurrencyPolicyView -> ConcurrencyPolicyView -> Bool#

Generic ConcurrencyPolicyView #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Associated Types

type Rep ConcurrencyPolicyView

Instance details

Defined in Arbiter.Core.Concurrency.Stats

type Rep ConcurrencyPolicyView = D1 ('MetaData "ConcurrencyPolicyView" "Arbiter.Core.Concurrency.Stats" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ConcurrencyPolicyView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "defaultLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int32) :*: S1 ('MetaSel ('Just "overrideLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int32)))) :*: (S1 ('MetaSel ('Just "keyCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: (S1 ('MetaSel ('Just "totalInFlight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: S1 ('MetaSel ('Just "maxInFlight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int32))))))

Methods

from :: ConcurrencyPolicyView -> Rep ConcurrencyPolicyView x#

to :: Rep ConcurrencyPolicyView x -> ConcurrencyPolicyView#

Show ConcurrencyPolicyView #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

showsPrec :: Int -> ConcurrencyPolicyView -> ShowS#

show :: ConcurrencyPolicyView -> String#

showList :: [ConcurrencyPolicyView] -> ShowS#

type Rep ConcurrencyPolicyView #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

type Rep ConcurrencyPolicyView = D1 ('MetaData "ConcurrencyPolicyView" "Arbiter.Core.Concurrency.Stats" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ConcurrencyPolicyView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "defaultLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int32) :*: S1 ('MetaSel ('Just "overrideLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int32)))) :*: (S1 ('MetaSel ('Just "keyCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: (S1 ('MetaSel ('Just "totalInFlight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: S1 ('MetaSel ('Just "maxInFlight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int32))))))

data ConcurrencyKeyView#

A single key's in-flight count, its effective cap, and fill fraction.

Constructors

ConcurrencyKeyView
Fields concurrencyKey :: Text The full `prefix:suffix` key. concurrencyPrefix :: Text The policy's key prefix. inFlight :: Int32 Jobs in flight under the key. effectiveLimit :: Int32 The override limit when set, else the default, in jobs. fillFraction :: Maybe Double In-flight jobs divided by the effective limit. `Nothing` when the limit is 0.

Instances

Instances details

FromJSON ConcurrencyKeyView #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

parseJSON :: Value -> Parser ConcurrencyKeyView#

parseJSONList :: Value -> Parser [ConcurrencyKeyView]#

omittedField :: Maybe ConcurrencyKeyView#

ToJSON ConcurrencyKeyView #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

toJSON :: ConcurrencyKeyView -> Value#

toEncoding :: ConcurrencyKeyView -> Encoding#

toJSONList :: [ConcurrencyKeyView] -> Value#

toEncodingList :: [ConcurrencyKeyView] -> Encoding#

omitField :: ConcurrencyKeyView -> Bool#

Eq ConcurrencyKeyView #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

(==) :: ConcurrencyKeyView -> ConcurrencyKeyView -> Bool#

(/=) :: ConcurrencyKeyView -> ConcurrencyKeyView -> Bool#

Generic ConcurrencyKeyView #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Associated Types

type Rep ConcurrencyKeyView

Instance details

Defined in Arbiter.Core.Concurrency.Stats

type Rep ConcurrencyKeyView = D1 ('MetaData "ConcurrencyKeyView" "Arbiter.Core.Concurrency.Stats" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ConcurrencyKeyView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "concurrencyKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "concurrencyPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "inFlight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int32) :*: (S1 ('MetaSel ('Just "effectiveLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int32) :*: S1 ('MetaSel ('Just "fillFraction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double))))))

Methods

from :: ConcurrencyKeyView -> Rep ConcurrencyKeyView x#

to :: Rep ConcurrencyKeyView x -> ConcurrencyKeyView#

Show ConcurrencyKeyView #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

showsPrec :: Int -> ConcurrencyKeyView -> ShowS#

show :: ConcurrencyKeyView -> String#

showList :: [ConcurrencyKeyView] -> ShowS#

type Rep ConcurrencyKeyView #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

type Rep ConcurrencyKeyView = D1 ('MetaData "ConcurrencyKeyView" "Arbiter.Core.Concurrency.Stats" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ConcurrencyKeyView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "concurrencyKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "concurrencyPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "inFlight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int32) :*: (S1 ('MetaSel ('Just "effectiveLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int32) :*: S1 ('MetaSel ('Just "fillFraction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Double))))))

data ConcurrencyPolicyUpdate#

A patch over a concurrency policy's override limit. Nothing leaves it unchanged, Just Nothing clears the override (reverts to the default), and Just (Just v) sets it.

Constructors

ConcurrencyPolicyUpdate
Fields overrideLimit :: Maybe (Maybe Int32) The per-key limit override, in jobs.

Instances

Instances details

FromJSON ConcurrencyPolicyUpdate #

A missing key leaves the field unchanged. An explicit null clears the override.

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

parseJSON :: Value -> Parser ConcurrencyPolicyUpdate#

parseJSONList :: Value -> Parser [ConcurrencyPolicyUpdate]#

omittedField :: Maybe ConcurrencyPolicyUpdate#

ToJSON ConcurrencyPolicyUpdate #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

toJSON :: ConcurrencyPolicyUpdate -> Value#

toEncoding :: ConcurrencyPolicyUpdate -> Encoding#

toJSONList :: [ConcurrencyPolicyUpdate] -> Value#

toEncodingList :: [ConcurrencyPolicyUpdate] -> Encoding#

omitField :: ConcurrencyPolicyUpdate -> Bool#

Eq ConcurrencyPolicyUpdate #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

(==) :: ConcurrencyPolicyUpdate -> ConcurrencyPolicyUpdate -> Bool#

(/=) :: ConcurrencyPolicyUpdate -> ConcurrencyPolicyUpdate -> Bool#

Generic ConcurrencyPolicyUpdate #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Associated Types

type Rep ConcurrencyPolicyUpdate
Instance details Defined in Arbiter.Core.Concurrency.Stats type Rep ConcurrencyPolicyUpdate = D1 ('MetaData "ConcurrencyPolicyUpdate" "Arbiter.Core.Concurrency.Stats" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ConcurrencyPolicyUpdate" 'PrefixI 'True) (S1 ('MetaSel ('Just "overrideLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe Int32)))))

Methods

from :: ConcurrencyPolicyUpdate -> Rep ConcurrencyPolicyUpdate x#

to :: Rep ConcurrencyPolicyUpdate x -> ConcurrencyPolicyUpdate#

Show ConcurrencyPolicyUpdate #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

Methods

showsPrec :: Int -> ConcurrencyPolicyUpdate -> ShowS#

show :: ConcurrencyPolicyUpdate -> String#

showList :: [ConcurrencyPolicyUpdate] -> ShowS#

type Rep ConcurrencyPolicyUpdate #

Instance details

Defined in Arbiter.Core.Concurrency.Stats

type Rep ConcurrencyPolicyUpdate = D1 ('MetaData "ConcurrencyPolicyUpdate" "Arbiter.Core.Concurrency.Stats" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ConcurrencyPolicyUpdate" 'PrefixI 'True) (S1 ('MetaSel ('Just "overrideLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe Int32)))))

data PgDbHealth#

Connection and age counters for the current database, shared with its other clients.

Constructors

PgDbHealth

Fields

numBackends :: Int64
Connections to the database, the reading one excluded.
connActive :: Int64
Connections running a query and not waiting on a lock.
connIdle :: Int64
Idle connections.
connIdleInTxn :: Int64
Connections idle inside an open transaction.
connIdleInTxnAborted :: Int64
Connections idle inside a failed transaction.
connBlocked :: Int64
Connections running a query that waits on a lock.
connOther :: Int64
Connections in any other state, including ones whose state is hidden without pg_read_all_stats.
oldestTxnAge :: Double
Age of the oldest open transaction, in seconds. 0 when none is open.
oldestQueryAge :: Double
Age of the oldest running query, in seconds. 0 when none runs.

Instances

Instances details

FromJSON PgDbHealth #

Instance details

Defined in Arbiter.Core.Health

Methods

parseJSON :: Value -> Parser PgDbHealth#

parseJSONList :: Value -> Parser [PgDbHealth]#

omittedField :: Maybe PgDbHealth#

ToJSON PgDbHealth #

Instance details

Defined in Arbiter.Core.Health

Methods

toJSON :: PgDbHealth -> Value#

toEncoding :: PgDbHealth -> Encoding#

toJSONList :: [PgDbHealth] -> Value#

toEncodingList :: [PgDbHealth] -> Encoding#

omitField :: PgDbHealth -> Bool#

Eq PgDbHealth #

Instance details

Defined in Arbiter.Core.Health

Methods

(==) :: PgDbHealth -> PgDbHealth -> Bool#

(/=) :: PgDbHealth -> PgDbHealth -> Bool#

Generic PgDbHealth #

Instance details

Defined in Arbiter.Core.Health

Associated Types

type Rep PgDbHealth

Instance details

Defined in Arbiter.Core.Health

type Rep PgDbHealth = D1 ('MetaData "PgDbHealth" "Arbiter.Core.Health" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "PgDbHealth" 'PrefixI 'True) (((S1 ('MetaSel ('Just "numBackends") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: S1 ('MetaSel ('Just "connActive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)) :*: (S1 ('MetaSel ('Just "connIdle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: S1 ('MetaSel ('Just "connIdleInTxn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64))) :*: ((S1 ('MetaSel ('Just "connIdleInTxnAborted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: S1 ('MetaSel ('Just "connBlocked") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)) :*: (S1 ('MetaSel ('Just "connOther") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: (S1 ('MetaSel ('Just "oldestTxnAge") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "oldestQueryAge") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double))))))

Methods

from :: PgDbHealth -> Rep PgDbHealth x#

to :: Rep PgDbHealth x -> PgDbHealth#

Show PgDbHealth #

Instance details

Defined in Arbiter.Core.Health

Methods

showsPrec :: Int -> PgDbHealth -> ShowS#

show :: PgDbHealth -> String#

showList :: [PgDbHealth] -> ShowS#

type Rep PgDbHealth #

Instance details

Defined in Arbiter.Core.Health

type Rep PgDbHealth = D1 ('MetaData "PgDbHealth" "Arbiter.Core.Health" "arbiter-core-0.1.0.0-inplace" 'False) (C1 ('MetaCons "PgDbHealth" 'PrefixI 'True) (((S1 ('MetaSel ('Just "numBackends") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: S1 ('MetaSel ('Just "connActive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)) :*: (S1 ('MetaSel ('Just "connIdle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: S1 ('MetaSel ('Just "connIdleInTxn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64))) :*: ((S1 ('MetaSel ('Just "connIdleInTxnAborted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: S1 ('MetaSel ('Just "connBlocked") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64)) :*: (S1 ('MetaSel ('Just "connOther") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: (S1 ('MetaSel ('Just "oldestTxnAge") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "oldestQueryAge") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double))))))

data GroupSummary#

One open group, read from the queue's groups summary.

Constructors

GroupSummary

Fields

gsGroupKey :: Text
The group key.
gsJobCount :: Int64
Jobs in the group.
gsReadyCount :: Int64
Jobs with no visibility time set that are not suspended, cancelled or out of attempts.
gsNextDue :: Maybe UTCTime
The earliest visibility time of the group's jobs that are not suspended, cancelled or out of attempts.
gsInFlightUntil :: Maybe UTCTime
When the lease of the job that holds the group runs out.
gsInFlight :: Bool
A job holds the group now.
gsHeadJobId :: Maybe Int64
The job that holds the group or that its next claim takes.
gsHeadStatus :: Maybe JobStatus
The derived status of gsHeadJobId.
gsHeadBlocked :: Bool
A full concurrency key or a short rate-limit bucket holds the ready head back.

Instances

Instances details

FromJSON GroupSummary #
Instance details Defined in Arbiter.Core.Operations Methods parseJSON :: Value -> Parser GroupSummary# parseJSONList :: Value -> Parser [GroupSummary]# omittedField :: Maybe GroupSummary#
ToJSON GroupSummary #
Instance details Defined in Arbiter.Core.Operations Methods toJSON :: GroupSummary -> Value# toEncoding :: GroupSummary -> Encoding# toJSONList :: [GroupSummary] -> Value# toEncodingList :: [GroupSummary] -> Encoding# omitField :: GroupSummary -> Bool#
Eq GroupSummary #
Instance details Defined in Arbiter.Core.Operations Methods (==) :: GroupSummary -> GroupSummary -> Bool# (/=) :: GroupSummary -> GroupSummary -> Bool#
Show GroupSummary #
Instance details Defined in Arbiter.Core.Operations Methods showsPrec :: Int -> GroupSummary -> ShowS# show :: GroupSummary -> String# showList :: [GroupSummary] -> ShowS#