Safe Haskell	None
Language	Haskell2010

JetStream.API.Consumer

Description

JetStream consumer management contract.

Documentation

data Consumer #

Instances

Instances details

Show Consumer
Instance details Defined in JetStream.Consumer.Types Methods showsPrec :: Int -> Consumer -> ShowS # show :: Consumer -> String # showList :: [Consumer] -> ShowS #
Eq Consumer
Instance details Defined in JetStream.Consumer.Types Methods (==) :: Consumer -> Consumer -> Bool # (/=) :: Consumer -> Consumer -> Bool #
Ord Consumer
Instance details Defined in JetStream.Consumer.Types Methods compare :: Consumer -> Consumer -> Ordering # (<) :: Consumer -> Consumer -> Bool # (<=) :: Consumer -> Consumer -> Bool # (>) :: Consumer -> Consumer -> Bool # (>=) :: Consumer -> Consumer -> Bool # max :: Consumer -> Consumer -> Consumer # min :: Consumer -> Consumer -> Consumer #

data ConsumerAPI #

data ConsumerAction #

Constructors

ConsumerCreate
ConsumerCreateOrUpdate
ConsumerUpdate

Instances

Instances details

Show ConsumerAction
Instance details Defined in JetStream.Consumer.Types Methods showsPrec :: Int -> ConsumerAction -> ShowS # show :: ConsumerAction -> String # showList :: [ConsumerAction] -> ShowS #
Eq ConsumerAction
Instance details Defined in JetStream.Consumer.Types Methods (==) :: ConsumerAction -> ConsumerAction -> Bool # (/=) :: ConsumerAction -> ConsumerAction -> Bool #

data ConsumerConfig #

Instances

Instances details

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

type ConsumerConfigOption = CallOption ConsumerConfigRequest #

data ConsumerFilter #

Constructors

ConsumerFilterSubject Subject
ConsumerFilterSubjects [Subject]

Instances

Instances details

Show ConsumerFilter
Instance details Defined in JetStream.Consumer.Types Methods showsPrec :: Int -> ConsumerFilter -> ShowS # show :: ConsumerFilter -> String # showList :: [ConsumerFilter] -> ShowS #
Eq ConsumerFilter
Instance details Defined in JetStream.Consumer.Types Methods (==) :: ConsumerFilter -> ConsumerFilter -> Bool # (/=) :: ConsumerFilter -> ConsumerFilter -> Bool #

data ConsumerInfo #

Instances

Instances details

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

data ConsumerKind #

Constructors

PullConsumer
PushConsumer Subject

Instances

Instances details

Show ConsumerKind
Instance details Defined in JetStream.Consumer.Types Methods showsPrec :: Int -> ConsumerKind -> ShowS # show :: ConsumerKind -> String # showList :: [ConsumerKind] -> ShowS #
Eq ConsumerKind
Instance details Defined in JetStream.Consumer.Types Methods (==) :: ConsumerKind -> ConsumerKind -> Bool # (/=) :: ConsumerKind -> ConsumerKind -> Bool #

type ConsumerListOption = CallOption ConsumerListRequest #

data ConsumerListResponse #

Instances

Instances details

FromJSON ConsumerListResponse
Instance details Defined in JetStream.Consumer.Types Methods parseJSON :: Value -> Parser ConsumerListResponse # parseJSONList :: Value -> Parser [ConsumerListResponse] # omittedField :: Maybe ConsumerListResponse #
Show ConsumerListResponse
Instance details Defined in JetStream.Consumer.Types Methods showsPrec :: Int -> ConsumerListResponse -> ShowS # show :: ConsumerListResponse -> String # showList :: [ConsumerListResponse] -> ShowS #
Eq ConsumerListResponse
Instance details Defined in JetStream.Consumer.Types Methods (==) :: ConsumerListResponse -> ConsumerListResponse -> Bool # (/=) :: ConsumerListResponse -> ConsumerListResponse -> Bool #

data ConsumerNamesResponse #

Instances

Instances details

FromJSON ConsumerNamesResponse
Instance details Defined in JetStream.Consumer.Types Methods parseJSON :: Value -> Parser ConsumerNamesResponse # parseJSONList :: Value -> Parser [ConsumerNamesResponse] # omittedField :: Maybe ConsumerNamesResponse #
Show ConsumerNamesResponse
Instance details Defined in JetStream.Consumer.Types Methods showsPrec :: Int -> ConsumerNamesResponse -> ShowS # show :: ConsumerNamesResponse -> String # showList :: [ConsumerNamesResponse] -> ShowS #
Eq ConsumerNamesResponse
Instance details Defined in JetStream.Consumer.Types Methods (==) :: ConsumerNamesResponse -> ConsumerNamesResponse -> Bool # (/=) :: ConsumerNamesResponse -> ConsumerNamesResponse -> Bool #

data ConsumerPauseResponse #

Instances

Instances details

FromJSON ConsumerPauseResponse
Instance details Defined in JetStream.Consumer.Types Methods parseJSON :: Value -> Parser ConsumerPauseResponse # parseJSONList :: Value -> Parser [ConsumerPauseResponse] # omittedField :: Maybe ConsumerPauseResponse #
Show ConsumerPauseResponse
Instance details Defined in JetStream.Consumer.Types Methods showsPrec :: Int -> ConsumerPauseResponse -> ShowS # show :: ConsumerPauseResponse -> String # showList :: [ConsumerPauseResponse] -> ShowS #
Eq ConsumerPauseResponse
Instance details Defined in JetStream.Consumer.Types Methods (==) :: ConsumerPauseResponse -> ConsumerPauseResponse -> Bool # (/=) :: ConsumerPauseResponse -> ConsumerPauseResponse -> Bool #

type ConsumerResetOption = CallOption ConsumerResetRequest #

data ConsumerResetResponse #

Instances

Instances details

FromJSON ConsumerResetResponse
Instance details Defined in JetStream.Consumer.Types Methods parseJSON :: Value -> Parser ConsumerResetResponse # parseJSONList :: Value -> Parser [ConsumerResetResponse] # omittedField :: Maybe ConsumerResetResponse #
Show ConsumerResetResponse
Instance details Defined in JetStream.Consumer.Types Methods showsPrec :: Int -> ConsumerResetResponse -> ShowS # show :: ConsumerResetResponse -> String # showList :: [ConsumerResetResponse] -> ShowS #
Eq ConsumerResetResponse
Instance details Defined in JetStream.Consumer.Types Methods (==) :: ConsumerResetResponse -> ConsumerResetResponse -> Bool # (/=) :: ConsumerResetResponse -> ConsumerResetResponse -> Bool #

data ConsumerSequenceInfo #

Instances

Instances details

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

data ConsumerTarget #

Constructors

EphemeralConsumer
NamedConsumer ConsumerName
DurableConsumer ConsumerName

Instances

Instances details

Show ConsumerTarget
Instance details Defined in JetStream.Consumer.Types Methods showsPrec :: Int -> ConsumerTarget -> ShowS # show :: ConsumerTarget -> String # showList :: [ConsumerTarget] -> ShowS #
Eq ConsumerTarget
Instance details Defined in JetStream.Consumer.Types Methods (==) :: ConsumerTarget -> ConsumerTarget -> Bool # (/=) :: ConsumerTarget -> ConsumerTarget -> Bool #

data DeleteConsumerResponse #

Instances

Instances details

FromJSON DeleteConsumerResponse
Instance details Defined in JetStream.Consumer.Types Methods parseJSON :: Value -> Parser DeleteConsumerResponse # parseJSONList :: Value -> Parser [DeleteConsumerResponse] # omittedField :: Maybe DeleteConsumerResponse #
Show DeleteConsumerResponse
Instance details Defined in JetStream.Consumer.Types Methods showsPrec :: Int -> DeleteConsumerResponse -> ShowS # show :: DeleteConsumerResponse -> String # showList :: [DeleteConsumerResponse] -> ShowS #
Eq DeleteConsumerResponse
Instance details Defined in JetStream.Consumer.Types Methods (==) :: DeleteConsumerResponse -> DeleteConsumerResponse -> Bool # (/=) :: DeleteConsumerResponse -> DeleteConsumerResponse -> Bool #

withConsumerAckPolicy :: AckPolicy -> ConsumerConfigOption #

withConsumerAckWait :: NominalDiffTime -> ConsumerConfigOption #

withConsumerBackoff :: [NominalDiffTime] -> ConsumerConfigOption #

withConsumerDeliverGroup :: Subject -> ConsumerConfigOption #

withConsumerDeliverPolicy :: DeliverPolicy -> ConsumerConfigOption #

withConsumerDescription :: ByteString -> ConsumerConfigOption #

withConsumerFilter :: ConsumerFilter -> ConsumerConfigOption #

withConsumerHeadersOnly :: Bool -> ConsumerConfigOption #

withConsumerIdleHeartbeat :: NominalDiffTime -> ConsumerConfigOption #

withConsumerInactiveThreshold :: NominalDiffTime -> ConsumerConfigOption #

withConsumerListOffset :: Int -> ConsumerListOption #

withConsumerMaxAckPending :: Int -> ConsumerConfigOption #

withConsumerMaxDeliver :: Int -> ConsumerConfigOption #

withConsumerMaxRequestBatch :: Int -> ConsumerConfigOption #

withConsumerMaxWaiting :: Int -> ConsumerConfigOption #

withConsumerMemoryStorage :: Bool -> ConsumerConfigOption #

withConsumerReplayPolicy :: ReplayPolicy -> ConsumerConfigOption #

withConsumerReplicas :: Int -> ConsumerConfigOption #

withConsumerResetSequence :: Word64 -> ConsumerResetOption #

data AckPolicy #

Constructors

AckNone
AckAll
AckExplicit
AckPolicyUnknown Text

Instances

Instances details

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

data DeliverPolicy #

Constructors

DeliverAll
DeliverLast
DeliverNew
DeliverByStartSequence Word64
DeliverByStartTime UTCTime
DeliverLastPerSubject
DeliverPolicyUnknown Text

Instances

Instances details

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

data ReplayPolicy #

Constructors

ReplayInstant
ReplayOriginal
ReplayPolicyUnknown Text

Instances

Instances details

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

getConsumerInfo :: ConsumerAPI -> Consumer -> [JetStreamRequestOption] -> IO (Either JetStreamError ConsumerInfo) #

lookupConsumer :: ConsumerAPI -> StreamName -> ConsumerName -> [JetStreamRequestOption] -> IO (Either JetStreamError Consumer) #

putConsumerHandle :: ConsumerAPI -> StreamName -> ConsumerAction -> ConsumerTarget -> ConsumerKind -> [ConsumerConfigOption] -> [JetStreamRequestOption] -> IO (Either JetStreamError Consumer) #