Adding docs and missing @BetaApi annotations (#391)

garrettjonesgoogle · web-flow · commit 790af1c3f2fd · 2017-10-25T09:33:22.000-07:00
diff --git a/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcCallableFactory.java b/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcCallableFactory.java
@@ -72,7 +72,6 @@ private static <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createBa
    *
    * @param grpcCallSettings the gRPC call settings
    */
-  @BetaApi
   public static <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createUnaryCallable(
       GrpcCallSettings<RequestT, ResponseT> grpcCallSettings,
       UnaryCallSettings<RequestT, ResponseT> callSettings,
diff --git a/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcExtraHeaderData.java b/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcExtraHeaderData.java
@@ -29,10 +29,12 @@
  */
 package com.google.api.gax.grpc;
 
+import com.google.api.core.BetaApi;
 import java.util.Collections;
 import java.util.List;
 
 /** This class provides grpc-specific data to put on the x-goog-api-client header. */
+@BetaApi
 public class GrpcExtraHeaderData {
 
   private GrpcExtraHeaderData() {}
diff --git a/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcLongRunningClient.java b/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcLongRunningClient.java
@@ -41,8 +41,12 @@
 import com.google.longrunning.stub.OperationsStub;
 import com.google.protobuf.Empty;
 
-/** Implementation of LongRunningClient based on gRPC. */
-public class GrpcLongRunningClient implements LongRunningClient {
+/**
+ * Implementation of LongRunningClient based on gRPC.
+ *
+ * <p>Package-private for internal usage.
+ */
+class GrpcLongRunningClient implements LongRunningClient {
   private final OperationsStub operationsStub;
 
   public GrpcLongRunningClient(OperationsStub operationsStub) {
diff --git a/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcOperationSnapshot.java b/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcOperationSnapshot.java
@@ -34,8 +34,12 @@
 import com.google.longrunning.Operation;
 import io.grpc.Status;
 
-/** Implementation of OperationSnapshot based on gRPC. */
-public class GrpcOperationSnapshot implements OperationSnapshot {
+/**
+ * Implementation of OperationSnapshot based on gRPC.
+ *
+ * <p>Package-private for internal usage.
+ */
+class GrpcOperationSnapshot implements OperationSnapshot {
 
   private final Operation operation;
 
diff --git a/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcOperationSnapshotCallable.java b/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcOperationSnapshotCallable.java
@@ -37,8 +37,13 @@
 import com.google.api.gax.rpc.UnaryCallable;
 import com.google.longrunning.Operation;
 
-public class GrpcOperationSnapshotCallable<RequestT>
-    extends UnaryCallable<RequestT, OperationSnapshot> {
+/**
+ * A {@code UnaryCallable} that wraps a UnaryCallable returning an Operation and returns an
+ * OperationSnapshot instead.
+ *
+ * <p>Package-private for internal usage.
+ */
+class GrpcOperationSnapshotCallable<RequestT> extends UnaryCallable<RequestT, OperationSnapshot> {
   private final UnaryCallable<RequestT, Operation> innerCallable;
 
   public GrpcOperationSnapshotCallable(UnaryCallable<RequestT, Operation> innerCallable) {
diff --git a/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcOperationTransformers.java b/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcOperationTransformers.java
@@ -38,7 +38,7 @@
 import com.google.protobuf.Message;
 
 /** Package-private for internal use. */
-public class GrpcOperationTransformers {
+class GrpcOperationTransformers {
   private GrpcOperationTransformers() {}
 
   public static class ResponseTransformer<ResponseT extends Message>
diff --git a/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcServerStreamingRequestParamCallable.java b/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcServerStreamingRequestParamCallable.java
@@ -37,7 +37,13 @@
 import com.google.common.base.Preconditions;
 import java.util.Iterator;
 
-public class GrpcServerStreamingRequestParamCallable<RequestT, ResponseT>
+/**
+ * A {@code ServerStreamingCallable} that extracts values from the fields of the request and inserts
+ * them into headers.
+ *
+ * <p>Package-private for internal usage.
+ */
+class GrpcServerStreamingRequestParamCallable<RequestT, ResponseT>
     extends ServerStreamingCallable<RequestT, ResponseT> {
   private final ServerStreamingCallable<RequestT, ResponseT> callable;
   private final RequestUrlParamsEncoder<RequestT> paramsEncoder;
diff --git a/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcUnaryRequestParamCallable.java b/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcUnaryRequestParamCallable.java
@@ -36,7 +36,13 @@
 import com.google.api.gax.rpc.UnaryCallable;
 import com.google.common.base.Preconditions;
 
-public class GrpcUnaryRequestParamCallable<RequestT, ResponseT>
+/**
+ * A {@code UnaryCallable} that extracts values from the fields of the request and inserts them into
+ * headers.
+ *
+ * <p>Package-private for internal usage.
+ */
+class GrpcUnaryRequestParamCallable<RequestT, ResponseT>
     extends UnaryCallable<RequestT, ResponseT> {
   private final UnaryCallable<RequestT, ResponseT> callable;
   private final RequestUrlParamsEncoder<RequestT> paramsEncoder;
diff --git a/gax/src/main/java/com/google/api/gax/rpc/FixedHeaderProvider.java b/gax/src/main/java/com/google/api/gax/rpc/FixedHeaderProvider.java
@@ -29,13 +29,15 @@
  */
 package com.google.api.gax.rpc;
 
+import com.google.api.core.BetaApi;
 import com.google.auto.value.AutoValue;
 import com.google.common.collect.ImmutableMap;
 import java.util.Map;
 import javax.annotation.Nullable;
 
 /** An instance of HeaderProvider that always provides the same headers. */
 @AutoValue
+@BetaApi
 public abstract class FixedHeaderProvider implements HeaderProvider {
 
   @Override
diff --git a/gax/src/main/java/com/google/api/gax/rpc/HeaderProvider.java b/gax/src/main/java/com/google/api/gax/rpc/HeaderProvider.java
@@ -29,9 +29,11 @@
  */
 package com.google.api.gax.rpc;
 
+import com.google.api.core.BetaApi;
 import java.util.Map;
 
 /** Provider of headers to put on http requests. */
+@BetaApi
 public interface HeaderProvider {
 
   /** Get the headers to put on http requests. */
diff --git a/gax/src/main/java/com/google/api/gax/rpc/NoHeaderProvider.java b/gax/src/main/java/com/google/api/gax/rpc/NoHeaderProvider.java
@@ -29,10 +29,12 @@
  */
 package com.google.api.gax.rpc;
 
+import com.google.api.core.BetaApi;
 import java.util.Collections;
 import java.util.Map;
 
 /** Implementation of HeaderProvider that provides empty headers. */
+@BetaApi
 public class NoHeaderProvider implements HeaderProvider {
 
   @Override
diff --git a/gax/src/main/java/com/google/api/gax/rpc/TranslatingUnaryCallable.java b/gax/src/main/java/com/google/api/gax/rpc/TranslatingUnaryCallable.java
@@ -32,10 +32,12 @@
 import com.google.api.core.ApiFunction;
 import com.google.api.core.ApiFuture;
 import com.google.api.core.ApiFutures;
+import com.google.api.core.BetaApi;
 
 /**
  * A UnaryCallable that translates request types and response types using the given transformers.
  */
+@BetaApi
 public class TranslatingUnaryCallable<InnerRequestT, InnerResponseT, OuterRequestT, OuterResponseT>
     extends UnaryCallable<OuterRequestT, OuterResponseT> {
   private final UnaryCallable<InnerRequestT, InnerResponseT> innerUnaryCallable;

Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,6 @@ private static <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createBa`
`72`	`72`	`*`
`73`	`73`	`* @param grpcCallSettings the gRPC call settings`
`74`	`74`	`*/`
`75`		`- @BetaApi`
`76`	`75`	`public static <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createUnaryCallable(`
`77`	`76`	`GrpcCallSettings<RequestT, ResponseT> grpcCallSettings,`
`78`	`77`	`UnaryCallSettings<RequestT, ResponseT> callSettings,`