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.Snapshots.List

Contents

Description

Lists the existing snapshots. 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.snapshots.list.

Synopsis

REST Resource

type ProjectsSnapshotsListResource = "v1" :> (Capture "project" 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] ListSnapshotsResponse)))))))))) Source #

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

Creating a Request

projectsSnapshotsList Source #

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

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

data ProjectsSnapshotsList Source #

Lists the existing snapshots. 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: projectsSnapshotsList smart constructor.

Instances
Eq ProjectsSnapshotsList Source # 
Instance details

Defined in Network.Google.Resource.PubSub.Projects.Snapshots.List

Data ProjectsSnapshotsList Source # 
Instance details

Defined in Network.Google.Resource.PubSub.Projects.Snapshots.List

Methods

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

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

toConstr :: ProjectsSnapshotsList -> Constr #

dataTypeOf :: ProjectsSnapshotsList -> DataType #

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

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

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

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

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

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

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

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

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

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

Show ProjectsSnapshotsList Source # 
Instance details

Defined in Network.Google.Resource.PubSub.Projects.Snapshots.List

Generic ProjectsSnapshotsList Source # 
Instance details

Defined in Network.Google.Resource.PubSub.Projects.Snapshots.List

Associated Types

type Rep ProjectsSnapshotsList :: Type -> Type #

GoogleRequest ProjectsSnapshotsList Source # 
Instance details

Defined in Network.Google.Resource.PubSub.Projects.Snapshots.List

type Rep ProjectsSnapshotsList Source # 
Instance details

Defined in Network.Google.Resource.PubSub.Projects.Snapshots.List

type Rep ProjectsSnapshotsList = D1 (MetaData "ProjectsSnapshotsList" "Network.Google.Resource.PubSub.Projects.Snapshots.List" "gogol-pubsub-0.4.0-4HrlFZL2Veq5x2Cv2TajBN" False) (C1 (MetaCons "ProjectsSnapshotsList'" PrefixI True) (((S1 (MetaSel (Just "_pslsXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 (MetaSel (Just "_pslsUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_pslsProject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_pslsAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_pslsUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pslsPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_pslsPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_pslsCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsSnapshotsList Source # 
Instance details

Defined in Network.Google.Resource.PubSub.Projects.Snapshots.List

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

Defined in Network.Google.Resource.PubSub.Projects.Snapshots.List

Request Lenses

pslsUploadProtocol :: Lens' ProjectsSnapshotsList (Maybe Text) Source #

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

pslsProject :: Lens' ProjectsSnapshotsList Text Source #

The name of the project in which to list snapshots. Format is `projects/{project-id}`.

pslsUploadType :: Lens' ProjectsSnapshotsList (Maybe Text) Source #

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

pslsPageToken :: Lens' ProjectsSnapshotsList (Maybe Text) Source #

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

pslsPageSize :: Lens' ProjectsSnapshotsList (Maybe Int32) Source #

Maximum number of snapshots to return.