add javadocs + getTransport -> getAuthTransport.

googleapis · Dec 21, 2024 · 8a2d967 · 8a2d967
1 parent f36a19c
commit 8a2d967
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 9 deletions.
diff --git a/oauth2_http/java/com/google/auth/oauth2/ComputeEngineCredentials.java b/oauth2_http/java/com/google/auth/oauth2/ComputeEngineCredentials.java
@@ -189,7 +189,7 @@ private ComputeEngineCredentials(ComputeEngineCredentials.Builder builder) {
       scopeList.removeAll(Arrays.asList("", null));
       this.scopes = ImmutableSet.<String>copyOf(scopeList);
     }
-    this.transport = builder.getTransport();
+    this.transport = builder.getAuthTransport();
     this.bindingEnforcement = builder.getBindingEnforcement();
   }
 
@@ -735,12 +735,22 @@ public Builder setQuotaProjectId(String quotaProjectId) {
       return this;
     }
 
+    /**
+     * Set the {@code AuthTransport} type.
+     * 
+     * @param transport the transport type over which to authenticate to Google APIs
+     */
     @CanIgnoreReturnValue
-    public Builder setTransport(AuthTransport transport) {
+    public Builder setAuthTransport(AuthTransport transport) {
       this.transport = transport;
       return this;
     }
 
+    /**
+     * Set the {@code BindingEnforcement} type.
+     * 
+     * @param bindingEnforcement the token binding enforcement policy.
+     */
     @CanIgnoreReturnValue
     public Builder setBindingEnforcement(BindingEnforcement bindingEnforcement) {
       this.bindingEnforcement = bindingEnforcement;
@@ -759,10 +769,20 @@ public Collection<String> getDefaultScopes() {
       return defaultScopes;
     }
 
-    public AuthTransport getTransport() {
+    /**
+     * Get the {@code AuthTransport} type.
+     * 
+     * @return the transport type over which to authenticate to Google APIs
+     */
+    public AuthTransport getAuthTransport() {
       return transport;
     }
 
+    /**
+     * Get the {@code BindingEnforcement} type.
+     * 
+     * @return the token binding enforcement policy.
+     */
     public BindingEnforcement getBindingEnforcement() {
       return bindingEnforcement;
     }

diff --git a/oauth2_http/javatests/com/google/auth/oauth2/ComputeEngineCredentialsTest.java b/oauth2_http/javatests/com/google/auth/oauth2/ComputeEngineCredentialsTest.java
@@ -194,7 +194,7 @@ public void buildTokenUrlWithScopes_defaultScopes() {
   public void buildTokenUrl_nullTransport() {
     ComputeEngineCredentials credentials =
         ComputeEngineCredentials.newBuilder()
-            .setTransport(null)
+            .setAuthTransport(null)
             .setBindingEnforcement(ComputeEngineCredentials.BindingEnforcement.ON)
             .build();
     String softBoundTokenUrl = credentials.createTokenUrlWithScopes();
@@ -206,7 +206,7 @@ public void buildTokenUrl_nullTransport() {
   public void buildTokenUrl_nullBindingEnforcement() {
     ComputeEngineCredentials credentials =
         ComputeEngineCredentials.newBuilder()
-            .setTransport(ComputeEngineCredentials.AuthTransport.MTLS)
+            .setAuthTransport(ComputeEngineCredentials.AuthTransport.MTLS)
             .setBindingEnforcement(null)
             .build();
     String softBoundTokenUrl = credentials.createTokenUrlWithScopes();
@@ -218,7 +218,7 @@ public void buildTokenUrl_nullBindingEnforcement() {
   public void buildTokenUrlSoftMtlsBound_mtls_transport() {
     ComputeEngineCredentials credentials =
         ComputeEngineCredentials.newBuilder()
-            .setTransport(ComputeEngineCredentials.AuthTransport.MTLS)
+            .setAuthTransport(ComputeEngineCredentials.AuthTransport.MTLS)
             .build();
     String softBoundTokenUrl = credentials.createTokenUrlWithScopes();
 
@@ -240,7 +240,7 @@ public void buildTokenUrlSoftMtlsBound_iam_enforcement() {
   public void buildTokenUrlSoftMtlsBound_mtls_transport_iam_enforcement() {
     ComputeEngineCredentials credentials =
         ComputeEngineCredentials.newBuilder()
-            .setTransport(ComputeEngineCredentials.AuthTransport.MTLS)
+            .setAuthTransport(ComputeEngineCredentials.AuthTransport.MTLS)
             .setBindingEnforcement(ComputeEngineCredentials.BindingEnforcement.IAM_POLICY)
             .build();
     String softBoundTokenUrl = credentials.createTokenUrlWithScopes();
@@ -263,7 +263,7 @@ public void buildTokenUrlHardMtlsBound_always_enforced() {
   public void buildTokenUrlHardMtlsBound_mtls_transport_always_enforced() {
     ComputeEngineCredentials credentials =
         ComputeEngineCredentials.newBuilder()
-            .setTransport(ComputeEngineCredentials.AuthTransport.MTLS)
+            .setAuthTransport(ComputeEngineCredentials.AuthTransport.MTLS)
             .setBindingEnforcement(ComputeEngineCredentials.BindingEnforcement.ON)
             .build();
     String softBoundTokenUrl = credentials.createTokenUrlWithScopes();
@@ -275,7 +275,7 @@ public void buildTokenUrlHardMtlsBound_mtls_transport_always_enforced() {
   public void buildTokenUrlHardDirectPathBound_alts_transport() {
     ComputeEngineCredentials credentials =
         ComputeEngineCredentials.newBuilder()
-            .setTransport(ComputeEngineCredentials.AuthTransport.ALTS)
+            .setAuthTransport(ComputeEngineCredentials.AuthTransport.ALTS)
             .build();
     String softBoundTokenUrl = credentials.createTokenUrlWithScopes();