com.google.api.gax.grpc.GrpcStubCallableFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gax-grpc Show documentation
Show all versions of gax-grpc Show documentation
Google Api eXtensions for Java (gRPC)
/*
* Copyright 2018 Google LLC
*
* 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 com.google.api.gax.grpc;
import com.google.api.gax.rpc.BatchingCallSettings;
import com.google.api.gax.rpc.BidiStreamingCallable;
import com.google.api.gax.rpc.ClientContext;
import com.google.api.gax.rpc.ClientStreamingCallable;
import com.google.api.gax.rpc.OperationCallSettings;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.PagedCallSettings;
import com.google.api.gax.rpc.ServerStreamingCallSettings;
import com.google.api.gax.rpc.ServerStreamingCallable;
import com.google.api.gax.rpc.StreamingCallSettings;
import com.google.api.gax.rpc.UnaryCallSettings;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.longrunning.Operation;
import com.google.longrunning.stub.OperationsStub;
public interface GrpcStubCallableFactory {
/**
* Create a callable object with grpc-specific functionality. Designed for use by generated code.
*
* @param grpcCallSettings the gRPC call settings
*/
UnaryCallable createUnaryCallable(
GrpcCallSettings grpcCallSettings,
UnaryCallSettings callSettings,
ClientContext clientContext);
/**
* Create a paged callable object that represents a paged API method. Designed for use by
* generated code.
*
* @param grpcCallSettings the gRPC call settings
* @param pagedCallSettings {@link PagedCallSettings} to configure the paged settings with.
* @param clientContext {@link ClientContext} to use to connect to the service.
* @return {@link UnaryCallable} callable object.
*/
UnaryCallable createPagedCallable(
GrpcCallSettings grpcCallSettings,
PagedCallSettings pagedCallSettings,
ClientContext clientContext);
/**
* Create a callable object that represents a batching API method. Designed for use by generated
* code.
*
* @param grpcCallSettings the gRPC call settings
* @param batchingCallSettings {@link BatchingCallSettings} to configure the batching related
* settings with.
* @param clientContext {@link ClientContext} to use to connect to the service.
* @return {@link UnaryCallable} callable object.
*/
UnaryCallable createBatchingCallable(
GrpcCallSettings grpcCallSettings,
BatchingCallSettings batchingCallSettings,
ClientContext clientContext);
/**
* Creates a callable object that represents a long-running operation. Designed for use by
* generated code.
*
* @param grpcCallSettings the gRPC call settings
* @param operationCallSettings {@link OperationCallSettings} to configure the method-level
* settings with.
* @param clientContext {@link ClientContext} to use to connect to the service.
* @param operationsStub {@link OperationsStub} to use to poll for updates on the Operation.
* @return {@link OperationCallable} callable object.
*/
OperationCallable createOperationCallable(
GrpcCallSettings grpcCallSettings,
OperationCallSettings operationCallSettings,
ClientContext clientContext,
OperationsStub operationsStub);
/**
* Create a bidirectional streaming callable object with grpc-specific functionality. Designed for
* use by generated code.
*
* @param grpcCallSettings the gRPC call settings
* @param streamingCallSettings {@link StreamingCallSettings} to configure the method-level
* settings with.
* @param clientContext {@link ClientContext} to use to connect to the service.
* @return {@link BidiStreamingCallable} callable object.
*/
BidiStreamingCallable createBidiStreamingCallable(
GrpcCallSettings grpcCallSettings,
StreamingCallSettings streamingCallSettings,
ClientContext clientContext);
/**
* Create a server-streaming callable with grpc-specific functionality. Designed for use by
* generated code.
*
* @param grpcCallSettings the gRPC call settings
* @param streamingCallSettings {@link StreamingCallSettings} to configure the method-level
* settings with.
* @param clientContext {@link ClientContext} to use to connect to the service.
*/
ServerStreamingCallable createServerStreamingCallable(
GrpcCallSettings grpcCallSettings,
ServerStreamingCallSettings streamingCallSettings,
ClientContext clientContext);
/**
* Create a client-streaming callable object with grpc-specific functionality. Designed for use by
* generated code.
*
* @param grpcCallSettings the gRPC call settings
* @param streamingCallSettings {@link StreamingCallSettings} to configure the method-level
* settings with.
* @param clientContext {@link ClientContext} to use to connect to the service.
* @return {@link ClientStreamingCallable} callable object.
*/
ClientStreamingCallable createClientStreamingCallable(
GrpcCallSettings grpcCallSettings,
StreamingCallSettings streamingCallSettings,
ClientContext clientContext);
}