| Copyright | (c) 2015 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.Subscriptions.Pull
Description
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.
- type ProjectsSubscriptionsPullResource = "v1" :> (CaptureMode "subscription" "pull" Text :> (QueryParam "$.xgafv" Text :> (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))))))))))
- projectsSubscriptionsPull :: PullRequest -> Text -> ProjectsSubscriptionsPull
- data ProjectsSubscriptionsPull
- pspXgafv :: Lens' ProjectsSubscriptionsPull (Maybe Text)
- pspUploadProtocol :: Lens' ProjectsSubscriptionsPull (Maybe Text)
- pspPp :: Lens' ProjectsSubscriptionsPull Bool
- pspAccessToken :: Lens' ProjectsSubscriptionsPull (Maybe Text)
- pspUploadType :: Lens' ProjectsSubscriptionsPull (Maybe Text)
- pspPayload :: Lens' ProjectsSubscriptionsPull PullRequest
- pspBearerToken :: Lens' ProjectsSubscriptionsPull (Maybe Text)
- pspSubscription :: Lens' ProjectsSubscriptionsPull Text
- pspCallback :: Lens' ProjectsSubscriptionsPull (Maybe Text)
REST Resource
type ProjectsSubscriptionsPullResource = "v1" :> (CaptureMode "subscription" "pull" Text :> (QueryParam "$.xgafv" Text :> (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)))))))))) Source
A resource alias for pubsub.projects.subscriptions.pull method which the
ProjectsSubscriptionsPull request conforms to.
Creating a Request
projectsSubscriptionsPull Source
Arguments
| :: PullRequest | |
| -> Text | |
| -> 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:
data ProjectsSubscriptionsPull Source
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
Request Lenses
pspUploadProtocol :: Lens' ProjectsSubscriptionsPull (Maybe Text) Source
Upload protocol for media (e.g. "raw", "multipart").
pspPp :: Lens' ProjectsSubscriptionsPull Bool Source
Pretty-print response.
pspAccessToken :: Lens' ProjectsSubscriptionsPull (Maybe Text) Source
OAuth access token.
pspUploadType :: Lens' ProjectsSubscriptionsPull (Maybe Text) Source
Legacy upload protocol for media (e.g. "media", "multipart").
pspPayload :: Lens' ProjectsSubscriptionsPull PullRequest Source
Multipart request metadata.
pspBearerToken :: Lens' ProjectsSubscriptionsPull (Maybe Text) Source
OAuth bearer token.
pspSubscription :: Lens' ProjectsSubscriptionsPull Text Source
The subscription from which messages should be pulled.
pspCallback :: Lens' ProjectsSubscriptionsPull (Maybe Text) Source
JSONP