Class ClientStreamingCallable<RequestT,ResponseT>

public abstract class ClientStreamingCallable<RequestT,ResponseT>

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

It is considered advanced usage for a user to create a ClientStreamingCallable 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 > ClientStreamingCallable<RequestT,ResponseT>

Type Parameters

NameDescription
RequestT
ResponseT

Constructors

ClientStreamingCallable()

protected ClientStreamingCallable()

Methods

clientStreamingCall(ApiStreamObserver<ResponseT> responseObserver)

public ApiStreamObserver<RequestT> clientStreamingCall(ApiStreamObserver<ResponseT> responseObserver)

Conduct a client streaming call

Parameter
NameDescription
responseObserverApiStreamObserver<ResponseT>

ApiStreamObserver to receive the non-streaming response.

Returns
TypeDescription
ApiStreamObserver<RequestT>

ApiStreamObserver which is used for making streaming requests.

clientStreamingCall(ApiStreamObserver<ResponseT> responseObserver, ApiCallContext context)

public abstract ApiStreamObserver<RequestT> clientStreamingCall(ApiStreamObserver<ResponseT> responseObserver, ApiCallContext context)

Conduct a client streaming call with the given ApiCallContext

Parameters
NameDescription
responseObserverApiStreamObserver<ResponseT>

ApiStreamObserver to receive the non-streaming response.

contextApiCallContext

ApiCallContext to provide context information for the RPC call.

Returns
TypeDescription
ApiStreamObserver<RequestT>

ApiStreamObserver which is used for making streaming requests.

withDefaultCallContext(ApiCallContext defaultCallContext)

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

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

Parameter
NameDescription
defaultCallContextApiCallContext

the default ApiCallContext.

Returns
TypeDescription
ClientStreamingCallable<RequestT,ResponseT>