Network.Google.Resource.PubSub.Projects.Subscriptions.Pull

Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.

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

REST Resource

type ProjectsSubscriptionsPullResource = "v1" :> (CaptureMode "subscription" "pull" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] PullRequest :> Post '[JSON] PullResponse))))))))))

A resource alias for pubsub.projects.subscriptions.pull method which the ProjectsSubscriptionsPull request conforms to.

Creating a Request

projectsSubscriptionsPull

Arguments

:: PullRequest

pspPayload

-> Text

pspSubscription

-> ProjectsSubscriptionsPull

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

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

• pspXgafv
• pspUploadProtocol
• pspPp
• pspAccessToken
• pspUploadType
• pspPayload
• pspBearerToken
• pspSubscription
• pspCallback

data ProjectsSubscriptionsPull

Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.

See: projectsSubscriptionsPull smart constructor.

Instances

Eq ProjectsSubscriptionsPull

Methods

(==) :: ProjectsSubscriptionsPull -> ProjectsSubscriptionsPull -> Bool

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

Data ProjectsSubscriptionsPull

Methods

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

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

toConstr :: ProjectsSubscriptionsPull -> Constr

dataTypeOf :: ProjectsSubscriptionsPull -> DataType

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

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

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

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

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

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

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

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

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

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

Show ProjectsSubscriptionsPull

Methods

showsPrec :: Int -> ProjectsSubscriptionsPull -> ShowS

show :: ProjectsSubscriptionsPull -> String

showList :: [ProjectsSubscriptionsPull] -> ShowS

Generic ProjectsSubscriptionsPull

Associated Types

type Rep ProjectsSubscriptionsPull :: * -> *

Methods

from :: ProjectsSubscriptionsPull -> Rep ProjectsSubscriptionsPull x

to :: Rep ProjectsSubscriptionsPull x -> ProjectsSubscriptionsPull

GoogleRequest ProjectsSubscriptionsPull

Associated Types

type Rs ProjectsSubscriptionsPull :: *

type Scopes ProjectsSubscriptionsPull :: [Symbol]

Methods

requestClient :: ProjectsSubscriptionsPull -> Client (Rs ProjectsSubscriptionsPull)

type Rep ProjectsSubscriptionsPull

type Rep ProjectsSubscriptionsPull = D1 (MetaData "ProjectsSubscriptionsPull" "Network.Google.Resource.PubSub.Projects.Subscriptions.Pull" "gogol-pubsub-0.3.0-1dJ3Y6KufaPCaIO7uyOMh" False) (C1 (MetaCons "ProjectsSubscriptionsPull'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pspXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv))) (S1 (MetaSel (Just Symbol "_pspUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_pspPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_pspAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pspUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_pspPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PullRequest))) ((:*:) (S1 (MetaSel (Just Symbol "_pspBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_pspSubscription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_pspCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

type Scopes ProjectsSubscriptionsPull

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

type Rs ProjectsSubscriptionsPull

type Rs ProjectsSubscriptionsPull = PullResponse

Request Lenses

pspXgafv :: Lens' ProjectsSubscriptionsPull (Maybe Xgafv)

V1 error format.

pspUploadProtocol :: Lens' ProjectsSubscriptionsPull (Maybe Text)

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

pspPp :: Lens' ProjectsSubscriptionsPull Bool

Pretty-print response.

pspAccessToken :: Lens' ProjectsSubscriptionsPull (Maybe Text)

OAuth access token.

pspUploadType :: Lens' ProjectsSubscriptionsPull (Maybe Text)

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

pspPayload :: Lens' ProjectsSubscriptionsPull PullRequest

Multipart request metadata.

pspBearerToken :: Lens' ProjectsSubscriptionsPull (Maybe Text)

OAuth bearer token.

pspSubscription :: Lens' ProjectsSubscriptionsPull Text

The subscription from which messages should be pulled. Format is `projects/{project}/subscriptions/{sub}`.

pspCallback :: Lens' ProjectsSubscriptionsPull (Maybe Text)

JSONP