# Interface ApiStreamObserver&lt;V&gt; (2.81.0)

2.81.0 (latest) 2.80.0 2.79.0 2.76.0 2.75.0 2.74.1 2.73.1 2.72.2 2.71.0 2.70.3 2.69.0 2.68.2 2.67.0 2.66.0 2.65.0 2.63.1 2.62.0 2.61.0 2.60.0 2.59.1 2.58.0 2.57.0 2.55.0 2.54.1 2.53.0 2.52.0 2.51.0 2.50.0 2.49.0 2.48.1 2.47.0 2.46.1 2.45.0 2.43.0 2.42.0 2.41.0 2.39.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.1 2.33.0 2.32.1 2.31.1 2.30.1 2.24.0 2.23.3 2.22.0 2.21.0 2.20.1 2.19.6 2.18.7 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.2 2.11.0 2.10.0 2.9.0 2.8.1 2.7.1

    public interface ApiStreamObserver<V>

Receives notifications from an observable stream of messages.

It is used for sending messages in bidi (bidirectional) or client-streaming calls, or for
receiving messages in bidi or server-streaming calls.

For outgoing messages, an `ApiStreamObserver` is provided by GAX to the application, and
the application then provides the messages to send. For incoming messages, the application
implements the `ApiStreamObserver` and passes it to GAX, which then calls the observer with
the messages for the application to receive them.

Implementations are expected to be [thread-compatible](http://www.ibm.com/developerworks/library/j-jtp09263/). Separate
`ApiStreamObserver`s do not need to be synchronized together; incoming and outgoing
directions are independent. Since individual `ApiStreamObserver`s are not thread-safe, if
multiple threads will be writing to a `ApiStreamObserver` concurrently, the application
must synchronize calls.

This interface is a fork of io.grpc.stub.StreamObserver to enable shadowing of Guava, and also
to allow for a transport-agnostic interface that doesn't depend on gRPC.

| ## Type Parameter ||
|---|---|
| **Name** | **Description** |
| `V` |   |

## Methods

### onCompleted()

    public abstract void onCompleted()

Receives a notification of successful stream completion.

May only be called once, and if called it must be the last method called. In particular if
an exception is thrown by an implementation of `onCompleted`, no further calls to any
method are allowed.

### onError(Throwable t)

    public abstract void onError(Throwable t)

Receives a terminating error from the stream.

May only be called once and if called, it must be the last method called. In particular if
an exception is thrown by an implementation of `onError`, no further calls to any method
are allowed.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `t` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html` the error occurred on the stream |

### onNext(V value)

    public abstract void onNext(V value)

Receives a value from the stream.

Can be called many times but is never called after [#onError(Throwable)](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.ApiStreamObserver#com_google_api_gax_rpc_ApiStreamObserver_onError_java_lang_Throwable_) or [#onCompleted()](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.ApiStreamObserver#com_google_api_gax_rpc_ApiStreamObserver_onCompleted__) are called.

Clients may invoke onNext at most once for server streaming calls, but may receive many
onNext callbacks. Servers may invoke onNext at most once for client streaming calls, but may
receive many onNext callbacks.

If an exception is thrown by an implementation the caller is expected to terminate the
stream by calling [#onError(Throwable)](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.ApiStreamObserver#com_google_api_gax_rpc_ApiStreamObserver_onError_java_lang_Throwable_) with the caught exception prior to propagating
it.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `V` the value passed to the stream |