Version history

Version 3.18.0, released 2024-09-26

No API surface changes; just dependency updates.

Version 3.17.0, released 2024-09-26

New features

Add ingestion Cloud Storage fields and Platform Logging fields to Topic (commit 5098b56)
Return listing information for subscriptions created via Analytics Hub (commit ce5de77)

Documentation improvements

Update documentation for 31 day subscription message retention (commit 950f588)

Version 3.16.0, released 2024-07-22

New features

Add max messages batching for Cloud Storage subscriptions (commit 953eefe)

Version 3.15.0, released 2024-06-24

New features

Add use_topic_schema for Cloud Storage Subscriptions (commit d557116)

Version 3.14.0, released 2024-05-31

Bug fixes

Fix possible race condition when restarting the stream (commit 4410bb1)

New features

Add service_account_email for export subscriptions (commit f73410e)
Make StreamingPull fail after 100 consecutive failures (commit d9d658b)
Improve Pub/Sub streaming pull retries (commit 8537ed4)

The last two of these features can cause user-visible changes. In particular:

Persistently-failing streaming pulls will eventually cause a SubscriberClient to fail
Authentication-based failures (e.g. using an expired service account) will now cause a SubscriberClient to fail
SubscriberClient will retry immediately after a streaming pull stream is terminated server-side, if the pull was active for 45 seconds or more before being terminated. This should improve responsiveness in some situations.

All of these changes should be "net positive", but if they cause any issues, please file a bug.

Version 3.13.0, released 2024-05-17

New features

Improve SubscriberClient logging (commit a9896c9)
Add IServiceCollection extension methods for client registration where an IServiceProvider is required. (commit 022fab2)

Version 3.12.0, released 2024-03-26

New features

Change netstandard2.1 target to netstandard2.0 (commit 82bea85)
Add custom datetime format for Cloud Storage subscriptions (commit cb33d77)

Version 3.11.0, released 2024-03-25

New features

Added TopicName and SubsciptionName resolution from container as an extension point. (issue 12215) (commit 73c457d)

Version 3.10.1, released 2024-03-19

New features

Add initial logging to PublisherClient and SubscriberClient (commit 931bd76)

Version 3.10.0, released 2024-03-05

Documentation improvements

Small fix in Pub/Sub ingestion comments (commit 663a29c)

Version 3.10.0-beta01, released 2024-02-09

New features

Add enforce_in_transit fields and optional annotations (commit 43c6cd3)
Add ingestion_data_source_settings field to Topic (commit 06f6c30)

Version 3.9.1, released 2024-01-03

Bug fixes

Use message ordering enabled property that comes with streaming pull responses so that messages are only delivered to the callback one at a time in order when ordering is actually enabled (commit 3f8f8a2)

Version 3.9.0, released 2023-12-04

New features

Add use_table_schema field to BigQueryConfig (commit c489a15)

Version 3.8.0, released 2023-11-03

Bug fixes

Set x-goog-request-params for streaming pull requests from SubscriberClient (commit 7b6ec74)

Documentation improvements

Modified some descriptions (commit 1dd516c)

Version 3.7.0, released 2023-09-06

Bug fixes

Make retry policy back off more aggressively for RPCs that retry RESOURCE_EXHAUSTD (commit c5e2b5f)

Documentation improvements

Clarified where ordering_key will be written if write_metadata is set (commit 2436db1)
Tightened requirements on cloud storage subscription filename suffixes (commit f4d7887)

Version 3.6.0, released 2023-06-12

Bug fixes

Correct the auto-extend lease interval for exactly-once delivery. (commit c33999d)
Dispose the pull stream. (commit 3518402)

New features

Add push config wrapper fields (commit 1cdef74)
Add support for Publisher Compression. (commit e684e05)

Documentation improvements

Clarify the use of FlowControlSettings in SusbcriberClient. (commit 7081baf)

Version 3.6.0-beta01, released 2023-05-16

Note that this is a beta release as the deadlock workaround for issue is far from ideal. We'll create a new GA release when Grpc.Net.Client has been fixed.

Bug fixes

Add missing field when creating a SubscriberClient.Settings from another. (commit 204866c)
Temporary patch for PubSub Subscriber deadlock issue. (commit d965b93)

New features

Add cloud storage subscription fields (commit b3b6104)

Version 3.5.1, released 2023-05-05

Bug fixes

Dispose channel on PublisherClient/SubscriberClient shutdown. Fixes #10304 (commit d38ab04)

Version 3.5.0, released 2023-04-19

New features

Reliability improvements in exactly-once delivery. (commit 27b2430)

Version 3.4.0, released 2023-03-08

Bug fixes

Ack/ModAck failures in non exactly once delivery flow should not be retried (commit a0da1f5)

New features

Make INTERNAL a retryable error for Pull (commit ad9963e)
Add temporary_failed_ack_ids to ModifyAckDeadlineConfirmation (commit 55fef61)
Add google.api.method.signature to update methods (commit cf2f61a)
Implemented IAsyncDisposable in PublisherClient and SubscriberClient (commit 2ae9ab7)
Added IServiceCollection extension methods for PublisherClient and SubscriberClient (commit fe942e0)

Documentation improvements

Add x-ref for ordering messages (commit 16a4ddc)
Clarify subscription expiration policy (commit 16a4ddc)
Clarify BigQueryConfig PERMISSION_DENIED state (commit 78feab7)
Clarify subscription description (commit 5d43a47)
Replacing HTML code with Markdown (commit f9467b0)
Fix PullResponse description (commit f9467b0)
Fix Pull description (commit f9467b0)
Update Pub/Sub topic retention limit from 7 days to 31 days (commit 7281474)
Mark revision_id in CommitSchemaRevisionRequest deprecated (commit 2a9ddbb)

Version 3.3.0, released 2023-01-19

New features

Add schema evolution methods and fields (commit 4003c4d)

Version 3.2.0, released 2022-08-26

New features

Exactly once delivery (commit e93c4d3)
Add support for exactly once subscription (commit 46d8b0d)

Version 3.1.0, released 2022-07-27

New features

Add SubscriberClientBuilder (commit 5f830ac)
Add PublisherClientBuilder (commit 09eeaa9)

Version 3.0.0, released 2022-06-29

No API surface changes since 3.0.0-beta01. (See 3.0.0-beta01 release notes for details.)

Version 3.0.0-beta01, released 2022-06-09

This is the first version of this package to depend on GAX v4.

There are some breaking changes, both in GAX v4 and in the generated code. The changes that aren't specific to any given API are described in the Google Cloud documentation. We don't anticipate any changes to most customer code, but please file a GitHub issue if you run into problems.

The most important change in this release is the use of the Grpc.Net.Client package for gRPC communication, instead of Grpc.Core. When using .NET Core 3.1 or .NET 5.0+ this should lead to a smaller installation footprint and greater compatibility (e.g. with Apple M1 chips). Any significant change in a core component comes with the risk of incompatibility, however - so again, please let us know if you encounter any issues.

Version 2.10.0, released 2022-05-24

New features

Add BigQuery configuration for subscriptions (commit 93ceda9)

Version 2.9.0, released 2022-04-04

Bug fixes

Increased grpc.max_metadata_size value to 4 M.B. in PublisherClient (commit a29a5f3)
Ignore exceptions during Ack/ModifyAckDeadline in SubscriberClient (commit f36fd61)

Version 2.8.0, released 2022-03-22

Bug fixes

Increased grpc.max_metadata_size value to 4 M.B. This fixes an issue in SubscriberClient with exactly-once delivery. (commit e78afdf)

New features

Add IAM mixin to Google.Cloud.PubSub.V1 (commit fda5e80)
Add exactly once delivery flag (commit fa0b21c and commit e7b592b)
- This is only for the generated code; SubscriberClient has no support yet

Version 2.7.0, released 2021-09-23

Commit ac367e2: feat: Regenerate all APIs to support self-signed JWTs
Commit 4cc3e58: feat: Add topic retention options

Version 2.6.0, released 2021-08-10

Commit 61c5c17: chore: Remove unused fields in PublisherClient
Commit c75f979: Update PubSub ConfigureAwait warning disablement
Commit 5fede56: feat: Add method signature for Subscriber.Pull without the deprecated return_immediately field.
Commit 887ec05: feat: Adding subscription properties to streaming pull response in third party pubsub.proto.

Version 2.5.0, released 2021-05-26

Commit 3717e0d: Regenerate all APIs with generator change for deprecation
Commit 5022a1e: Use CopySettingsForEmulator in PubSub clients
Commit 8e6076e: docs: Remove experimental note for schema APIs

Version 2.4.0, released 2021-02-24

Commit a43730c: fix: PublisherClient required credentials even when using the emulator. Fixes issue 5973
Commit 071ea6f: Add sync Create() method to PublisherClient and SubscriberClient (issue 5895)

Version 2.3.0, released 2021-01-25

Commit 68db70f: fix: Fix error where the lease-extension-delay could be negative. Fixes issue 5866
Commit d856a51: feat: add schema service
Commit 66574a8: feat: Provide emulator detection in PublisherClient/SubscriberClient

Version 2.2.0, released 2020-12-02

Commit 0ce91bb: feat: Enable server side flow control by default with the option to turn it off (see below)
Commit 0790924: fix: Add gRPC compatibility constructors
Commit 0ca05f5: chore: Regenerate all APIs using protoc 3.13 and Grpc.Tools 2.31

As of this release, flow control settings are enforced at the client and are also sent to the Cloud Pub/Sub server but not enforced on the server side yet. Server side flow control is on track to be enabled by the 2nd week of December 2020. Users that face issues with server side flow control can disable it by setting SubscriberClient.Settings.UseLegacyFlowControl to true which will result in the enforcement of client side flow control only.

Version 2.1.0, released 2020-08-03

Commit 330b04e: Fix: PubSub methods will now be retried appropriately. Fixes issue 5225
Commit 0cd128c: docs: Remove experimental warning for ordering keys properties. (issue 5219)
Commit 6bde7a3: docs: Regenerate all APIs with service comments in client documentation
Commit 6165e07: feat: Add support for server-side streaming pull flow control (issue 5119)
Commit 2c5f3c1: feat: Add flow control settings for StreamingPullRequest to pubsub.proto
Commit b5500f5: docs: Add a link to Pub/Sub filtering language public documentation to pubsub.proto
Commit ac924f2: feat: Add "detached" bool to Subscription
Commit f3eeca0: docs: Add comment for MessageStoragePolicy message
Commit 1dae64f: fix: Use correct resource type for DetachSubscriptionRequest
Commit 5f5b8aa: feat: DetachSubscription RPC
Commit 947a573: docs: Regenerate all clients with more explicit documentation
Commit 777b926: docs: Removing the experimental tag from dead letter policy related fields.
Commit 8cd3929: docs: Removing experimental tag from DeadLetterPolicy for Cloud Pub/Sub.

Version 2.0.0, released 2020-04-09

Commit 26de65c: Fix: Fix comment around default AckDeadline
Commit b872180: docs: treat a dummy example URL as a string literal instead of a link
Commit ab949d1: Feature: experimental Subscription.Filter property

First GA release targeting GAX 3.0.0.

Version 2.0.0-beta02, released 2020-03-18

Commit 2096b6d: Feature: Subscription.RetryPolicy
Commit e4226b7:
- Regenerate Google.Cloud.PubSub.V1 (issue 4515)
- PullRequest.ReturnImmediately is now obsolete
- ListTopicSnapshots methods have new overloads accepting a topic name
- GetSnapshot methods have new overloads accepting a snapshot name

Additionally, dependencies have been updated to target GAX 3.0.0.

Version 2.0.0-beta01, released 2020-02-18

This is the first prerelease targeting GAX v3. Please see the breaking changes guide for details of changes to both GAX and code generation.

Additional significant changes in this release:

Commit 173b019: Dead-letter queue support in subscriber client

Version 1.2.0-beta01, released 2020-01-06

Commit d859592: Fully enable ordering-keys (issue 3921)
Commit e13ab00: Update default settings; add maximum total lease extension (issue 3920)

Version 1.1.0, released 2019-12-10

Note that support is present in the code for ordering keys, but it's currently disabled; it will be enabled in a future release.

Commit 5742d91: Adds ReceivedMessage.DeliveryAttempt
Commit 1784804: Adds dead letter policy
Commit 50658e2: Add format method for all resource name types
Commit c3af927: Fix error in handling non-ordered batch errors (issue 3133)
Commit 7f24b13: Minor fix for memory leak risk (issue 3120)
Commit afa4a96: Pubsub client ordering-keys (issue 3099)
Commit ee5c7dc: Add client builders for simplified configuration
Commit 0609777: Dispose correctly, and properly ignore cancellation (issue 3083)
Commit 397623e: Adds KMS support
Commit 1424e89: Adds method overloads accepting strings for methods accepting resource names
Commit ddc2de2: Adds ordering keys in the underlying API, but no specific support
Commit 5a18d38: Adds OidcToken and AuthenticationMethod
Commit e664cad: Create pubsub channels with correct unique-per-channel id (issue 2798)
Commit 61cd808: Avoid unobserved InvalidOperationException in AsyncSingleRecvQueue (issue 2785). Fixes issue 2763
Commit 1d0c50c: Adds ExpirationPolicy

Version 1.0.0, released 2018-10-08

Initial GA release.