com.google.api.gax.retrying

Class SimpleStreamResumptionStrategy<RequestT,ResponseT>

java.lang.Object

com.google.api.gax.retrying.SimpleStreamResumptionStrategy<RequestT,ResponseT>

All Implemented Interfaces:

StreamResumptionStrategy<RequestT,ResponseT>

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

Simplest implementation of a StreamResumptionStrategy which returns the initial request for unstarted streams.

Constructor Summary

Constructors

Constructor and Description
SimpleStreamResumptionStrategy()

Method Summary

Modifier and Type	Method and Description
boolean	canResume() If a resume request can be created.
StreamResumptionStrategy<RequestT,ResponseT>	createNew() Creates a new instance of this StreamResumptionStrategy without accumulated state
RequestT	getResumeRequest(RequestT originalRequest) Called when a stream needs to be restarted, the implementation should generate a request that will yield a new stream whose first response would come right after the last response received by processResponse.
ResponseT	processResponse(ResponseT response) Called by the ServerStreamingAttemptCallable when a response has been successfully received.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleStreamResumptionStrategy

public SimpleStreamResumptionStrategy()

Method Detail

createNew

public StreamResumptionStrategy<RequestT,ResponseT> createNew()

Description copied from interface: StreamResumptionStrategy

Creates a new instance of this StreamResumptionStrategy without accumulated state

Specified by:

createNew in interface StreamResumptionStrategy<RequestT,ResponseT>

processResponse

public ResponseT processResponse(ResponseT response)

Description copied from interface: StreamResumptionStrategy

Called by the ServerStreamingAttemptCallable when a response has been successfully received. This method accomplishes two goals:

1. It allows the strategy implementation to update its internal state so that it can compose the resume request
2. It allows the strategy to alter the incoming responses to adjust for after resume. For example, if the responses are numbered sequentially from the start of the stream, upon resume, the strategy could rewrite the messages to continue the sequence from where it left off. Please note that all messages (even for the first attempt) will be passed through this method.

Specified by:

processResponse in interface StreamResumptionStrategy<RequestT,ResponseT>

getResumeRequest

public RequestT getResumeRequest(RequestT originalRequest)

Description copied from interface: StreamResumptionStrategy

Called when a stream needs to be restarted, the implementation should generate a request that will yield a new stream whose first response would come right after the last response received by processResponse.

Specified by:

getResumeRequest in interface StreamResumptionStrategy<RequestT,ResponseT>

Returns:

A request that can be used to resume the stream.

canResume

public boolean canResume()

Description copied from interface: StreamResumptionStrategy

If a resume request can be created.

Specified by:

canResume in interface StreamResumptionStrategy<RequestT,ResponseT>