Commitcd57e65

authored and

committed

Pub/Sub: surface publish future in documentation (#8229)

* surface publish future in documentation* Update class definition

1 parent4b5b2a1 commitcd57e65Copy full SHA for cd57e65

File tree

+14

-18

lines changed

+14

-18

lines changed

Lines changed: 6 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,6 @@`
	`1`	`+Futures`
	`2`	`+=======`
	`3`	`+`
	`4`	`+..automodule::google.cloud.pubsub_v1.publisher.futures`
	`5`	`+:members:`
	`6`	`+:inherited-members:`

Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ Futures`
`95`	`95`	`-------`
`96`	`96`
`97`	`97`	Every call to:meth:`~.pubsub_v1.publisher.client.Client.publish` returns
`98`		-an instance of:class:`google.api_core.future.Future`.
	`98`	+an instance of:class:`~.pubsub_v1.publisher.futures.Future`.
`99`	`99`
`100`	`100`	`..note::`
`101`	`101`
`@@ -135,3 +135,4 @@ API Reference`
`135`	`135`	`:maxdepth:2`
`136`	`136`
`137`	`137`	`api/client`
	`138`	`+api/futures`

Lines changed: 6 additions & 17 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Copyright2017, Google LLC All rights reserved.`
	`1`	`+# Copyright2019, Google LLC All rights reserved.`
`2`	`2`	`#`
`3`	`3`	`# Licensed under the Apache License, Version 2.0 (the "License");`
`4`	`4`	`# you may not use this file except in compliance with the License.`
`@@ -18,22 +18,11 @@`
`18`	`18`
`19`	`19`
`20`	`20`	`classFuture(futures.Future):`
`21`		`-"""Encapsulation of the asynchronous execution of an action.`
`22`		`-`
`23`		`- This object is returned from asychronous Pub/Sub publishing calls, and is`
`24`		`- the interface to determine the status of those calls.`
`25`		`-`
`26`		`- This object should not be created directly, but is returned by other`
`27`		`- methods in this library.`
`28`		`-`
`29`		`- Args:`
`30`		`- completed (Optional[Any]): An event, with the same interface as`
`31`		- :class:`threading.Event`. This is provided so that callers
`32`		- with different concurrency models (e.g. ``threading`` or
`33`		- ``multiprocessing``) can supply an event that is compatible
`34`		- with that model. The ``wait()`` and ``set()`` methods will be
`35`		`- used. If this argument is not provided, then a new`
`36`		- :class:`threading.Event` will be created and used.
	`21`	`+"""This future object is returned from asychronous Pub/Sub publishing`
	`22`	`+ calls.`
	`23`	`+`
	`24`	+ Calling :meth:`result` will resolve the future by returning the message
	`25`	`+ ID, unless an error occurs.`
`37`	`26`	`"""`
`38`	`27`
`39`	`28`	`defresult(self,timeout=None):`

Comments

(0)