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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Updates 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. Note that certain properties of a snapshot are not modifiable.

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

Synopsis

type ProjectsSnapshotsPatchResource = "v1" :> (Capture "name" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] UpdateSnapshotRequest :> Patch '[JSON] Snapshot))))))))
projectsSnapshotsPatch :: UpdateSnapshotRequest -> Text -> ProjectsSnapshotsPatch
data ProjectsSnapshotsPatch
ppXgafv :: Lens' ProjectsSnapshotsPatch (Maybe Xgafv)
ppUploadProtocol :: Lens' ProjectsSnapshotsPatch (Maybe Text)
ppAccessToken :: Lens' ProjectsSnapshotsPatch (Maybe Text)
ppUploadType :: Lens' ProjectsSnapshotsPatch (Maybe Text)
ppPayload :: Lens' ProjectsSnapshotsPatch UpdateSnapshotRequest
ppName :: Lens' ProjectsSnapshotsPatch Text
ppCallback :: Lens' ProjectsSnapshotsPatch (Maybe Text)

REST Resource

type ProjectsSnapshotsPatchResource = "v1" :> (Capture "name" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] UpdateSnapshotRequest :> Patch '[JSON] Snapshot)))))))) Source #

A resource alias for pubsub.projects.snapshots.patch method which the ProjectsSnapshotsPatch request conforms to.

Creating a Request

projectsSnapshotsPatch Source #

Arguments

:: UpdateSnapshotRequest	`ppPayload`
-> Text	`ppName`
-> ProjectsSnapshotsPatch

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

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

data ProjectsSnapshotsPatch Source #

Updates 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. Note that certain properties of a snapshot are not modifiable.

See: projectsSnapshotsPatch smart constructor.

Instances

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

Request Lenses

ppXgafv :: Lens' ProjectsSnapshotsPatch (Maybe Xgafv) Source #

V1 error format.

ppUploadProtocol :: Lens' ProjectsSnapshotsPatch (Maybe Text) Source #

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

ppAccessToken :: Lens' ProjectsSnapshotsPatch (Maybe Text) Source #

OAuth access token.

ppUploadType :: Lens' ProjectsSnapshotsPatch (Maybe Text) Source #

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

ppPayload :: Lens' ProjectsSnapshotsPatch UpdateSnapshotRequest Source #

Multipart request metadata.

ppName :: Lens' ProjectsSnapshotsPatch Text Source #

The name of the snapshot.

ppCallback :: Lens' ProjectsSnapshotsPatch (Maybe Text) Source #

JSONP