Skip to content

Commit 5f4d94a

Browse files
committed
impl(v3): decommission PublisherOptions and SubscriberOptions
1 parent c201e56 commit 5f4d94a

1 file changed

Lines changed: 111 additions & 0 deletions

File tree

doc/v3-migration-guide.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -292,6 +292,117 @@ internal legacy files.
292292

293293
### Pubsub
294294

295+
<details>
296+
<summary>Removed <code>pubsub::PublisherOptions</code>
297+
</summary>
298+
#### `pubsub::PublisherOptions`
299+
300+
The deprecated `pubsub::PublisherOptions` has been removed. Please use
301+
`google::cloud::Options` instead.
302+
303+
The following table shows the mapping from `pubsub::PublisherOptions` methods to
304+
their `google::cloud::Options` equivalents:
305+
306+
| `pubsub::PublisherOptions` method | `google::cloud::Options` equivalent |
307+
| --------------------------------- | -------------------------------------------------- |
308+
| `(constructor)` | `google::cloud::Options{}` |
309+
| `set_maximum_hold_time` | `google::cloud::pubsub::MaxHoldTimeOption` |
310+
| `set_maximum_batch_message_count` | `google::cloud::pubsub::MaxBatchMessagesOption` |
311+
| `set_maximum_batch_bytes` | `google::cloud::pubsub::MaxBatchBytesOption` |
312+
| `enable_message_ordering` | `google::cloud::pubsub::MessageOrderingOption` |
313+
| `disable_message_ordering` | `google::cloud::pubsub::MessageOrderingOption` |
314+
| `set_maximum_pending_bytes` | `google::cloud::pubsub::MaxPendingBytesOption` |
315+
| `set_maximum_pending_messages` | `google::cloud::pubsub::MaxPendingMessagesOption` |
316+
| `set_full_publisher_ignored` | `google::cloud::pubsub::FullPublisherActionOption` |
317+
| `set_full_publisher_rejects` | `google::cloud::pubsub::FullPublisherActionOption` |
318+
| `set_full_publisher_blocks` | `google::cloud::pubsub::FullPublisherActionOption` |
319+
320+
Example usage of the replacements can be found below.
321+
322+
**Before:**
323+
324+
```cpp
325+
namespace gc = ::google::cloud;
326+
namespace pubsub = ::google::cloud::pubsub;
327+
328+
auto publisher_options = pubsub::PublisherOptions{}
329+
.enable_message_ordering()
330+
.set_full_publisher_ignored();
331+
332+
auto publisher = pubsub::Publisher(pubsub::MakePublisherConnection(
333+
topic, publisher_options);
334+
```
335+
336+
**After:**
337+
338+
```cpp
339+
namespace gc = ::google::cloud;
340+
namespace pubsub = ::google::cloud::pubsub;
341+
342+
auto options = gc::Options{}
343+
.set<pubsub::MessagePrderingOption>(true)
344+
.set<pubsub::FullPublisherActionOption>(
345+
pubsub::FullPublisherAction::kBlockIgnored);
346+
347+
auto publisher = pubsub::Publisher(pubsub::MakePublisherConnection(
348+
topic, options));
349+
```
350+
351+
</details>
352+
353+
<details>
354+
<summary>Removed <code>pubsub::SubscriberOptions</code>
355+
</summary>
356+
#### `pubsub::SubscriberOptions`
357+
358+
The deprecated `pubsub::SubscriberOptions` has been removed. Please use
359+
`google::cloud::Options` instead.
360+
361+
The following table shows the mapping from `pubsub::SubscriberOptions` methods
362+
to their `google::cloud::Options` equivalents:
363+
364+
| `pubsub::SubscriberOptions` method | `google::cloud::Options` equivalent |
365+
| ---------------------------------- | ----------------------------------------------------- |
366+
| `(constructor)` | `google::cloud::Options{}` |
367+
| `set_max_deadline_time` | `google::cloud::pubsub::MaxDeadlineTimeOption` |
368+
| `set_max_deadline_extension` | `google::cloud::pubsub::MaxDeadlineExtensionOption` |
369+
| `set_max_outstanding_messages` | `google::cloud::pubsub::MaxOutstandingMessagesOption` |
370+
| `set_max_outstanding_bytes` | `google::cloud::pubsub::MaxOutstandingBytesOption` |
371+
| `set_max_concurrency` | `google::cloud::pubsub::MaxConcurrencyOption` |
372+
| `set_shutdown_polling_period` | `google::cloud::pubsub::ShutdownPollingPeriodOption` |
373+
374+
Example usage of the replacements can be found below.
375+
376+
**Before:**
377+
378+
```cpp
379+
namespace gc = ::google::cloud;
380+
namespace pubsub = ::google::cloud::pubsub;
381+
382+
auto subscriber_options = pubsub::SubscriberOptions{}
383+
.set_max_deadline_time(std::chrono::seconds(10))
384+
.set_max_outstanding_messages(42);
385+
386+
auto subscriber = pubsub::Subscriber(pubsub::MakeSubscriberConnection(
387+
subscription, subscriber_options);
388+
```
389+
390+
**After:**
391+
392+
```cpp
393+
namespace gc = ::google::cloud;
394+
namespace pubsub = ::google::cloud::pubsub;
395+
396+
auto options = gc::Options{}
397+
.set<pubsub::MaxDeadlineTimeOption>(10)
398+
.set<pubsub::MaxOutstandingMessagesOption>(42);
399+
400+
auto subscriber = pubsub::Subscriber(pubsub::MakeSubscriberConnection(
401+
subscription, options));
402+
```
403+
404+
</details>
405+
295406
### Spanner
296407

297408
<details>

0 commit comments

Comments
 (0)