RemoteEnvironment (java-fn-execution 2.68.0 API)

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

ProcessEnvironment, RemoteEnvironment.SimpleRemoteEnvironment, StaticRemoteEnvironment
```
public interface RemoteEnvironment
extends java.lang.AutoCloseable
```
A handle to an available remote RunnerApi.Environment. This environment is connected to a Fn API Control service, and the associated client is available via getInstructionRequestHandler().

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class RemoteEnvironment.SimpleRemoteEnvironment
A RemoteEnvironment which uses the default close() behavior.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default void`	`close()`	.
`static RemoteEnvironment`	`forHandler(org.apache.beam.model.pipeline.v1.RunnerApi.Environment env, InstructionRequestHandler handler)`	Create a new `RemoteEnvironment` for the provided `RunnerApi.Environment` and `AutoCloseable` `InstructionRequestHandler`.
`org.apache.beam.model.pipeline.v1.RunnerApi.Environment`	`getEnvironment()`	Return the environment that the remote handles.
`InstructionRequestHandler`	`getInstructionRequestHandler()`	Return an `InstructionRequestHandler` which can communicate with the environment.

- Method Detail
  - forHandler
```
static RemoteEnvironment forHandler(org.apache.beam.model.pipeline.v1.RunnerApi.Environment env,
                                    InstructionRequestHandler handler)
```
    Create a new RemoteEnvironment for the provided RunnerApi.Environment and AutoCloseable InstructionRequestHandler.
    When the RemoteEnvironment is closed, the InstructionRequestHandler will be closed.
  - getEnvironment
```
org.apache.beam.model.pipeline.v1.RunnerApi.Environment getEnvironment()
```
    Return the environment that the remote handles.
  - getInstructionRequestHandler
```
InstructionRequestHandler getInstructionRequestHandler()
```
    Return an InstructionRequestHandler which can communicate with the environment.
  - close
```
default void close()
            throws java.lang.Exception
```
    .
    By default, closes the getInstructionRequestHandler().
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.lang.Exception