Network.Google.Resource.PubSub.Projects.Subscriptions.Acknowledge

Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.

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

REST Resource

type ProjectsSubscriptionsAcknowledgeResource = "v1" :> (CaptureMode "subscription" "acknowledge" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] AcknowledgeRequest :> Post '[JSON] Empty))))))))

A resource alias for pubsub.projects.subscriptions.acknowledge method which the ProjectsSubscriptionsAcknowledge request conforms to.

Creating a Request

projectsSubscriptionsAcknowledge

Arguments

:: AcknowledgeRequest

psaPayload

-> Text

psaSubscription

-> ProjectsSubscriptionsAcknowledge

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

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

• psaXgafv
• psaUploadProtocol
• psaAccessToken
• psaUploadType
• psaPayload
• psaSubscription
• psaCallback

data ProjectsSubscriptionsAcknowledge

Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.

See: projectsSubscriptionsAcknowledge smart constructor.

Instances

Eq ProjectsSubscriptionsAcknowledge

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

Methods

(==) :: ProjectsSubscriptionsAcknowledge -> ProjectsSubscriptionsAcknowledge -> Bool

(/=) :: ProjectsSubscriptionsAcknowledge -> ProjectsSubscriptionsAcknowledge -> Bool

Data ProjectsSubscriptionsAcknowledge

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

Methods

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

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

toConstr :: ProjectsSubscriptionsAcknowledge -> Constr

dataTypeOf :: ProjectsSubscriptionsAcknowledge -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> ProjectsSubscriptionsAcknowledge -> ProjectsSubscriptionsAcknowledge

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

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

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

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

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

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

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

Show ProjectsSubscriptionsAcknowledge

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

Methods

showsPrec :: Int -> ProjectsSubscriptionsAcknowledge -> ShowS

show :: ProjectsSubscriptionsAcknowledge -> String

showList :: [ProjectsSubscriptionsAcknowledge] -> ShowS

Generic ProjectsSubscriptionsAcknowledge

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

Associated Types

type Rep ProjectsSubscriptionsAcknowledge :: Type -> Type

Methods

from :: ProjectsSubscriptionsAcknowledge -> Rep ProjectsSubscriptionsAcknowledge x

to :: Rep ProjectsSubscriptionsAcknowledge x -> ProjectsSubscriptionsAcknowledge

GoogleRequest ProjectsSubscriptionsAcknowledge

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

Associated Types

type Rs ProjectsSubscriptionsAcknowledge :: Type

type Scopes ProjectsSubscriptionsAcknowledge :: [Symbol]

Methods

requestClient :: ProjectsSubscriptionsAcknowledge -> GClient (Rs ProjectsSubscriptionsAcknowledge)

type Rep ProjectsSubscriptionsAcknowledge

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

type Rep ProjectsSubscriptionsAcknowledge = D1 (MetaData "ProjectsSubscriptionsAcknowledge" "Network.Google.Resource.PubSub.Projects.Subscriptions.Acknowledge" "gogol-pubsub-0.4.0-4HrlFZL2Veq5x2Cv2TajBN" False) (C1 (MetaCons "ProjectsSubscriptionsAcknowledge'" PrefixI True) ((S1 (MetaSel (Just "_psaXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_psaUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_psaAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_psaUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_psaPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AcknowledgeRequest)) :*: (S1 (MetaSel (Just "_psaSubscription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_psaCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Scopes ProjectsSubscriptionsAcknowledge

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

type Scopes ProjectsSubscriptionsAcknowledge = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/pubsub" ': ([] :: [Symbol]))

type Rs ProjectsSubscriptionsAcknowledge

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

type Rs ProjectsSubscriptionsAcknowledge = Empty

Request Lenses

psaXgafv :: Lens' ProjectsSubscriptionsAcknowledge (Maybe Xgafv)

V1 error format.

psaUploadProtocol :: Lens' ProjectsSubscriptionsAcknowledge (Maybe Text)

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

psaAccessToken :: Lens' ProjectsSubscriptionsAcknowledge (Maybe Text)

OAuth access token.

psaUploadType :: Lens' ProjectsSubscriptionsAcknowledge (Maybe Text)

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

psaPayload :: Lens' ProjectsSubscriptionsAcknowledge AcknowledgeRequest

Multipart request metadata.

psaSubscription :: Lens' ProjectsSubscriptionsAcknowledge Text

The subscription whose message is being acknowledged. Format is `projects/{project}/subscriptions/{sub}`.

psaCallback :: Lens' ProjectsSubscriptionsAcknowledge (Maybe Text)

JSONP