Class ServerStreamingCallable<RequestT,ResponseT> (2.9.0)

Version 2.9.0

• 2.59.0 (latest)
• 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 > ServerStreamingCallable<RequestT,ResponseT>

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Type Parameters

Name	Description
RequestT
ResponseT

Constructors

ServerStreamingCallable()

protected ServerStreamingCallable()

Methods

all()

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

Construct a 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

Returns

Type	Description
UnaryCallable<RequestT,List<ResponseT>>	The 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
Iterator<ResponseT>	Iterator which is used for iterating the responses.

blockingServerStreamingCall(RequestT request, ApiCallContext context) (deprecated)

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

(deprecated) Please use call() instead.

Conduct an iteration server streaming call

Parameters

Name	Description
request	RequestT request
context	ApiCallContext context

Returns

Type	Description
Iterator<ResponseT>	Iterator 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

Parameter

Name	Description
request	RequestT request

Returns

Type	Description
ServerStream<ResponseT>	ServerStream which is used for iterating the responses.

call(RequestT request, ApiCallContext context)

public ServerStream<ResponseT> call(RequestT request, 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	ApiCallContext the context

Returns

Type	Description
ServerStream<ResponseT>	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	ResponseObserver<ResponseT> ResponseObserver to observe the streaming responses

call(RequestT request, ResponseObserver<ResponseT> responseObserver, ApiCallContext context)

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

Conduct a server streaming call with the given ApiCallContext.

Parameters

Name	Description
request	RequestT request
responseObserver	ResponseObserver<ResponseT> ResponseObserver to observe the streaming responses
context	ApiCallContext ApiCallContext to provide context information for the RPC call.

first()

public UnaryCallable<RequestT,ResponseT> first()

Construct a 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
UnaryCallable<RequestT,ResponseT>	The UnaryCallable.

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

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

(deprecated) Please use the ResponseObserver variant instead.

Conduct a server streaming call

Parameters

Name	Description
request	RequestT request
responseObserver	ApiStreamObserver<ResponseT> ApiStreamObserver to observe the streaming responses

serverStreamingCall(RequestT request, ApiStreamObserver<ResponseT> responseObserver, ApiCallContext context) (deprecated)

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

(deprecated) Please use the ResponseObserver variant instead.

Conduct a server streaming call with the given ApiCallContext.

Parameters

Name	Description
request	RequestT request
responseObserver	ApiStreamObserver<ResponseT> ApiStreamObserver to observe the streaming responses
context	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	ApiCallContext the default ApiCallContext.

Returns

Type	Description
ServerStreamingCallable<RequestT,ResponseT>