nl.topicus.jdbc.shaded.com.google.api.gax.rpc.BidiStreamingCallable Maven / Gradle / Ivy
/*
* Copyright 2017, Google LLC All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google LLC nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package nl.topicus.jdbc.shaded.com.google.api.gax.rpc;
import nl.topicus.jdbc.shaded.com.google.api.core.BetaApi;
/**
* A BidiStreamingCallable is an immutable object which is capable of making RPC calls to
* bidirectional streaming API methods. Not all transports support streaming.
*
* It is considered advanced usage for a user to create a BidiStreamingCallable 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.
*/
@BetaApi("The surface for streaming is not stable yet and may change in the future.")
public abstract class BidiStreamingCallable {
protected BidiStreamingCallable() {}
/**
* Conduct a bidirectional streaming call with the given {@link ApiCallContext}.
*
* @param responseObserver {@link ApiStreamObserver} to observe the streaming responses
* @param context {@link ApiCallContext} to provide context information for the RPC call.
* @return {@link ApiStreamObserver} which is used for making streaming requests.
*/
public abstract ApiStreamObserver bidiStreamingCall(
ApiStreamObserver responseObserver, ApiCallContext context);
/**
* Conduct a bidirectional streaming call
*
* @param responseObserver {@link ApiStreamObserver} to observe the streaming responses
* @return {@link ApiStreamObserver} which is used for making streaming requests.
*/
public ApiStreamObserver bidiStreamingCall(
ApiStreamObserver responseObserver) {
return bidiStreamingCall(responseObserver, null);
}
/**
* Returns a new {@code BidiStreamingCallable} with an {@link ApiCallContext} that is used as a
* default when none is supplied in individual calls.
*
* @param defaultCallContext the default {@link ApiCallContext}.
*/
public BidiStreamingCallable withDefaultCallContext(
final ApiCallContext defaultCallContext) {
return new BidiStreamingCallable() {
@Override
public ApiStreamObserver bidiStreamingCall(
ApiStreamObserver responseObserver, ApiCallContext thisCallContext) {
return BidiStreamingCallable.this.bidiStreamingCall(
responseObserver, defaultCallContext.merge(thisCallContext));
}
};
}
}