chore: Add javadocs for universe domain

googleapis · Jan 2, 2024 · 3d3d7a5 · 3d3d7a5
1 parent 653db8e
commit 3d3d7a5
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/gax-java/gax/src/main/java/com/google/api/gax/rpc/EndpointContext.java b/gax-java/gax/src/main/java/com/google/api/gax/rpc/EndpointContext.java
@@ -51,6 +51,12 @@ public abstract class EndpointContext {
   @Nullable
   public abstract String serviceName();
 
+  /**
+   * Universe Domain is the domain for Google Cloud Services. It follows the format of
+   * `{ServiceName}.{UniverseDomain}`. For example, speech.googleapis.com would have a Universe
+   * Domain value of `googleapis.com` and cloudasset.test.com would have a Universe Domain of
+   * `test.com`. If this value is not set, this will default to `googleapis.com`.
+   */
   @Nullable
   public abstract String universeDomain();
 
@@ -98,6 +104,12 @@ public abstract static class Builder {
      */
     public abstract Builder setServiceName(String serviceName);
 
+    /**
+     * Universe Domain is the domain for Google Cloud Services. It follows the format of
+     * `{ServiceName}.{UniverseDomain}`. For example, speech.googleapis.com would have a Universe
+     * Domain value of `googleapis.com` and cloudasset.test.com would have a Universe Domain of
+     * `test.com`. If this value is not set, this will default to `googleapis.com`.
+     */
     public abstract Builder setUniverseDomain(String universeDomain);
 
     /**