Capture DatabricksError when retrying API calls.

Author: iamthomaspowell

.release_metadata.json

@@ -1,3 +1,3 @@
 {
-    "timestamp": "2025-03-26 13:43:47+0000"
+    "timestamp": "2025-04-10 13:35:44+0000"
 }

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Version changelog
 
+## Release v0.44.0
+
+### Bug Fixes
+* Fix issue deserializing HTTP responses with an empty body ([#426](https://github.com/databricks/databricks-sdk-java/pull/426)).
+
+
 ## Release v0.43.0
 
 ### API Changes

NEXT_CHANGELOG.md

@@ -1,14 +1,14 @@
 # NEXT CHANGELOG
 
-## Release v0.44.0
+## Release v0.45.0
 
 ### New Features and Improvements
 
 ### Bug Fixes
-* Fix issue deserializing HTTP responses with an empty body ([#426](https://github.com/databricks/databricks-sdk-java/pull/426)).
 
 ### Documentation
 
 ### Internal Changes
+* Capture DatabricksError when retrying API calls ([#427](https://github.com/databricks/databricks-sdk-java/pull/427)).
 
 ### API Changes

databricks-sdk-java/pom.xml

@@ -5,7 +5,7 @@
   <parent>
     <groupId>com.databricks</groupId>
     <artifactId>databricks-sdk-parent</artifactId>
-    <version>0.43.0</version>
+    <version>0.44.0</version>
   </parent>
   <artifactId>databricks-sdk-java</artifactId>
   <properties>

databricks-sdk-java/src/main/java/com/databricks/sdk/core/ApiClient.java

@@ -15,6 +15,7 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.JavaType;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.google.common.base.Strings;
 import java.io.IOException;
 import java.io.InputStream;
 import java.lang.reflect.Field;
@@ -219,7 +220,7 @@ private Response executeInner(Request in, String path) {
       // after the first invocation to config.authenticate()
       String userAgent = UserAgent.asString();
       String authType = getAuthTypeFunc.apply(null);
-      if (authType != "") {
+      if (!Strings.isNullOrEmpty(authType)) {
         userAgent += String.format(" auth/%s", authType);
       }
       in.withHeader("User-Agent", userAgent);
@@ -247,12 +248,13 @@ private Response executeInner(Request in, String path) {
       }
       if (attemptNumber == maxAttempts) {
         throw new DatabricksException(
-            String.format("Request %s failed after %d retries", in, maxAttempts), err);
+            String.format("Request %s failed after %d retries", in, maxAttempts), databricksError);
       }
 
       // Retry after a backoff.
       long sleepMillis = getBackoffMillis(out, attemptNumber);
-      LOG.debug(String.format("Retry %s in %dms", in.getRequestLine(), sleepMillis));
+      LOG.debug(
+          String.format("Retry %s in %dms", in.getRequestLine(), sleepMillis), databricksError);
       try {
         timer.sleep(sleepMillis);
       } catch (InterruptedException ex) {

databricks-sdk-java/src/main/java/com/databricks/sdk/core/DatabricksConfig.java

@@ -374,13 +374,17 @@ public DatabricksConfig setAzureUseMsi(boolean azureUseMsi) {
     return this;
   }
 
-  /** @deprecated Use {@link #getAzureUseMsi()} instead. */
+  /**
+   * @deprecated Use {@link #getAzureUseMsi()} instead.
+   */
   @Deprecated()
   public boolean getAzureUseMSI() {
     return azureUseMsi;
   }
 
-  /** @deprecated Use {@link #setAzureUseMsi(boolean)} instead. */
+  /**
+   * @deprecated Use {@link #setAzureUseMsi(boolean)} instead.
+   */
   @Deprecated
   public DatabricksConfig setAzureUseMSI(boolean azureUseMsi) {
     this.azureUseMsi = azureUseMsi;

databricks-sdk-java/src/main/java/com/databricks/sdk/core/UserAgent.java

@@ -36,7 +36,7 @@ public String getValue() {
   // TODO: check if reading from
   // /META-INF/maven/com.databricks/databrics-sdk-java/pom.properties
   // or getClass().getPackage().getImplementationVersion() is enough.
-  private static final String version = "0.43.0";
+  private static final String version = "0.44.0";
 
   public static void withProduct(String product, String productVersion) {
     UserAgent.product = product;

databricks-sdk-java/src/test/java/com/databricks/sdk/core/ApiClientTest.java

@@ -11,6 +11,7 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import java.io.IOException;
 import java.net.MalformedURLException;
 import java.net.URL;
@@ -88,12 +89,13 @@ private <T> void runApiClientTest(
     runApiClientTest(client, request, clazz, expectedResponse);
   }
 
-  private void runFailingApiClientTest(
-      Request request, List<ResponseProvider> responses, Class<?> clazz, String expectedMessage)
-      throws IOException {
+  @CanIgnoreReturnValue
+  private DatabricksException runFailingApiClientTest(
+      Request request, List<ResponseProvider> responses, Class<?> clazz, String expectedMessage) {
     DatabricksException exception =
         runFailingApiClientTest(request, responses, clazz, DatabricksException.class);
     assertEquals(exception.getMessage(), expectedMessage);
+    return exception;
   }
 
   private <T extends Throwable> T runFailingApiClientTest(
@@ -217,16 +219,21 @@ void retry429() throws IOException {
   @Test
   void failAfterTooManyRetries() throws IOException {
     Request req = getBasicRequest();
-    runFailingApiClientTest(
-        req,
-        Arrays.asList(
-            getTooManyRequestsResponseWithRetryAfterDateHeader(req),
-            getTooManyRequestsResponse(req),
-            getTooManyRequestsResponse(req),
-            getTooManyRequestsResponse(req),
-            getSuccessResponse(req)),
-        MyEndpointResponse.class,
-        "Request GET /api/my/endpoint failed after 4 retries");
+    DatabricksException exception =
+        runFailingApiClientTest(
+            req,
+            Arrays.asList(
+                getTooManyRequestsResponseWithRetryAfterDateHeader(req),
+                getTooManyRequestsResponse(req),
+                getTooManyRequestsResponse(req),
+                getTooManyRequestsResponse(req),
+                getSuccessResponse(req)),
+            MyEndpointResponse.class,
+            "Request GET /api/my/endpoint failed after 4 retries");
+    assertInstanceOf(DatabricksError.class, exception.getCause());
+    DatabricksError cause = (DatabricksError) exception.getCause();
+    assertEquals(cause.getErrorCode(), "TOO_MANY_REQUESTS");
+    assertEquals(cause.getStatusCode(), 429);
   }
 
   @Test

examples/docs/pom.xml

@@ -24,7 +24,7 @@
     <dependency>
       <groupId>com.databricks</groupId>
       <artifactId>databricks-sdk-java</artifactId>
-      <version>0.43.0</version>
+      <version>0.44.0</version>
     </dependency>
   </dependencies>
 </project>

examples/spring-boot-oauth-u2m-demo/pom.xml

@@ -37,7 +37,7 @@
     <dependency>
       <groupId>com.databricks</groupId>
       <artifactId>databricks-sdk-java</artifactId>
-      <version>0.43.0</version>
+      <version>0.44.0</version>
     </dependency>
     <dependency>
       <groupId>com.fasterxml.jackson.datatype</groupId>