| /* |
| * 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. |
| */ |
| package org.apache.beam.runners.fnexecution.control; |
| |
| import java.util.Map; |
| import org.apache.beam.sdk.fn.data.FnDataReceiver; |
| |
| /** |
| * A bundle capable of handling input data elements for a {@link |
| * org.apache.beam.model.fnexecution.v1.BeamFnApi.ProcessBundleDescriptor bundle descriptor} by |
| * forwarding them to a remote environment for processing. |
| * |
| * <p>When a RemoteBundle is closed, it will block until bundle processing is finished on remote |
| * resources, and throw an exception if bundle processing has failed. |
| */ |
| public interface RemoteBundle extends AutoCloseable { |
| /** Get an id used to represent this bundle. */ |
| String getId(); |
| |
| /** |
| * Get a map of PCollection ids to {@link FnDataReceiver receiver}s which consume input elements, |
| * forwarding them to the remote environment. |
| */ |
| Map<String, FnDataReceiver> getInputReceivers(); |
| |
| /** |
| * Closes this bundle. This causes the input {@link FnDataReceiver} to be closed (future calls to |
| * that {@link FnDataReceiver} will throw an exception), and causes the {@link RemoteBundle} to |
| * produce any buffered outputs. The call to {@link #close()} will block until all of the outputs |
| * produced by this bundle have been received. |
| */ |
| @Override |
| void close() throws Exception; |
| } |