2.83.0 (latest) 2.82.0 2.81.0 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 abstract class ServerStreamingCallable<RequestT,ResponseT>

A ServerStreamingCallable is an immutable object which is capable of making RPC calls to server
streaming API methods. Not all transports support streaming.

It is considered advanced usage for a user to create a ServerStreamingCallable themselves.
This class is intended to be created by a generated client class, and configured by instances of
StreamingCallSettings.Builder which are exposed through the client settings class.

## Inheritance

[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \> ServerStreamingCallable\<RequestT,ResponseT\>

## Inherited Members

[Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) [Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) [Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) [Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) [Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) [Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) [Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) [Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) [Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) [Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) [Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)

| ## Type Parameters ||
|---|---|
| **Name** | **Description** |
| `RequestT` |   |
| `ResponseT` |   |

## Constructors

### ServerStreamingCallable()

    protected ServerStreamingCallable()

## Methods

### all()

    public UnaryCallable<RequestT,List<ResponseT>> all()

Construct a [UnaryCallable](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable) that will buffer the entire stream into memory before
completing. If the stream is empty, then the list will be empty.

Example usage:


     StreamingCallable<String> streamingCallable = // ..
     List<String> theResult = streamingCallable.all().call(request);
     ApiFuture<List<String>> theResult = streamingCallable.all().futureCall(request);
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable<RequestT,https://docs.oracle.com/javase/8/docs/api/java/util/List.html<ResponseT>>` | The [UnaryCallable](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable). |

### blockingServerStreamingCall(RequestT request) (deprecated)

    public Iterator<ResponseT> blockingServerStreamingCall(RequestT request)

**Deprecated.** *Please use call() instead.*

Conduct a iteration server streaming call

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `RequestT` request |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html<ResponseT>` | [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html) which is used for iterating the responses. |

### blockingServerStreamingCall(RequestT request, @Nullable ApiCallContext context) (deprecated)

    public Iterator<ResponseT> blockingServerStreamingCall(RequestT request, @Nullable ApiCallContext context)

**Deprecated.** *Please use call() instead.*

Conduct an iteration server streaming call

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `RequestT` request |
| `context` | `@org.jspecify.annotations.Nullable com.google.api.gax.rpc.ApiCallContext` context |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html<ResponseT>` | [Iterator](https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html) which is used for iterating the responses. |

### call(RequestT request)

    public ServerStream<ResponseT> call(RequestT request)

Conduct a iteration server streaming call.

This returns a live stream that must either be fully consumed or cancelled. Example usage:


     StreamingCallable<String> streamingCallable = // ..
     ServerStream stream = streamingCallable.call(request)
     for (String s : stream) {
       if ("needle".equals(s)) {
         // Cancelling the stream will cause `hasNext()` to return false on the next iteration,
         // naturally breaking the loop.
         stream.cancel();
       }
     }
     List<String> theResult = streamingCallable.all().call(request);
     ApiFuture<List<String>> theResult = streamingCallable.all().futureCall(request);
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `RequestT` request |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.ServerStream<ResponseT>` | [ServerStream](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.ServerStream) which is used for iterating the responses. |

### call(RequestT request, @Nullable ApiCallContext context)

    public ServerStream<ResponseT> call(RequestT request, @Nullable ApiCallContext context)

Conduct a server streaming call with the given ApiCallContext.

This returns a live stream that must either be fully consumed or cancelled.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `RequestT` request |
| `context` | `@org.jspecify.annotations.Nullable com.google.api.gax.rpc.ApiCallContext` the context |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.ServerStream<ResponseT>` | [ServerStream](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.ServerStream) which is used for iterating the responses. |

### call(RequestT request, ResponseObserver\<ResponseT\> responseObserver)

    public void call(RequestT request, ResponseObserver<ResponseT> responseObserver)

Conduct a server streaming call

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `RequestT` request |
| `responseObserver` | `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.ResponseObserver<ResponseT>` [ResponseObserver](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.ResponseObserver) to observe the streaming responses |

### call(RequestT request, ResponseObserver\<ResponseT\> responseObserver, @Nullable ApiCallContext context)

    public abstract void call(RequestT request, ResponseObserver<ResponseT> responseObserver, @Nullable ApiCallContext context)

Conduct a server streaming call with the given ApiCallContext.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `RequestT` request |
| `responseObserver` | `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.ResponseObserver<ResponseT>` [ResponseObserver](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.ResponseObserver) to observe the streaming responses |
| `context` | `@org.jspecify.annotations.Nullable com.google.api.gax.rpc.ApiCallContext` ApiCallContext to provide context information for the RPC call. |

### first()

    public UnaryCallable<RequestT,ResponseT> first()

Construct a [UnaryCallable](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable) that will yield the first item in the stream and cancel it.
If the stream is empty, the item will be null.

Example usage:


     StreamingCallable<String> streamingCallable = // ..
     String theResult = streamingCallable.first().call(request);
     ApiFuture<String> theResult = streamingCallable.first().futureCall(request);
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable<RequestT,ResponseT>` | The [UnaryCallable](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable). |

### serverStreamingCall(RequestT request, ApiStreamObserver\<ResponseT\> responseObserver) (deprecated)

    public void serverStreamingCall(RequestT request, ApiStreamObserver<ResponseT> responseObserver)

**Deprecated.** *Please use the [ResponseObserver](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.ResponseObserver) variant instead.*

Conduct a server streaming call

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `RequestT` request |
| `responseObserver` | `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.ApiStreamObserver<ResponseT>` [ApiStreamObserver](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.ApiStreamObserver) to observe the streaming responses |

### serverStreamingCall(RequestT request, ApiStreamObserver\<ResponseT\> responseObserver, @Nullable ApiCallContext context) (deprecated)

    public void serverStreamingCall(RequestT request, ApiStreamObserver<ResponseT> responseObserver, @Nullable ApiCallContext context)

**Deprecated.** *Please use the [ResponseObserver](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.ResponseObserver) variant instead.*

Conduct a server streaming call with the given ApiCallContext.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `RequestT` request |
| `responseObserver` | `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.ApiStreamObserver<ResponseT>` [ApiStreamObserver](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.ApiStreamObserver) to observe the streaming responses |
| `context` | `@org.jspecify.annotations.Nullable com.google.api.gax.rpc.ApiCallContext` ApiCallContext to provide context information for the RPC call. |

### withDefaultCallContext(ApiCallContext defaultCallContext)

    public ServerStreamingCallable<RequestT,ResponseT> withDefaultCallContext(ApiCallContext defaultCallContext)

Returns a new `ServerStreamingCallable` with an ApiCallContext that is used as a
default when none is supplied in individual calls.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `defaultCallContext` | `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.ApiCallContext` the default ApiCallContext. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.ServerStreamingCallable<RequestT,ResponseT>` |   |