gogol-pubsub-0.4.0: Google Cloud Pub/Sub SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.PubSub.Projects.Subscriptions.Seek

Contents

Description

Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. Note that both the subscription and the snapshot must be on the same topic. BETA: This feature is part of a beta release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

See: Cloud Pub/Sub API Reference for pubsub.projects.subscriptions.seek.

Synopsis

REST Resource

type ProjectsSubscriptionsSeekResource = "v1" :> (CaptureMode "subscription" "seek" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] SeekRequest :> Post '[JSON] SeekResponse)))))))) Source #

A resource alias for pubsub.projects.subscriptions.seek method which the ProjectsSubscriptionsSeek request conforms to.

Creating a Request

projectsSubscriptionsSeek Source #

Creates a value of ProjectsSubscriptionsSeek with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data ProjectsSubscriptionsSeek Source #

Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. Note that both the subscription and the snapshot must be on the same topic. BETA: This feature is part of a beta release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

See: projectsSubscriptionsSeek smart constructor.

Instances
Eq ProjectsSubscriptionsSeek Source # 
Instance details

Defined in Network.Google.Resource.PubSub.Projects.Subscriptions.Seek

Data ProjectsSubscriptionsSeek Source # 
Instance details

Defined in Network.Google.Resource.PubSub.Projects.Subscriptions.Seek

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsSubscriptionsSeek -> c ProjectsSubscriptionsSeek #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsSubscriptionsSeek #

toConstr :: ProjectsSubscriptionsSeek -> Constr #

dataTypeOf :: ProjectsSubscriptionsSeek -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsSubscriptionsSeek) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsSubscriptionsSeek) #

gmapT :: (forall b. Data b => b -> b) -> ProjectsSubscriptionsSeek -> ProjectsSubscriptionsSeek #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsSubscriptionsSeek -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsSubscriptionsSeek -> r #

gmapQ :: (forall d. Data d => d -> u) -> ProjectsSubscriptionsSeek -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsSubscriptionsSeek -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsSubscriptionsSeek -> m ProjectsSubscriptionsSeek #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsSubscriptionsSeek -> m ProjectsSubscriptionsSeek #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsSubscriptionsSeek -> m ProjectsSubscriptionsSeek #

Show ProjectsSubscriptionsSeek Source # 
Instance details

Defined in Network.Google.Resource.PubSub.Projects.Subscriptions.Seek

Generic ProjectsSubscriptionsSeek Source # 
Instance details

Defined in Network.Google.Resource.PubSub.Projects.Subscriptions.Seek

Associated Types

type Rep ProjectsSubscriptionsSeek :: Type -> Type #

GoogleRequest ProjectsSubscriptionsSeek Source # 
Instance details

Defined in Network.Google.Resource.PubSub.Projects.Subscriptions.Seek

type Rep ProjectsSubscriptionsSeek Source # 
Instance details

Defined in Network.Google.Resource.PubSub.Projects.Subscriptions.Seek

type Rep ProjectsSubscriptionsSeek = D1 (MetaData "ProjectsSubscriptionsSeek" "Network.Google.Resource.PubSub.Projects.Subscriptions.Seek" "gogol-pubsub-0.4.0-4HrlFZL2Veq5x2Cv2TajBN" False) (C1 (MetaCons "ProjectsSubscriptionsSeek'" PrefixI True) ((S1 (MetaSel (Just "_pssXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_pssUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pssAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_pssUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pssPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SeekRequest)) :*: (S1 (MetaSel (Just "_pssSubscription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_pssCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsSubscriptionsSeek Source # 
Instance details

Defined in Network.Google.Resource.PubSub.Projects.Subscriptions.Seek

type Scopes ProjectsSubscriptionsSeek = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/pubsub" ': ([] :: [Symbol]))
type Rs ProjectsSubscriptionsSeek Source # 
Instance details

Defined in Network.Google.Resource.PubSub.Projects.Subscriptions.Seek

Request Lenses

pssUploadProtocol :: Lens' ProjectsSubscriptionsSeek (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

pssUploadType :: Lens' ProjectsSubscriptionsSeek (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").