Package org.apache.beam.sdk.io.gcp.pubsub
Defines transforms for reading and writing from Google
Cloud Pub/Sub.
- See Also:
PubsubIO
-
Interface Summary Interface Description PubsubClient.PubsubClientFactory Factory for creating clients.PubsubOptions Properties that can be set when using Google Cloud Pub/Sub with the Apache Beam SDK.PubsubTestClient.PubsubTestClientFactory Closing the factory will validate all expected messages were processed.TestPubsub.PollingAssertion TestPubsubOptions PipelineOptions
forTestPubsub
. -
Class Summary Class Description ExternalRead ExposesPubsubIO.Read
as an external transform for cross-language usage.ExternalRead.Configuration Parameters class to expose the transform to an external SDK.ExternalRead.ReadBuilder ExternalWrite ExposesPubsubIO.Write
as an external transform for cross-language usage.ExternalWrite.Configuration Parameters class to expose the transform to an external SDK.ExternalWrite.WriteBuilder PubsubClient An (abstract) helper class for talking to Pubsub via an underlying transport.PubsubClient.OutgoingMessage A message to be sent to Pubsub.PubsubClient.ProjectPath Path representing a cloud project id.PubsubClient.SubscriptionPath Path representing a Pubsub subscription.PubsubClient.TopicPath Path representing a Pubsub topic.PubsubCoderProviderRegistrar ACoderProviderRegistrar
for standard types used withPubsubIO
.PubsubDlqProvider PubsubGrpcClient A helper class for talking to Pubsub via grpc.PubsubIO Read and WritePTransform
s for Cloud Pub/Sub streams.PubsubIO.PubsubSubscription Class representing a Cloud Pub/Sub Subscription.PubsubIO.PubsubTopic Class representing a Cloud Pub/Sub Topic.PubsubIO.Read<T> Implementation of read methods.PubsubIO.Write<T> Implementation of write methods.PubsubJsonClient A Pubsub client using JSON transport.PubsubMessage Class representing a Pub/Sub message.PubsubMessagePayloadOnlyCoder A coder for PubsubMessage treating the raw bytes being decoded as the message's payload.PubsubMessages Common util functions for converting between PubsubMessage proto andPubsubMessage
.PubsubMessages.DeserializeBytesIntoPubsubMessagePayloadOnly PubsubMessages.ParsePayloadAsPubsubMessageProto PubsubMessages.ParsePubsubMessageProtoAsPayload PubsubMessageWithAttributesAndMessageIdAndOrderingKeyCoder A coder for PubsubMessage including all fields of a PubSub message from server.PubsubMessageWithAttributesAndMessageIdCoder A coder for PubsubMessage including attributes and the message id from the PubSub server.PubsubMessageWithAttributesCoder A coder for PubsubMessage including attributes.PubsubMessageWithMessageIdCoder A coder for PubsubMessage treating the raw bytes being decoded as the message's payload, with the message id from the PubSub server.PubSubPayloadTranslation PubSubPayloadTranslation.ReadRegistrar PubSubPayloadTranslation.WriteRegistrar PubsubSchemaIOProvider An implementation ofSchemaIOProvider
for reading and writing JSON/AVRO payloads withPubsubIO
.PubsubSchemaTransformReadConfiguration Configuration for reading from Pub/Sub.PubsubSchemaTransformReadConfiguration.Builder PubsubSchemaTransformReadProvider An implementation ofTypedSchemaTransformProvider
for Pub/Sub reads configured usingPubsubSchemaTransformReadConfiguration
.PubsubSchemaTransformWriteConfiguration Configuration for writing to Pub/Sub.PubsubSchemaTransformWriteConfiguration.Builder Builder forPubsubSchemaTransformWriteConfiguration
.PubsubTestClient A (partial) implementation ofPubsubClient
for use by unit tests.PubsubUnboundedSink A PTransform which streams messages to Pubsub.PubsubUnboundedSource Users should usePubsubIO#read
instead.TestPubsub Test rule which creates a new topic and subscription with randomized names and exposes the APIs to work with them.TestPubsubSignal Test rule which observes elements of thePCollection
and checks whether they match the success criteria.