MVFC.DataX.Providers.PubSub
1.2.2
dotnet add package MVFC.DataX.Providers.PubSub --version 1.2.2
NuGet\Install-Package MVFC.DataX.Providers.PubSub -Version 1.2.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MVFC.DataX.Providers.PubSub" Version="1.2.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="MVFC.DataX.Providers.PubSub" Version="1.2.2" />
<PackageReference Include="MVFC.DataX.Providers.PubSub" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add MVFC.DataX.Providers.PubSub --version 1.2.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: MVFC.DataX.Providers.PubSub, 1.2.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package MVFC.DataX.Providers.PubSub@1.2.2
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=MVFC.DataX.Providers.PubSub&version=1.2.2
#tool nuget:?package=MVFC.DataX.Providers.PubSub&version=1.2.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
MVFC.DataX.Providers.PubSub
Google Cloud Pub/Sub data provider for MVFC.DataX, implementing messaging via Google.Cloud.PubSub.V1.
This package is part of the MVFC.DataX suite. For the full documentation and more examples, please check the main repository README.
Installation
dotnet add package MVFC.DataX.Providers.PubSub
Available Classes
| Class | Description |
|---|---|
PubSubDataReader<T> |
Streams messages via SubscriberClient.StartAsync, pushing results into an internal Channel and sending Acks/Nacks back to GCP based on pipeline execution. |
PubSubDataWriter<T> |
Publishes messages via PublisherClient.PublishAsync. Batching is handled by issuing Task.WhenAll concurrently. |
API Signatures
PubSubDataReader<T>
public PubSubDataReader(
SubscriberClient subscriberClient,
Func<PubsubMessage, T> deserializer)
PubSubDataWriter<T>
public PubSubDataWriter(
PublisherClient publisherClient,
Func<T, PubsubMessage> serializer)
Usage / Example
using System.Text.Json;
using Google.Cloud.PubSub.V1;
using Google.Protobuf;
using MVFC.DataX.Pipeline;
using MVFC.DataX.Providers.PubSub;
// Ensure your GOOGLE_APPLICATION_CREDENTIALS environment variable is set
var subscriptionName = SubscriptionName.FromProjectSubscription("my-gcp-project", "inbound-sub");
var topicName = TopicName.FromProjectTopic("my-gcp-project", "outbound-topic");
var subscriber = await SubscriberClient.CreateAsync(subscriptionName);
var publisher = await PublisherClient.CreateAsync(topicName);
// 1. Setup the Pub/Sub Reader
var reader = new PubSubDataReader<Order>(
subscriber,
// Deserialize PubsubMessage (ByteString -> string -> object)
deserializer: msg => JsonSerializer.Deserialize<Order>(msg.Data.ToStringUtf8())!
);
// 2. Setup the Pub/Sub Writer
var writer = new PubSubDataWriter<Order>(
publisher,
// Serialize to Protobuf ByteString wrapper
serializer: order => new PubsubMessage
{
Data = ByteString.CopyFromUtf8(JsonSerializer.Serialize(order))
}
);
// 3. Orchestrate with PipelineBuilder
var pipeline = PipelineBuilder.ReadFrom(reader)
.WriteTo(writer)
.WithParallelism(4)
.Build();
await pipeline.RunAsync(cancellationToken);
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- Google.Cloud.PubSub.V1 (>= 3.37.0)
- MVFC.DataX.Core (>= 1.2.2)
-
net9.0
- Google.Cloud.PubSub.V1 (>= 3.37.0)
- MVFC.DataX.Core (>= 1.2.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.