This repository has been archived by the owner on Sep 26, 2023. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: allow client authors to create their own callable chains (#891)
* feat: allow client authors to create their own callable chains * fix year
- Loading branch information
1 parent
8a203e1
commit 763aafb
Showing
2 changed files
with
128 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
120 changes: 120 additions & 0 deletions
120
gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcRawCallableFactory.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| /* | ||
| * Copyright 2020 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.core.BetaApi; | ||
| import com.google.api.core.InternalApi; | ||
| import com.google.api.gax.rpc.BidiStreamingCallable; | ||
| import com.google.api.gax.rpc.ClientStreamingCallable; | ||
| import com.google.api.gax.rpc.ServerStreamingCallable; | ||
| import com.google.api.gax.rpc.StatusCode; | ||
| import com.google.api.gax.rpc.UnaryCallable; | ||
| import java.util.Set; | ||
|
|
||
| /** Class with utility methods to create low level grpc-based direct callables. */ | ||
| @InternalApi("For internal use by google-cloud-java clients only") | ||
| public class GrpcRawCallableFactory { | ||
| private GrpcRawCallableFactory() {} | ||
|
|
||
| /** | ||
| * Create a Unary callable object with minimal grpc-specific functionality. | ||
| * | ||
| * @param grpcCallSettings the gRPC call settings | ||
| * @param retryableCodes the {@link StatusCode.Code} that should be marked as retryable | ||
| */ | ||
| public static <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createUnaryCallable( | ||
| GrpcCallSettings<RequestT, ResponseT> grpcCallSettings, Set<StatusCode.Code> retryableCodes) { | ||
| UnaryCallable<RequestT, ResponseT> callable = | ||
| new GrpcDirectCallable<>(grpcCallSettings.getMethodDescriptor()); | ||
| if (grpcCallSettings.getParamsExtractor() != null) { | ||
| callable = | ||
| new GrpcUnaryRequestParamCallable<>(callable, grpcCallSettings.getParamsExtractor()); | ||
| } | ||
| return new GrpcExceptionCallable<>(callable, retryableCodes); | ||
| } | ||
|
|
||
| /** | ||
| * Create a bidirectional streaming callable object with grpc-specific functionality. Designed for | ||
| * use by generated code. | ||
| * | ||
| * @param grpcCallSettings the gRPC call settings | ||
| * @param retryableCodes the {@link StatusCode.Code} that should be marked as retryable | ||
| * @return {@link BidiStreamingCallable} callable object. | ||
| */ | ||
| @BetaApi("The surface for streaming is not stable yet and may change in the future.") | ||
| public static <RequestT, ResponseT> | ||
| BidiStreamingCallable<RequestT, ResponseT> createBidiStreamingCallable( | ||
| GrpcCallSettings<RequestT, ResponseT> grpcCallSettings, | ||
| Set<StatusCode.Code> retryableCodes) { | ||
| BidiStreamingCallable<RequestT, ResponseT> callable = | ||
| new GrpcDirectBidiStreamingCallable<>(grpcCallSettings.getMethodDescriptor()); | ||
|
|
||
| return new GrpcExceptionBidiStreamingCallable<>(callable, retryableCodes); | ||
| } | ||
|
|
||
| /** | ||
| * Create a server-streaming callable with grpc-specific functionality. Designed for use by | ||
| * generated code. | ||
| * | ||
| * @param grpcCallSettings the gRPC call settings | ||
| * @param retryableCodes the {@link StatusCode.Code} that should be marked as retryable | ||
| */ | ||
| @BetaApi("The surface for streaming is not stable yet and may change in the future.") | ||
| public static <RequestT, ResponseT> | ||
| ServerStreamingCallable<RequestT, ResponseT> createServerStreamingCallable( | ||
| GrpcCallSettings<RequestT, ResponseT> grpcCallSettings, | ||
| Set<StatusCode.Code> retryableCodes) { | ||
| ServerStreamingCallable<RequestT, ResponseT> callable = | ||
| new GrpcDirectServerStreamingCallable<>(grpcCallSettings.getMethodDescriptor()); | ||
| if (grpcCallSettings.getParamsExtractor() != null) { | ||
| callable = | ||
| new GrpcServerStreamingRequestParamCallable<>( | ||
| callable, grpcCallSettings.getParamsExtractor()); | ||
| } | ||
| return new GrpcExceptionServerStreamingCallable<>(callable, retryableCodes); | ||
| } | ||
| /** | ||
| * Create a client-streaming callable object with grpc-specific functionality. Designed for use by | ||
| * generated code. | ||
| * | ||
| * @param grpcCallSettings the gRPC call settings | ||
| * @param retryableCodes the {@link StatusCode.Code} that should be marked as retryable | ||
| */ | ||
| @BetaApi("The surface for streaming is not stable yet and may change in the future.") | ||
| public static <RequestT, ResponseT> | ||
| ClientStreamingCallable<RequestT, ResponseT> createClientStreamingCallable( | ||
| GrpcCallSettings<RequestT, ResponseT> grpcCallSettings, | ||
| Set<StatusCode.Code> retryableCodes) { | ||
| ClientStreamingCallable<RequestT, ResponseT> callable = | ||
| new GrpcDirectClientStreamingCallable<>(grpcCallSettings.getMethodDescriptor()); | ||
|
|
||
| return new GrpcExceptionClientStreamingCallable<>(callable, retryableCodes); | ||
| } | ||
| } |