com.google.api.gax.rpc

Class StreamingCallable<RequestT,ResponseT>

java.lang.Object

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

Direct Known Subclasses:

EntryPointStreamingCallable, FakeStreamingApi.StreamingStashCallable

@BetaApi
public abstract class StreamingCallable<RequestT,ResponseT>
extends Object

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

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

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.
Iterator<ResponseT>	blockingServerStreamingCall(RequestT request)
abstract Iterator<ResponseT>	blockingServerStreamingCall(RequestT request, ApiCallContext context) Conduct a iteration server streaming call
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
void	serverStreamingCall(RequestT request, ApiStreamObserver<ResponseT> responseObserver) Conduct a server streaming call
abstract void	serverStreamingCall(RequestT request, ApiStreamObserver<ResponseT> responseObserver, ApiCallContext context) Conduct a server streaming call with the given ApiCallContext.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamingCallable

protected StreamingCallable()

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.

serverStreamingCall

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

Conduct a server streaming call with the given ApiCallContext.

Parameters:

request - request

responseObserver - ApiStreamObserver to observe the streaming responses

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

serverStreamingCall

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

Conduct a server streaming call

Parameters:

request - request

responseObserver - ApiStreamObserver to observe the streaming responses

blockingServerStreamingCall

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

Conduct a iteration server streaming call

Parameters:

request - request

Returns:

Iterator which is used for iterating the responses.

blockingServerStreamingCall

public Iterator<ResponseT> blockingServerStreamingCall(RequestT request)

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.