com.google.api.gax.rpc

Class ServerStreamingCallable<RequestT,ResponseT>

java.lang.Object

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

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

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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServerStreamingCallable()

Method Summary

Modifier and Type	Method and Description
Iterator<ResponseT>	blockingServerStreamingCall(RequestT request)
abstract Iterator<ResponseT>	blockingServerStreamingCall(RequestT request, ApiCallContext context) Conduct a iteration server streaming call
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.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerStreamingCallable

protected ServerStreamingCallable()

Method Detail

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)

withDefaultCallContext

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.

Parameters:

defaultCallContext - the default ApiCallContext.