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

Pulls messages from the server. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.

See: 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 "access_token" Text :> (QueryParam "uploadType" 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

pspsPayload

-> Text

pspsSubscription

-> 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:

• pspsXgafv
• pspsUploadProtocol
• pspsAccessToken
• pspsUploadType
• pspsPayload
• pspsSubscription
• pspsCallback

data ProjectsSubscriptionsPull

Pulls messages from the server. 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

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

Methods

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

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

Data ProjectsSubscriptionsPull

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

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

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

Methods

showsPrec :: Int -> ProjectsSubscriptionsPull -> ShowS

show :: ProjectsSubscriptionsPull -> String

showList :: [ProjectsSubscriptionsPull] -> ShowS

Generic ProjectsSubscriptionsPull

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

Associated Types

type Rep ProjectsSubscriptionsPull :: Type -> Type

Methods

from :: ProjectsSubscriptionsPull -> Rep ProjectsSubscriptionsPull x

to :: Rep ProjectsSubscriptionsPull x -> ProjectsSubscriptionsPull

GoogleRequest ProjectsSubscriptionsPull

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

Associated Types

type Rs ProjectsSubscriptionsPull :: Type

type Scopes ProjectsSubscriptionsPull :: [Symbol]

Methods

requestClient :: ProjectsSubscriptionsPull -> GClient (Rs ProjectsSubscriptionsPull)

type Rep ProjectsSubscriptionsPull

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

type Rep ProjectsSubscriptionsPull = D1 (MetaData "ProjectsSubscriptionsPull" "Network.Google.Resource.PubSub.Projects.Subscriptions.Pull" "gogol-pubsub-0.4.0-4HrlFZL2Veq5x2Cv2TajBN" False) (C1 (MetaCons "ProjectsSubscriptionsPull'" PrefixI True) ((S1 (MetaSel (Just "_pspsXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_pspsUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pspsAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_pspsUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pspsPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PullRequest)) :*: (S1 (MetaSel (Just "_pspsSubscription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_pspsCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Scopes ProjectsSubscriptionsPull

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

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

type Rs ProjectsSubscriptionsPull

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

type Rs ProjectsSubscriptionsPull = PullResponse

Request Lenses

pspsXgafv :: Lens' ProjectsSubscriptionsPull (Maybe Xgafv)

V1 error format.

pspsUploadProtocol :: Lens' ProjectsSubscriptionsPull (Maybe Text)

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

pspsAccessToken :: Lens' ProjectsSubscriptionsPull (Maybe Text)

OAuth access token.

pspsUploadType :: Lens' ProjectsSubscriptionsPull (Maybe Text)

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

pspsPayload :: Lens' ProjectsSubscriptionsPull PullRequest

Multipart request metadata.

pspsSubscription :: Lens' ProjectsSubscriptionsPull Text

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

pspsCallback :: Lens' ProjectsSubscriptionsPull (Maybe Text)

JSONP