docs: [vertexai] Update javadoc of VertexAI and Transport. (#10296)

copybara-service[bot] · Zhenyi Qi · web-flow · commit 2729b0b0f82b · 2024-01-31T11:08:19.000-05:00
PiperOrigin-RevId: 602404969

Co-authored-by: Zhenyi Qi &lt;zhenyiqi@google.com&gt;
diff --git a/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/Transport.java b/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/Transport.java
@@ -18,6 +18,11 @@
 
 /** Transport used for sending request. */
 public enum Transport {
+  /** When used, the clients will send REST requests to the backing service. */
   REST,
+  /**
+   * When used, the clients will send gRPC to the backing service. This is usually more efficient
+   * and is the default transport.
+   */
   GRPC
 }
diff --git a/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/VertexAI.java b/java-vertexai/google-cloud-vertexai/src/main/java/com/google/cloud/vertexai/VertexAI.java
@@ -123,27 +123,48 @@ public VertexAI(String projectId, String location, Transport transport, String..
     this.transport = transport;
   }
 
-  /** Returns the default {@link Transport} layer to use to send API requests. */
+  /**
+   * Returns the default {@link Transport} layer to use to send API requests.
+   *
+   * @return {@link Transport} layer used when sending API requests.
+   */
   public Transport getTransport() {
     return this.transport;
   }
 
-  /** Returns the default project to use when making API calls. */
+  /**
+   * Returns the default project to use when making API calls.
+   *
+   * @return Project ID in string format.
+   */
   public String getProjectId() {
     return this.projectId;
   }
 
-  /** Returns the default location to use when making API calls. */
+  /**
+   * Returns the default location to use when making API calls.
+   *
+   * @return Location in string format.
+   */
   public String getLocation() {
     return this.location;
   }
 
-  /** Returns the default endpoint to use when making API calls. */
+  /**
+   * Returns the default endpoint to use when making API calls.
+   *
+   * @return API endpoint in string format.
+   */
   public String getApiEndpoint() {
     return this.apiEndpoint;
   }
 
-  /** Returns the default credentials to use when making API calls. */
+  /**
+   * Returns the default credentials to use when making API calls.
+   *
+   * @return {@link Credentials} if the user has provided either scopes or credentials to the
+   *     VertexAI object.
+   */
   public Credentials getCredentials() throws IOException {
     return credentialsProvider.getCredentials();
   }
@@ -211,6 +232,9 @@ public PredictionServiceClient getPredictionServiceClient() throws IOException {
   /**
    * Returns the {@link PredictionServiceClient} with REST. The client will be instantiated when the
    * first prediction API call is made.
+   *
+   * @return {@link PredictionServiceClient} that send REST requests to the backing service through
+   *     method calls that map to the API methods.
    */
   public PredictionServiceClient getPredictionServiceRestClient() throws IOException {
     if (predictionServiceRestClient == null) {
@@ -240,8 +264,11 @@ public PredictionServiceClient getPredictionServiceRestClient() throws IOExcepti
   }
 
   /**
-   * Returns the {@link PredictionServiceClient} with GRPC. The client will be instantiated when the
+   * Returns the {@link LlmUtilityServiceClient} with GRPC. The client will be instantiated when the
    * first prediction API call is made.
+   *
+   * @return {@link LlmUtilityServiceClient} that makes gRPC calls to the backing service through
+   *     method calls that map to the API methods.
    */
   public LlmUtilityServiceClient getLlmUtilityClient() throws IOException {
     if (llmUtilityClient == null) {
@@ -270,8 +297,11 @@ public LlmUtilityServiceClient getLlmUtilityClient() throws IOException {
   }
 
   /**
-   * Returns the {@link PredictionServiceClient} with GRPC. The client will be instantiated when the
+   * Returns the {@link LlmUtilityServiceClient} with REST. The client will be instantiated when the
    * first prediction API call is made.
+   *
+   * @return {@link LlmUtilityServiceClient} that makes REST requests to the backing service through
+   *     method calls that map to the API methods.
    */
   public LlmUtilityServiceClient getLlmUtilityRestClient() throws IOException {
     if (llmUtilityRestClient == null) {
