com.google.api.gax.tracing

Class TracedServerStreamingCallable<RequestT,ResponseT>

java.lang.Object

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

com.google.api.gax.tracing.TracedServerStreamingCallable<RequestT,ResponseT>

@BetaApi(value="The surface for tracing is not stable and might change in the future")
 @InternalApi(value="For internal use by google-cloud-java clients only")
public final class TracedServerStreamingCallable<RequestT,ResponseT>
extends ServerStreamingCallable<RequestT,ResponseT>

A wrapper callable that will wrap a callable chain in a trace.

For internal use only.

Constructor Summary

Constructors

Constructor and Description
TracedServerStreamingCallable(ServerStreamingCallable<RequestT,ResponseT> innerCallable, ApiTracerFactory tracerFactory, SpanName spanName)

Method Summary

Modifier and Type	Method and Description
UnaryCallable<RequestT,List<ResponseT>>	all() Construct a UnaryCallable that will buffer the entire stream into memory before completing.
void	call(RequestT request, ResponseObserver<ResponseT> responseObserver, ApiCallContext context) Conduct a server streaming call with the given ApiCallContext.
UnaryCallable<RequestT,ResponseT>	first() Construct a UnaryCallable that will yield the first item in the stream and cancel it.

Methods inherited from class com.google.api.gax.rpc.ServerStreamingCallable

blockingServerStreamingCall, blockingServerStreamingCall, call, call, call, serverStreamingCall, serverStreamingCall, withDefaultCallContext

Methods inherited from class java.lang.Object

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

Constructor Detail

TracedServerStreamingCallable

public TracedServerStreamingCallable(@Nonnull
                                     ServerStreamingCallable<RequestT,ResponseT> innerCallable,
                                     @Nonnull
                                     ApiTracerFactory tracerFactory,
                                     @Nonnull
                                     SpanName spanName)

Method Detail

call

public void call(RequestT request,
                 ResponseObserver<ResponseT> responseObserver,
                 ApiCallContext context)

Description copied from class: ServerStreamingCallable

Conduct a server streaming call with the given ApiCallContext.

Specified by:

call in class ServerStreamingCallable<RequestT,ResponseT>

Parameters:

request - request

responseObserver - ResponseObserver to observe the streaming responses

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

first

public UnaryCallable<RequestT,ResponseT> first()

Description copied from class: ServerStreamingCallable

Construct a UnaryCallable that will yield the first item in the stream and cancel it. If the stream is empty, the item will be null.

Example usage:

 StreamingCallable<String> streamingCallable = // ..
 String theResult = streamingCallable.first().call(request);
 ApiFuture<String> theResult = streamingCallable.first().futureCall(request);
 

Overrides:

first in class ServerStreamingCallable<RequestT,ResponseT>

Returns:

The UnaryCallable.

all

public UnaryCallable<RequestT,List<ResponseT>> all()

Description copied from class: ServerStreamingCallable

Construct a UnaryCallable that will buffer the entire stream into memory before completing. If the stream is empty, then the list will be empty.

Example usage:

 StreamingCallable<String> streamingCallable = // ..
 List<String> theResult = streamingCallable.all().call(request);
 ApiFuture<List<String>> theResult = streamingCallable.all().futureCall(request);
 

Overrides:

all in class ServerStreamingCallable<RequestT,ResponseT>

Returns:

The UnaryCallable.