com.google.api.gax.grpc.GrpcCallSettings 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
Google Api eXtensions for Java (gRPC)
There is a newer version: 2.58.0
/*
 * Copyright 2017 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.gax.rpc.RequestMutator;
import com.google.api.gax.rpc.RequestParamsExtractor;
import io.grpc.MethodDescriptor;

/** Grpc-specific settings for creating callables. */
public class GrpcCallSettings {
  private final MethodDescriptor methodDescriptor;
  private final RequestParamsExtractor paramsExtractor;
  private final RequestMutator requestMutator;
  private final boolean alwaysAwaitTrailers;

  private GrpcCallSettings(Builder builder) {
    this.methodDescriptor = builder.methodDescriptor;
    this.paramsExtractor = builder.paramsExtractor;
    this.requestMutator = builder.requestMutator;
    this.alwaysAwaitTrailers = builder.shouldAwaitTrailers;
  }

  public MethodDescriptor getMethodDescriptor() {
    return methodDescriptor;
  }

  public RequestParamsExtractor getParamsExtractor() {
    return paramsExtractor;
  }

  public RequestMutator getRequestMutator() {
    return requestMutator;
  }

  @BetaApi
  public boolean shouldAwaitTrailers() {
    return alwaysAwaitTrailers;
  }

  public static  Builder newBuilder() {
    return new Builder().setShouldAwaitTrailers(true);
  }

  public static  GrpcCallSettings create(
      MethodDescriptor methodDescriptor) {
    return GrpcCallSettings.newBuilder()
        .setMethodDescriptor(methodDescriptor)
        .build();
  }

  public Builder toBuilder() {
    return new Builder<>(this);
  }

  public static class Builder {
    private MethodDescriptor methodDescriptor;
    private RequestParamsExtractor paramsExtractor;

    private RequestMutator requestMutator;
    private boolean shouldAwaitTrailers;

    private Builder() {}

    private Builder(GrpcCallSettings settings) {
      this.methodDescriptor = settings.methodDescriptor;
      this.paramsExtractor = settings.paramsExtractor;
      this.requestMutator = settings.requestMutator;
      this.shouldAwaitTrailers = settings.alwaysAwaitTrailers;
    }

    public Builder setMethodDescriptor(
        MethodDescriptor methodDescriptor) {
      this.methodDescriptor = methodDescriptor;
      return this;
    }

    public Builder setParamsExtractor(
        RequestParamsExtractor paramsExtractor) {
      this.paramsExtractor = paramsExtractor;
      return this;
    }

    public Builder setRequestMutator(RequestMutator requestMutator) {
      this.requestMutator = requestMutator;
      return this;
    }

    @BetaApi
    public Builder setShouldAwaitTrailers(boolean b) {
      this.shouldAwaitTrailers = b;
      return this;
    }

    public GrpcCallSettings build() {
      return new GrpcCallSettings<>(this);
    }
  }
}