Safe Haskell	None
Language	GHC2021

Network.RabbitMqAdmin

Description

Perhaps this module should be a separate package and published to hackage.

Synopsis

type RabbitMqBasicAuth = BasicAuth "RabbitMq Management" BasicAuthData
type VHost = Text
type QueueName = Text
data Page a = Page {
- items :: [a]
- page :: Int
- pageCount :: Int
}
data AdminAPI (route :: k) = AdminAPI {
- listQueuesByVHost :: route :- ("api" :> ("queues" :> (Capture "vhost" VHost :> (QueryParam' '[Required, Strict] "name" Text :> (QueryParam' '[Required, Strict] "use_regex" Bool :> (QueryParam' '[Required, Strict] "page_size" Int :> (QueryParam' '[Required, Strict] "page" Int :> Get '[JSON] (Page Queue))))))))
- deleteQueue :: route :- ("api" :> ("queues" :> (Capture "vhost" VHost :> (Capture "queue" QueueName :> DeleteNoContent))))
- listConnectionsByVHost :: route :- ("api" :> ("vhosts" :> (Capture "vhost" Text :> ("connections" :> Get '[JSON] [Connection]))))
- deleteConnection :: route :- ("api" :> ("connections" :> (Capture "name" Text :> DeleteNoContent)))
}
data AuthenticatedAPI (route :: k) = AuthenticatedAPI {
- api :: route :- (RabbitMqBasicAuth :> ToServant (AdminAPI :: Type -> Type) AsApi)
}
jsonOptions :: Options
data Queue = Queue {
- name :: Text
- vhost :: Text
}
data Connection = Connection {
- userProvidedName :: Maybe Text
- name :: Text
}
adminClient :: BasicAuthData -> AdminAPI (AsClientT ClientM)

Documentation

type RabbitMqBasicAuth = BasicAuth "RabbitMq Management" BasicAuthData Source #

type VHost = Text Source #

type QueueName = Text Source #

data Page a Source #

Constructors

Page
Fields items :: [a] page :: Int pageCount :: Int

Instances

Instances details

FromJSON a => FromJSON (Page a) Source #

Instance details

Defined in Network.RabbitMqAdmin

Methods

parseJSON :: Value -> Parser (Page a) Source #

parseJSONList :: Value -> Parser [Page a] Source #

omittedField :: Maybe (Page a) Source #

ToJSON a => ToJSON (Page a) Source #

Instance details

Defined in Network.RabbitMqAdmin

Methods

toJSON :: Page a -> Value Source #

toEncoding :: Page a -> Encoding Source #

toJSONList :: [Page a] -> Value Source #

toEncodingList :: [Page a] -> Encoding Source #

omitField :: Page a -> Bool Source #

Generic (Page a) Source #

Instance details

Defined in Network.RabbitMqAdmin

Associated Types

type Rep (Page a)

Instance details

Defined in Network.RabbitMqAdmin

type Rep (Page a) = D1 ('MetaData "Page" "Network.RabbitMqAdmin" "extended-0.1.0-14c0x4V4AuLDvHggsqKUd8" 'False) (C1 ('MetaCons "Page" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a]) :*: (S1 ('MetaSel ('Just "page") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "pageCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))))

Methods

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

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

Show a => Show (Page a) Source #

Instance details

Defined in Network.RabbitMqAdmin

Methods

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

show :: Page a -> String #

showList :: [Page a] -> ShowS #

Eq a => Eq (Page a) Source #

Instance details

Defined in Network.RabbitMqAdmin

Methods

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

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

type Rep (Page a) Source #

Instance details

Defined in Network.RabbitMqAdmin

type Rep (Page a) = D1 ('MetaData "Page" "Network.RabbitMqAdmin" "extended-0.1.0-14c0x4V4AuLDvHggsqKUd8" 'False) (C1 ('MetaCons "Page" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a]) :*: (S1 ('MetaSel ('Just "page") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "pageCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))))

data AdminAPI (route :: k) Source #

Upstream Docs: https://rawcdn.githack.com/rabbitmq/rabbitmq-server/v3.12.0/deps/rabbitmq_management/priv/www/api/index.html

Constructors

AdminAPI

Fields

listQueuesByVHost :: route :- ("api" :> ("queues" :> (Capture "vhost" VHost :> (QueryParam' '[Required, Strict] "name" Text :> (QueryParam' '[Required, Strict] "use_regex" Bool :> (QueryParam' '[Required, Strict] "page_size" Int :> (QueryParam' '[Required, Strict] "page" Int :> Get '[JSON] (Page Queue))))))))
deleteQueue :: route :- ("api" :> ("queues" :> (Capture "vhost" VHost :> (Capture "queue" QueueName :> DeleteNoContent))))
listConnectionsByVHost :: route :- ("api" :> ("vhosts" :> (Capture "vhost" Text :> ("connections" :> Get '[JSON] [Connection]))))
deleteConnection :: route :- ("api" :> ("connections" :> (Capture "name" Text :> DeleteNoContent)))

Instances

Instances details

Generic (AdminAPI route) Source #

Instance details

Defined in Network.RabbitMqAdmin

Associated Types

type Rep (AdminAPI route)

Instance details

Defined in Network.RabbitMqAdmin

type Rep (AdminAPI route) = D1 ('MetaData "AdminAPI" "Network.RabbitMqAdmin" "extended-0.1.0-14c0x4V4AuLDvHggsqKUd8" 'False) (C1 ('MetaCons "AdminAPI" 'PrefixI 'True) ((S1 ('MetaSel ('Just "listQueuesByVHost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- ("api" :> ("queues" :> (Capture "vhost" VHost :> (QueryParam' '[Required, Strict] "name" Text :> (QueryParam' '[Required, Strict] "use_regex" Bool :> (QueryParam' '[Required, Strict] "page_size" Int :> (QueryParam' '[Required, Strict] "page" Int :> Get '[JSON] (Page Queue)))))))))) :*: S1 ('MetaSel ('Just "deleteQueue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- ("api" :> ("queues" :> (Capture "vhost" VHost :> (Capture "queue" QueueName :> DeleteNoContent))))))) :*: (S1 ('MetaSel ('Just "listConnectionsByVHost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- ("api" :> ("vhosts" :> (Capture "vhost" Text :> ("connections" :> Get '[JSON] [Connection])))))) :*: S1 ('MetaSel ('Just "deleteConnection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- ("api" :> ("connections" :> (Capture "name" Text :> DeleteNoContent))))))))

Methods

from :: AdminAPI route -> Rep (AdminAPI route) x #

to :: Rep (AdminAPI route) x -> AdminAPI route #

type Rep (AdminAPI route) Source #

Instance details

Defined in Network.RabbitMqAdmin

type Rep (AdminAPI route) = D1 ('MetaData "AdminAPI" "Network.RabbitMqAdmin" "extended-0.1.0-14c0x4V4AuLDvHggsqKUd8" 'False) (C1 ('MetaCons "AdminAPI" 'PrefixI 'True) ((S1 ('MetaSel ('Just "listQueuesByVHost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- ("api" :> ("queues" :> (Capture "vhost" VHost :> (QueryParam' '[Required, Strict] "name" Text :> (QueryParam' '[Required, Strict] "use_regex" Bool :> (QueryParam' '[Required, Strict] "page_size" Int :> (QueryParam' '[Required, Strict] "page" Int :> Get '[JSON] (Page Queue)))))))))) :*: S1 ('MetaSel ('Just "deleteQueue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- ("api" :> ("queues" :> (Capture "vhost" VHost :> (Capture "queue" QueueName :> DeleteNoContent))))))) :*: (S1 ('MetaSel ('Just "listConnectionsByVHost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- ("api" :> ("vhosts" :> (Capture "vhost" Text :> ("connections" :> Get '[JSON] [Connection])))))) :*: S1 ('MetaSel ('Just "deleteConnection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- ("api" :> ("connections" :> (Capture "name" Text :> DeleteNoContent))))))))

data AuthenticatedAPI (route :: k) Source #

Constructors

AuthenticatedAPI
Fields api :: route :- (RabbitMqBasicAuth :> ToServant (AdminAPI :: Type -> Type) AsApi)

Instances

Instances details

Generic (AuthenticatedAPI route) Source #

Instance details

Defined in Network.RabbitMqAdmin

Associated Types

type Rep (AuthenticatedAPI route)

Instance details

Defined in Network.RabbitMqAdmin

type Rep (AuthenticatedAPI route) = D1 ('MetaData "AuthenticatedAPI" "Network.RabbitMqAdmin" "extended-0.1.0-14c0x4V4AuLDvHggsqKUd8" 'False) (C1 ('MetaCons "AuthenticatedAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "api") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- (RabbitMqBasicAuth :> ToServant (AdminAPI :: Type -> Type) AsApi)))))

Methods

from :: AuthenticatedAPI route -> Rep (AuthenticatedAPI route) x #

to :: Rep (AuthenticatedAPI route) x -> AuthenticatedAPI route #

type Rep (AuthenticatedAPI route) Source #

Instance details

Defined in Network.RabbitMqAdmin

type Rep (AuthenticatedAPI route) = D1 ('MetaData "AuthenticatedAPI" "Network.RabbitMqAdmin" "extended-0.1.0-14c0x4V4AuLDvHggsqKUd8" 'False) (C1 ('MetaCons "AuthenticatedAPI" 'PrefixI 'True) (S1 ('MetaSel ('Just "api") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (route :- (RabbitMqBasicAuth :> ToServant (AdminAPI :: Type -> Type) AsApi)))))

jsonOptions :: Options Source #

data Queue Source #

Constructors

Queue
Fields name :: Text vhost :: Text

Instances

Instances details

FromJSON Queue Source #

Instance details

Defined in Network.RabbitMqAdmin

Methods

parseJSON :: Value -> Parser Queue Source #

parseJSONList :: Value -> Parser [Queue] Source #

omittedField :: Maybe Queue Source #

ToJSON Queue Source #

Instance details

Defined in Network.RabbitMqAdmin

Methods

toJSON :: Queue -> Value Source #

toEncoding :: Queue -> Encoding Source #

toJSONList :: [Queue] -> Value Source #

toEncodingList :: [Queue] -> Encoding Source #

omitField :: Queue -> Bool Source #

Generic Queue Source #

Instance details

Defined in Network.RabbitMqAdmin

Associated Types

type Rep Queue

Instance details

Defined in Network.RabbitMqAdmin

type Rep Queue = D1 ('MetaData "Queue" "Network.RabbitMqAdmin" "extended-0.1.0-14c0x4V4AuLDvHggsqKUd8" 'False) (C1 ('MetaCons "Queue" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "vhost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: Queue -> Rep Queue x #

to :: Rep Queue x -> Queue #

Show Queue Source #

Instance details

Defined in Network.RabbitMqAdmin

Methods

showsPrec :: Int -> Queue -> ShowS #

show :: Queue -> String #

showList :: [Queue] -> ShowS #

Eq Queue Source #

Instance details

Defined in Network.RabbitMqAdmin

Methods

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

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

type Rep Queue Source #

Instance details

Defined in Network.RabbitMqAdmin

type Rep Queue = D1 ('MetaData "Queue" "Network.RabbitMqAdmin" "extended-0.1.0-14c0x4V4AuLDvHggsqKUd8" 'False) (C1 ('MetaCons "Queue" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "vhost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Connection Source #

Constructors

Connection
Fields userProvidedName :: Maybe Text name :: Text

Instances

Instances details

FromJSON Connection Source #

Instance details

Defined in Network.RabbitMqAdmin

Methods

parseJSON :: Value -> Parser Connection Source #

parseJSONList :: Value -> Parser [Connection] Source #

omittedField :: Maybe Connection Source #

ToJSON Connection Source #

Instance details

Defined in Network.RabbitMqAdmin

Methods

toJSON :: Connection -> Value Source #

toEncoding :: Connection -> Encoding Source #

toJSONList :: [Connection] -> Value Source #

toEncodingList :: [Connection] -> Encoding Source #

omitField :: Connection -> Bool Source #

Generic Connection Source #

Instance details

Defined in Network.RabbitMqAdmin

Associated Types

type Rep Connection

Instance details

Defined in Network.RabbitMqAdmin

type Rep Connection = D1 ('MetaData "Connection" "Network.RabbitMqAdmin" "extended-0.1.0-14c0x4V4AuLDvHggsqKUd8" 'False) (C1 ('MetaCons "Connection" 'PrefixI 'True) (S1 ('MetaSel ('Just "userProvidedName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: Connection -> Rep Connection x #

to :: Rep Connection x -> Connection #

Show Connection Source #

Instance details

Defined in Network.RabbitMqAdmin

Methods

showsPrec :: Int -> Connection -> ShowS #

show :: Connection -> String #

showList :: [Connection] -> ShowS #

Eq Connection Source #

Instance details

Defined in Network.RabbitMqAdmin

Methods

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

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

type Rep Connection Source #

Instance details

Defined in Network.RabbitMqAdmin

type Rep Connection = D1 ('MetaData "Connection" "Network.RabbitMqAdmin" "extended-0.1.0-14c0x4V4AuLDvHggsqKUd8" 'False) (C1 ('MetaCons "Connection" 'PrefixI 'True) (S1 ('MetaSel ('Just "userProvidedName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

adminClient :: BasicAuthData -> AdminAPI (AsClientT ClientM) Source #