| //// |
| 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. |
| //// |
| :documentationPath: /plugins/transforms/ |
| :language: en_US |
| :page-alternativeEditUrl: https://github.com/apache/incubator-hop/edit/master/plugins/engines/beam/src/main/doc/beamsubscriber.adoc |
| = Beam GCP Pub/Sub : Subscribe |
| |
| == Description |
| |
| The Beam GCP Pub/Sub : Subscribe transform gets messages from a link:https://cloud.google.com/pubsub[Google Cloud Pub/Sub] topic using a subscription with the Beam execution engine. |
| |
| == Options |
| |
| [width="90%", options="header"] |
| |=== |
| |Option|Description |
| |Transform name|Name of the transform, this name has to be unique in a single pipeline. |
| |Subscription name|Name of the Google Cloud Pub/Sub subscription. |
| |Topic to subscribe to|The Google Cloud Pub/Sub topic. |
| |The type of message to read a| |
| |
| * String |
| * PubsubMessage |
| |The output field name|The field containing the result message. |
| |=== |