com.google.api.gax.rpc

Class BidiStreamingCallable<RequestT,ResponseT>

java.lang.Object

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

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

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

It is considered advanced usage for a user to create a BidiStreamingCallable 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	BidiStreamingCallable()

Method Summary

Modifier and Type	Method and Description
ApiStreamObserver<RequestT>	bidiStreamingCall(ApiStreamObserver<ResponseT> responseObserver) Conduct a bidirectional streaming call
abstract ApiStreamObserver<RequestT>	bidiStreamingCall(ApiStreamObserver<ResponseT> responseObserver, ApiCallContext context) Conduct a bidirectional streaming call with the given ApiCallContext.
BidiStreamingCallable<RequestT,ResponseT>	withDefaultCallContext(ApiCallContext defaultCallContext) Returns a new BidiStreamingCallable 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

BidiStreamingCallable

protected BidiStreamingCallable()

Method Detail

bidiStreamingCall

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

Conduct a bidirectional streaming call with the given ApiCallContext.

Parameters:

responseObserver - ApiStreamObserver to observe the streaming responses

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

Returns:

ApiStreamObserver which is used for making streaming requests.

bidiStreamingCall

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

Conduct a bidirectional streaming call

Parameters:

responseObserver - ApiStreamObserver to observe the streaming responses

Returns:

ApiStreamObserver which is used for making streaming requests.

withDefaultCallContext

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

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

Parameters:

defaultCallContext - the default ApiCallContext.