com.google.api.gax.tracing

Class TracedOperationCallable<RequestT,ResponseT,MetadataT>

java.lang.Object

com.google.api.gax.rpc.OperationCallable<RequestT,ResponseT,MetadataT>

com.google.api.gax.tracing.TracedOperationCallable<RequestT,ResponseT,MetadataT>

@InternalApi(value="For internal use by google-cloud-java clients only")
public class TracedOperationCallable<RequestT,ResponseT,MetadataT>
extends OperationCallable<RequestT,ResponseT,MetadataT>

This callable wraps a OperationCallable in a ApiTracer.

For internal use only.

Constructor Summary

Constructors

Constructor and Description
TracedOperationCallable(OperationCallable<RequestT,ResponseT,MetadataT> innerCallable, ApiTracerFactory tracerFactory, SpanName spanName)

Method Summary

Modifier and Type	Method and Description
com.google.api.core.ApiFuture<Void>	cancel(String operationName, ApiCallContext context) Wrap operation cancellation in a ApiTracerFactory.OperationType.Unary trace.
OperationFuture<ResponseT,MetadataT>	futureCall(RequestT request, ApiCallContext context) Wrap the initial start polling logical operations in a single parent trace using a ApiTracerFactory.OperationType.LongRunning ApiTracer.
OperationFuture<ResponseT,MetadataT>	resumeFutureCall(String operationName, ApiCallContext context) Wrap the polling logical operations in a single parent trace using a ApiTracerFactory.OperationType.LongRunning ApiTracer.

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

call, call, cancel, futureCall, resumeFutureCall, withDefaultCallContext

Methods inherited from class java.lang.Object

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

Constructor Detail

TracedOperationCallable

public TracedOperationCallable(@Nonnull
                               OperationCallable<RequestT,ResponseT,MetadataT> innerCallable,
                               @Nonnull
                               ApiTracerFactory tracerFactory,
                               @Nonnull
                               SpanName spanName)

Method Detail

futureCall

public OperationFuture<ResponseT,MetadataT> futureCall(RequestT request,
                                                       ApiCallContext context)

Wrap the initial start polling logical operations in a single parent trace using a ApiTracerFactory.OperationType.LongRunning ApiTracer.

Specified by:

futureCall in class OperationCallable<RequestT,ResponseT,MetadataT>

Parameters:

request - The request to initiate the operation.

context - ApiCallContext to make the call with

Returns:

OperationFuture for the call result

resumeFutureCall

public OperationFuture<ResponseT,MetadataT> resumeFutureCall(String operationName,
                                                             ApiCallContext context)

Wrap the polling logical operations in a single parent trace using a ApiTracerFactory.OperationType.LongRunning ApiTracer.

Specified by:

resumeFutureCall in class OperationCallable<RequestT,ResponseT,MetadataT>

Parameters:

operationName - The name of the operation to resume.

context - ApiCallContext to make the call with

Returns:

OperationFuture for the call result.

cancel

public com.google.api.core.ApiFuture<Void> cancel(String operationName,
                                                  ApiCallContext context)

Wrap operation cancellation in a ApiTracerFactory.OperationType.Unary trace.

Specified by:

cancel in class OperationCallable<RequestT,ResponseT,MetadataT>

Parameters:

operationName - The name of the operation to cancel.

context - ApiCallContext to make the call with

Returns:

the future which completes once the operation is canceled on the server side.