com.google.api.gax.rpc

Class ClientStreamingCallable<RequestT,ResponseT>

java.lang.Object

com.google.api.gax.rpc.ClientStreamingCallable<RequestT,ResponseT>

Direct Known Subclasses:

TracedClientStreamingCallable

@BetaApi(value="The surface for streaming is not stable yet and may change in the future.")
public abstract class ClientStreamingCallable<RequestT,ResponseT>
extends Object

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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientStreamingCallable()

Method Summary

Modifier and Type	Method and Description
ApiStreamObserver<RequestT>	clientStreamingCall(ApiStreamObserver<ResponseT> responseObserver) Conduct a client streaming call
abstract ApiStreamObserver<RequestT>	clientStreamingCall(ApiStreamObserver<ResponseT> responseObserver, ApiCallContext context) Conduct a client streaming call with the given ApiCallContext
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientStreamingCallable

protected ClientStreamingCallable()

Method Detail

clientStreamingCall

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

Conduct a client streaming call with the given ApiCallContext

Parameters:

responseObserver - ApiStreamObserver to receive the non-streaming response.

context - ApiCallContext to provide context information for the RPC call.

Returns:

ApiStreamObserver which is used for making streaming requests.

clientStreamingCall

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

Conduct a client streaming call

Parameters:

responseObserver - ApiStreamObserver to receive the non-streaming response.

Returns:

ApiStreamObserver which is used for making streaming requests.

withDefaultCallContext

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.

Parameters:

defaultCallContext - the default ApiCallContext.