Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.PubSub.Projects.Topics.Snapshots.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

Lists the names of the snapshots on this topic. 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. 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.topics.snapshots.list.

Synopsis

type ProjectsTopicsSnapshotsListResource = "v1" :> (Capture "topic" Text :> ("snapshots" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListTopicSnapshotsResponse))))))))))
projectsTopicsSnapshotsList :: Text -> ProjectsTopicsSnapshotsList
data ProjectsTopicsSnapshotsList
ptsltXgafv :: Lens' ProjectsTopicsSnapshotsList (Maybe Xgafv)
ptsltUploadProtocol :: Lens' ProjectsTopicsSnapshotsList (Maybe Text)
ptsltAccessToken :: Lens' ProjectsTopicsSnapshotsList (Maybe Text)
ptsltUploadType :: Lens' ProjectsTopicsSnapshotsList (Maybe Text)
ptsltTopic :: Lens' ProjectsTopicsSnapshotsList Text
ptsltPageToken :: Lens' ProjectsTopicsSnapshotsList (Maybe Text)
ptsltPageSize :: Lens' ProjectsTopicsSnapshotsList (Maybe Int32)
ptsltCallback :: Lens' ProjectsTopicsSnapshotsList (Maybe Text)

REST Resource

type ProjectsTopicsSnapshotsListResource = "v1" :> (Capture "topic" Text :> ("snapshots" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListTopicSnapshotsResponse)))))))))) Source #

A resource alias for pubsub.projects.topics.snapshots.list method which the ProjectsTopicsSnapshotsList request conforms to.

Creating a Request

projectsTopicsSnapshotsList Source #

Arguments

:: Text	`ptsltTopic`
-> ProjectsTopicsSnapshotsList

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

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

data ProjectsTopicsSnapshotsList Source #

Lists the names of the snapshots on this topic. 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. 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: projectsTopicsSnapshotsList smart constructor.

Instances

Eq ProjectsTopicsSnapshotsList Source #
Instance details Defined in Network.Google.Resource.PubSub.Projects.Topics.Snapshots.List Methods (==) :: ProjectsTopicsSnapshotsList -> ProjectsTopicsSnapshotsList -> Bool # (/=) :: ProjectsTopicsSnapshotsList -> ProjectsTopicsSnapshotsList -> Bool #
Data ProjectsTopicsSnapshotsList Source #
Instance details Defined in Network.Google.Resource.PubSub.Projects.Topics.Snapshots.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsTopicsSnapshotsList -> c ProjectsTopicsSnapshotsList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsTopicsSnapshotsList # toConstr :: ProjectsTopicsSnapshotsList -> Constr # dataTypeOf :: ProjectsTopicsSnapshotsList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsTopicsSnapshotsList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsTopicsSnapshotsList) # gmapT :: (forall b. Data b => b -> b) -> ProjectsTopicsSnapshotsList -> ProjectsTopicsSnapshotsList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsTopicsSnapshotsList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsTopicsSnapshotsList -> r # gmapQ :: (forall d. Data d => d -> u) -> ProjectsTopicsSnapshotsList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsTopicsSnapshotsList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsTopicsSnapshotsList -> m ProjectsTopicsSnapshotsList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsTopicsSnapshotsList -> m ProjectsTopicsSnapshotsList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsTopicsSnapshotsList -> m ProjectsTopicsSnapshotsList #
Show ProjectsTopicsSnapshotsList Source #
Instance details Defined in Network.Google.Resource.PubSub.Projects.Topics.Snapshots.List Methods showsPrec :: Int -> ProjectsTopicsSnapshotsList -> ShowS # show :: ProjectsTopicsSnapshotsList -> String # showList :: [ProjectsTopicsSnapshotsList] -> ShowS #
Generic ProjectsTopicsSnapshotsList Source #
Instance details Defined in Network.Google.Resource.PubSub.Projects.Topics.Snapshots.List Associated Types type Rep ProjectsTopicsSnapshotsList :: Type -> Type # Methods from :: ProjectsTopicsSnapshotsList -> Rep ProjectsTopicsSnapshotsList x # to :: Rep ProjectsTopicsSnapshotsList x -> ProjectsTopicsSnapshotsList #
GoogleRequest ProjectsTopicsSnapshotsList Source #
Instance details Defined in Network.Google.Resource.PubSub.Projects.Topics.Snapshots.List Associated Types type Rs ProjectsTopicsSnapshotsList :: Type # type Scopes ProjectsTopicsSnapshotsList :: [Symbol] # Methods requestClient :: ProjectsTopicsSnapshotsList -> GClient (Rs ProjectsTopicsSnapshotsList) #
type Rep ProjectsTopicsSnapshotsList Source #
Instance details Defined in Network.Google.Resource.PubSub.Projects.Topics.Snapshots.List type Rep ProjectsTopicsSnapshotsList = D1 (MetaData "ProjectsTopicsSnapshotsList" "Network.Google.Resource.PubSub.Projects.Topics.Snapshots.List" "gogol-pubsub-0.4.0-4HrlFZL2Veq5x2Cv2TajBN" False) (C1 (MetaCons "ProjectsTopicsSnapshotsList'" PrefixI True) (((S1 (MetaSel (Just "_ptsltXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_ptsltUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_ptsltAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ptsltUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_ptsltTopic") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_ptsltPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_ptsltPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_ptsltCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsTopicsSnapshotsList Source #
Instance details Defined in Network.Google.Resource.PubSub.Projects.Topics.Snapshots.List type Scopes ProjectsTopicsSnapshotsList = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/pubsub" ': ([] :: [Symbol]))
type Rs ProjectsTopicsSnapshotsList Source #
Instance details Defined in Network.Google.Resource.PubSub.Projects.Topics.Snapshots.List type Rs ProjectsTopicsSnapshotsList = ListTopicSnapshotsResponse

Request Lenses

ptsltXgafv :: Lens' ProjectsTopicsSnapshotsList (Maybe Xgafv) Source #

V1 error format.

ptsltUploadProtocol :: Lens' ProjectsTopicsSnapshotsList (Maybe Text) Source #

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

ptsltAccessToken :: Lens' ProjectsTopicsSnapshotsList (Maybe Text) Source #

OAuth access token.

ptsltUploadType :: Lens' ProjectsTopicsSnapshotsList (Maybe Text) Source #

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

ptsltTopic :: Lens' ProjectsTopicsSnapshotsList Text Source #

The name of the topic that snapshots are attached to. Format is `projects/{project}/topics/{topic}`.

ptsltPageToken :: Lens' ProjectsTopicsSnapshotsList (Maybe Text) Source #

The value returned by the last `ListTopicSnapshotsResponse`; indicates that this is a continuation of a prior `ListTopicSnapshots` call, and that the system should return the next page of data.

ptsltPageSize :: Lens' ProjectsTopicsSnapshotsList (Maybe Int32) Source #

Maximum number of snapshot names to return.

ptsltCallback :: Lens' ProjectsTopicsSnapshotsList (Maybe Text) Source #

JSONP