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.Delete

Contents

Description

Removes an existing snapshot. 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. When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified.

See: Cloud Pub/Sub API Reference for pubsub.projects.snapshots.delete.

Synopsis

REST Resource

type ProjectsSnapshotsDeleteResource = "v1" :> (Capture "snapshot" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Delete '[JSON] Empty))))))) Source #

A resource alias for pubsub.projects.snapshots.delete method which the ProjectsSnapshotsDelete request conforms to.

Creating a Request

projectsSnapshotsDelete Source #

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

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

data ProjectsSnapshotsDelete Source #

Removes an existing snapshot. 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. When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified.

See: projectsSnapshotsDelete smart constructor.

Instances
Eq ProjectsSnapshotsDelete Source # 
Instance details

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

Data ProjectsSnapshotsDelete Source # 
Instance details

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

Methods

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

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

toConstr :: ProjectsSnapshotsDelete -> Constr #

dataTypeOf :: ProjectsSnapshotsDelete -> DataType #

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

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

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

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

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

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

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

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

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

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

Show ProjectsSnapshotsDelete Source # 
Instance details

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

Generic ProjectsSnapshotsDelete Source # 
Instance details

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

Associated Types

type Rep ProjectsSnapshotsDelete :: Type -> Type #

GoogleRequest ProjectsSnapshotsDelete Source # 
Instance details

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

type Rep ProjectsSnapshotsDelete Source # 
Instance details

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

type Rep ProjectsSnapshotsDelete = D1 (MetaData "ProjectsSnapshotsDelete" "Network.Google.Resource.PubSub.Projects.Snapshots.Delete" "gogol-pubsub-0.4.0-4HrlFZL2Veq5x2Cv2TajBN" False) (C1 (MetaCons "ProjectsSnapshotsDelete'" PrefixI True) ((S1 (MetaSel (Just "_proXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_proSnapshot") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_proUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_proAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_proUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_proCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsSnapshotsDelete Source # 
Instance details

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

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

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

Request Lenses

proSnapshot :: Lens' ProjectsSnapshotsDelete Text Source #

The name of the snapshot to delete. Format is `projects/{project}/snapshots/{snap}`.

proUploadProtocol :: Lens' ProjectsSnapshotsDelete (Maybe Text) Source #

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

proUploadType :: Lens' ProjectsSnapshotsDelete (Maybe Text) Source #

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