| Copyright | (c) Moritz Clasmeier 2017 2018 |
|---|---|
| License | BSD3 |
| Maintainer | mtesseract@silverratio.net |
| Stability | experimental |
| Portability | POSIX |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Nakadi.Subscriptions
Description
This module implements the /subscriptions API.
Synopsis
- module Network.Nakadi.Subscriptions.Cursors
- module Network.Nakadi.Subscriptions.Events
- module Network.Nakadi.Subscriptions.Stats
- module Network.Nakadi.Subscriptions.Subscription
- subscriptionCreate' :: MonadNakadi b m => SubscriptionRequest -> m Subscription
- subscriptionCreate :: (MonadNakadi b m, MonadCatch m) => SubscriptionRequest -> m Subscription
- subscriptionsList' :: MonadNakadi b m => Maybe ApplicationName -> Maybe [EventTypeName] -> Maybe Limit -> Maybe Offset -> m SubscriptionsListResponse
- subscriptionsSource :: MonadNakadi b m => Maybe ApplicationName -> Maybe [EventTypeName] -> m (ConduitM () [Subscription] m ())
- subscriptionsList :: MonadNakadi b m => Maybe ApplicationName -> Maybe [EventTypeName] -> m [Subscription]
- withSubscription :: (MonadNakadi b m, MonadMask m) => ApplicationName -> ConsumerGroup -> Set EventTypeName -> SubscriptionPosition -> (Subscription -> m r) -> m r
- withTemporarySubscription :: (MonadNakadi b m, MonadMask m) => ApplicationName -> ConsumerGroup -> Set EventTypeName -> SubscriptionPosition -> (Subscription -> m r) -> m r
Documentation
subscriptionCreate' :: MonadNakadi b m => SubscriptionRequest -> m Subscription Source #
POST to /subscriptions. Creates a new subscription. Low
level interface.
subscriptionCreate :: (MonadNakadi b m, MonadCatch m) => SubscriptionRequest -> m Subscription Source #
POST to /subscriptions. Creates a new subscription. Does not
fail if the requested subscription does already exist.
subscriptionsList' :: MonadNakadi b m => Maybe ApplicationName -> Maybe [EventTypeName] -> Maybe Limit -> Maybe Offset -> m SubscriptionsListResponse Source #
GET to /subscriptions. Retrieves all subscriptions matching
the provided filter criteria. Low-level interface using pagination.
subscriptionsSource :: MonadNakadi b m => Maybe ApplicationName -> Maybe [EventTypeName] -> m (ConduitM () [Subscription] m ()) Source #
GET to /subscriptions. Retrieves all subscriptions matching
the provided filter criteria. High-level Conduit interface.
subscriptionsList :: MonadNakadi b m => Maybe ApplicationName -> Maybe [EventTypeName] -> m [Subscription] Source #
GET to /subscriptions. Retrieves all subscriptions matching
the provided filter criteria. High-level list interface.
withSubscription :: (MonadNakadi b m, MonadMask m) => ApplicationName -> ConsumerGroup -> Set EventTypeName -> SubscriptionPosition -> (Subscription -> m r) -> m r Source #
Experimental API.
Creates a new subscription using the specified parameters via subscriptionCreate
and pass it to the provided action.
withTemporarySubscription :: (MonadNakadi b m, MonadMask m) => ApplicationName -> ConsumerGroup -> Set EventTypeName -> SubscriptionPosition -> (Subscription -> m r) -> m r Source #
Experimental API.
Creates a new temporary subscription using the specified parameters via subscriptionCreate
and pass it to the provided action. Note that bracket is used to enforce the deletion of
the subscription via subscriptionDelete when the provided action returns.
Do NOT use this function if the specified subscription should not be deleted.