[
https://issues.apache.org/jira/browse/BEAM-7738?focusedWorklogId=332062&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-332062
]
ASF GitHub Bot logged work on BEAM-7738:
----------------------------------------
Author: ASF GitHub Bot
Created on: 22/Oct/19 16:17
Start Date: 22/Oct/19 16:17
Worklog Time Spent: 10m
Work Description: mxm commented on pull request #9268: [BEAM-7738] Add
external transform support to PubsubIO
URL: https://github.com/apache/beam/pull/9268#discussion_r337614947
##########
File path: sdks/python/apache_beam/io/external/gcp/pubsub.py
##########
@@ -0,0 +1,160 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from __future__ import absolute_import
+
+import typing
+
+from past.builtins import unicode
+
+import apache_beam as beam
+from apache_beam.io.gcp import pubsub
+from apache_beam.transforms import Map
+from apache_beam.transforms.external import ExternalTransform
+from apache_beam.transforms.external import NamedTupleBasedPayloadBuilder
+
+ReadFromPubsubSchema = typing.NamedTuple(
+ 'ReadFromPubsubSchema',
+ [
+ ('topic', typing.Optional[unicode]),
+ ('subscription', typing.Optional[unicode]),
+ ('id_label', typing.Optional[unicode]),
+ ('with_attributes', bool),
+ ('timestamp_attribute', typing.Optional[unicode]),
+ ]
+)
+
+
+class ReadFromPubSub(beam.PTransform):
+ """An external ``PTransform`` for reading from Cloud Pub/Sub."""
+
+ URN = 'beam:external:java:pubsub:read:v1'
+
+ def __init__(self, topic=None, subscription=None, id_label=None,
+ with_attributes=False, timestamp_attribute=None,
+ expansion_service=None):
+ """Initializes ``ReadFromPubSub``.
+
+ Args:
+ topic: Cloud Pub/Sub topic in the form
+ "projects/<project>/topics/<topic>". If provided, subscription must be
+ None.
+ subscription: Existing Cloud Pub/Sub subscription to use in the
+ form "projects/<project>/subscriptions/<subscription>". If not
+ specified, a temporary subscription will be created from the specified
+ topic. If provided, topic must be None.
+ id_label: The attribute on incoming Pub/Sub messages to use as a unique
+ record identifier. When specified, the value of this attribute (which
+ can be any string that uniquely identifies the record) will be used for
+ deduplication of messages. If not provided, we cannot guarantee
+ that no duplicate data will be delivered on the Pub/Sub stream. In this
+ case, deduplication of the stream will be strictly best effort.
+ with_attributes:
+ True - output elements will be
+ :class:`~apache_beam.io.gcp.pubsub.PubsubMessage` objects.
+ False - output elements will be of type ``bytes`` (message
+ data only).
+ timestamp_attribute: Message value to use as element timestamp. If None,
+ uses message publishing time as the timestamp.
+
+ Timestamp values should be in one of two formats:
+
+ - A numerical value representing the number of milliseconds since the
+ Unix epoch.
+ - A string in RFC 3339 format, UTC timezone. Example:
+ ``2015-10-29T23:41:41.123Z``. The sub-second component of the
+ timestamp is optional, and digits beyond the first three (i.e., time
+ units smaller than milliseconds) may be ignored.
+ """
+ self.params = ReadFromPubsubSchema(
+ topic=topic,
+ subscription=subscription,
+ id_label=id_label,
+ with_attributes=with_attributes,
+ timestamp_attribute=timestamp_attribute)
+ self.expansion_service = expansion_service
+
+ def expand(self, pbegin):
+ pcoll = pbegin.apply(
+ ExternalTransform(
+ self.URN, NamedTupleBasedPayloadBuilder(self.params),
+ self.expansion_service))
+
+ if self.params.with_attributes:
+ pcoll = pcoll | 'FromProto' >> Map(pubsub.PubsubMessage._from_proto_str)
+ pcoll.element_type = pubsub.PubsubMessage
+ else:
+ pcoll.element_type = bytes
+ return pcoll
+
+
+WriteToPubsubSchema = typing.NamedTuple(
+ 'WriteToPubsubSchema',
+ [
+ ('topic', unicode),
+ ('id_label', typing.Optional[unicode]),
+ # this is not implemented yet on the Java side:
+ # ('with_attributes', bool),
+ ('timestamp_attribute', typing.Optional[unicode]),
+ ]
+)
+
+
+class WriteToPubSub(beam.PTransform):
+ """An external ``PTransform`` for writing messages to Cloud Pub/Sub."""
Review comment:
Same as above.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 332062)
Time Spent: 6.5h (was: 6h 20m)
> Support PubSubIO to be configured externally for use with other SDKs
> --------------------------------------------------------------------
>
> Key: BEAM-7738
> URL: https://issues.apache.org/jira/browse/BEAM-7738
> Project: Beam
> Issue Type: New Feature
> Components: io-java-gcp, runner-flink, sdk-py-core
> Reporter: Chad Dombrova
> Assignee: Chad Dombrova
> Priority: Major
> Labels: portability
> Time Spent: 6.5h
> Remaining Estimate: 0h
>
> Now that KafkaIO is supported via the external transform API (BEAM-7029) we
> should add support for PubSub.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
