Better constructor for generated clients (Cloud SDK 5.14.0 update) (#148)

* chore: [DevOps] bump the production-minor-patch group with 3 updates

Bumps the production-minor-patch group with 3 updates: com.sap.cloud.sdk:sdk-bom, com.sap.cloud.sdk.datamodel:openapi-generator-maven-plugin and [com.puppycrawl.tools:checkstyle](https://github.com/checkstyle/checkstyle).


Updates `com.sap.cloud.sdk:sdk-bom` from 5.13.0 to 5.14.0

Updates `com.sap.cloud.sdk.datamodel:openapi-generator-maven-plugin` from 5.13.0 to 5.14.0

Updates `com.puppycrawl.tools:checkstyle` from 10.20.0 to 10.20.1
- [Release notes](https://github.com/checkstyle/checkstyle/releases)
- [Commits](checkstyle/checkstyle@checkstyle-10.20.0...checkstyle-10.20.1)

---
updated-dependencies:
- dependency-name: com.sap.cloud.sdk:sdk-bom
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: production-minor-patch
- dependency-name: com.sap.cloud.sdk.datamodel:openapi-generator-maven-plugin
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: production-minor-patch
- dependency-name: com.puppycrawl.tools:checkstyle
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: production-minor-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

* Used aiSdkConstructor

* Formatting

* Formatting

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: I538344 <[email protected]>
Co-authored-by: SAP Cloud SDK Bot <[email protected]>

Author: 3 people

.pipeline/pmd.xml

@@ -27,7 +27,7 @@
   <rule ref="category/java/design.xml/AvoidThrowingRawExceptionTypes">
     <priority>3</priority>
   </rule>
-  <rule ref="category/java/errorprone.xml/NonCaseLabelInSwitchStatement">
+  <rule ref="category/java/errorprone.xml/NonCaseLabelInSwitch">
     <priority>3</priority>
   </rule>
   <rule ref="category/java/bestpractices.xml/PreserveStackTrace">

README.md

@@ -177,7 +177,8 @@ After restarting your application, you should see an "aicore" entry in the `VCAP
 
 ```java
 Destination destination = DestinationAccessor.getDestination("my-aicore");
-AiCoreService client = new AiCoreService().withDestination(destination);
+AiCoreService aiCoreService = new AiCoreService().withDestination(destination);
+DeploymentApi client = new DeploymentApi(aiCoreService);
 ```
 
 </details>
@@ -253,14 +254,7 @@ For more detailed information and advanced usage, please refer to the following:
 
 ### _"How to add a custom header to AI Core requests?"_
 
-To add a header to AI Core requests, use the following code:
-
-```java
-ApiClient client = new AiCoreService().client().addDefaultHeader("header-key", "header-value");
-DeploymentApi api = new DeploymentApi(client);
-```
-
-For more customization, creating a [HeaderProvider](https://sap.github.io/cloud-sdk/docs/java/features/connectivity/http-destinations#about-headerproviders) is also possible.
+Create a [HeaderProvider](https://sap.github.io/cloud-sdk/docs/java/features/connectivity/http-destinations#about-headerproviders).
 
 
 ### _"There's a vulnerability warning `CVE-2021-41251`?"_

core/pom.xml

@@ -182,6 +182,7 @@
                     <removeOperationIdPrefix>true</removeOperationIdPrefix>
                     <removeOperationIdPrefixDelimiter>\.</removeOperationIdPrefixDelimiter>
                     <removeOperationIdPrefixCount>3</removeOperationIdPrefixCount>
+                    <aiSdkConstructor>true</aiSdkConstructor>
                   </additionalProperties>
                 </configuration>
               </execution>

core/src/main/java/com/sap/ai/sdk/core/AiCoreService.java

@@ -135,7 +135,7 @@ public AiCoreDeployment forDeployment(@Nonnull final String deploymentId) {
   public AiCoreDeployment forDeploymentByModel(@Nonnull final AiModel model)
       throws NoSuchElementException {
     return new AiCoreDeployment(
-        this, () -> DEPLOYMENT_CACHE.getDeploymentIdByModel(this.client(), resourceGroup, model));
+        this, () -> DEPLOYMENT_CACHE.getDeploymentIdByModel(this, resourceGroup, model));
   }
 
   /**
@@ -150,8 +150,7 @@ public AiCoreDeployment forDeploymentByModel(@Nonnull final AiModel model)
   public AiCoreDeployment forDeploymentByScenario(@Nonnull final String scenarioId)
       throws NoSuchElementException {
     return new AiCoreDeployment(
-        this,
-        () -> DEPLOYMENT_CACHE.getDeploymentIdByScenario(client(), resourceGroup, scenarioId));
+        this, () -> DEPLOYMENT_CACHE.getDeploymentIdByScenario(this, resourceGroup, scenarioId));
   }
 
   /**
@@ -193,7 +192,6 @@ protected DefaultHttpDestination.Builder getDestinationBuilder(
    * @throws DestinationAccessException If the destination cannot be accessed.
    * @throws DestinationNotFoundException If the destination cannot be found.
    */
-  @SuppressWarnings("UnstableApiUsage")
   @Nonnull
   protected ApiClient getApiClient(@Nonnull final Destination destination) {
     val objectMapper =
@@ -223,6 +221,6 @@ protected ApiClient getApiClient(@Nonnull final Destination destination) {
    * @param resourceGroup the resource group of the deleted deployment, usually "default".
    */
   public void reloadCachedDeployments(@Nonnull final String resourceGroup) {
-    DEPLOYMENT_CACHE.resetCache(client(), resourceGroup);
+    DEPLOYMENT_CACHE.resetCache(this, resourceGroup);
   }
 }

core/src/main/java/com/sap/ai/sdk/core/DeploymentCache.java

@@ -2,7 +2,6 @@
 
 import com.sap.ai.sdk.core.client.DeploymentApi;
 import com.sap.ai.sdk.core.client.model.AiDeployment;
-import com.sap.cloud.sdk.services.openapi.apiclient.ApiClient;
 import com.sap.cloud.sdk.services.openapi.core.OpenApiRequestException;
 import java.util.HashSet;
 import java.util.Map;
@@ -30,14 +29,15 @@ class DeploymentCache {
    *
    * <p><b>Call this whenever a deployment is deleted.</b>
    *
-   * @param client the API client to query deployments.
+   * @param aiCoreDestination the configured connection to the AI Core service.
    * @param resourceGroup the resource group, usually "default".
    */
-  void resetCache(@Nonnull final ApiClient client, @Nonnull final String resourceGroup) {
+  void resetCache(
+      @Nonnull final AiCoreDestination aiCoreDestination, @Nonnull final String resourceGroup) {
     cache.remove(resourceGroup);
     try {
       val deployments =
-          new HashSet<>(new DeploymentApi(client).query(resourceGroup).getResources());
+          new HashSet<>(new DeploymentApi(aiCoreDestination).query(resourceGroup).getResources());
       cache.put(resourceGroup, deployments);
     } catch (final OpenApiRequestException e) {
       log.error("Failed to load deployments into cache", e);
@@ -48,22 +48,22 @@ void resetCache(@Nonnull final ApiClient client, @Nonnull final String resourceG
    * Get the deployment id from the foundation model object. If there are multiple deployments of
    * the same model, the first one is returned.
    *
-   * @param client the API client to maybe reset the cache if the deployment is not found.
+   * @param aiCoreDestination the configured connection to the AI Core service.
    * @param resourceGroup the resource group, usually "default".
    * @param model the foundation model.
    * @return the deployment id.
    * @throws NoSuchElementException if no running deployment is found for the model.
    */
   @Nonnull
   String getDeploymentIdByModel(
-      @Nonnull final ApiClient client,
+      @Nonnull final AiCoreDestination aiCoreDestination,
       @Nonnull final String resourceGroup,
       @Nonnull final AiModel model)
       throws NoSuchElementException {
     return getDeploymentIdByModel(resourceGroup, model)
         .orElseGet(
             () -> {
-              resetCache(client, resourceGroup);
+              resetCache(aiCoreDestination, resourceGroup);
               return getDeploymentIdByModel(resourceGroup, model)
                   .orElseThrow(
                       () ->
@@ -84,22 +84,22 @@ private Optional<String> getDeploymentIdByModel(
    * Get the deployment id from the scenario id. If there are multiple deployments of the * same
    * model, the first one is returned.
    *
-   * @param client the API client to maybe reset the cache if the deployment is not found.
+   * @param aiCoreDestination the configured connection to the AI Core service.
    * @param resourceGroup the resource group, usually "default".
    * @param scenarioId the scenario id, can be "orchestration".
    * @return the deployment id.
    * @throws NoSuchElementException if no running deployment is found for the scenario.
    */
   @Nonnull
   String getDeploymentIdByScenario(
-      @Nonnull final ApiClient client,
+      @Nonnull final AiCoreDestination aiCoreDestination,
       @Nonnull final String resourceGroup,
       @Nonnull final String scenarioId)
       throws NoSuchElementException {
     return getDeploymentIdByScenario(resourceGroup, scenarioId)
         .orElseGet(
             () -> {
-              resetCache(client, resourceGroup);
+              resetCache(aiCoreDestination, resourceGroup);
               return getDeploymentIdByScenario(resourceGroup, scenarioId)
                   .orElseThrow(
                       () ->

core/src/main/java/com/sap/ai/sdk/core/client/ApplicationApi.java

@@ -1,6 +1,7 @@
 package com.sap.ai.sdk.core.client;
 
-import com.google.common.annotations.Beta;
+import com.sap.ai.sdk.core.AiCoreDestination;
+import com.sap.ai.sdk.core.AiCoreService;
 import com.sap.ai.sdk.core.client.model.BckndAllArgoCDApplicationData;
 import com.sap.ai.sdk.core.client.model.BckndArgoCDApplicationBaseData;
 import com.sap.ai.sdk.core.client.model.BckndArgoCDApplicationCreationResponse;
@@ -10,8 +11,6 @@
 import com.sap.ai.sdk.core.client.model.BckndArgoCDApplicationRefreshResponse;
 import com.sap.ai.sdk.core.client.model.BckndArgoCDApplicationStatus;
 import com.sap.ai.sdk.core.client.model.KubesubmitV4ApplicationsCreateRequest;
-import com.sap.cloud.sdk.cloudplatform.connectivity.Destination;
-import com.sap.cloud.sdk.services.openapi.apiclient.ApiClient;
 import com.sap.cloud.sdk.services.openapi.core.AbstractOpenApiService;
 import com.sap.cloud.sdk.services.openapi.core.OpenApiRequestException;
 import java.util.HashMap;
@@ -38,24 +37,19 @@
  * data and trained models.
  */
 public class ApplicationApi extends AbstractOpenApiService {
-  /**
-   * Instantiates this API class to invoke operations on the AI Core.
-   *
-   * @param httpDestination The destination that API should be used with
-   */
-  public ApplicationApi(@Nonnull final Destination httpDestination) {
-    super(httpDestination);
+
+  /** Instantiates this API class to invoke operations on the AI Core */
+  public ApplicationApi() {
+    super(new AiCoreService().client());
   }
 
   /**
-   * Instantiates this API class to invoke operations on the AI Core based on a given {@link
-   * ApiClient}.
+   * Instantiates this API class to invoke operations on the AI Core
    *
-   * @param apiClient ApiClient to invoke the API on
+   * @param aiCoreDestination The configured connectivity instance to AI Core
    */
-  @Beta
-  public ApplicationApi(@Nonnull final ApiClient apiClient) {
-    super(apiClient);
+  public ApplicationApi(@Nonnull final AiCoreDestination aiCoreDestination) {
+    super(aiCoreDestination.client());
   }
 
   /**

core/src/main/java/com/sap/ai/sdk/core/client/ArtifactApi.java

@@ -1,11 +1,11 @@
 package com.sap.ai.sdk.core.client;
 
-import com.google.common.annotations.Beta;
+import com.sap.ai.sdk.core.AiCoreDestination;
+import com.sap.ai.sdk.core.AiCoreService;
 import com.sap.ai.sdk.core.client.model.AiArtifact;
 import com.sap.ai.sdk.core.client.model.AiArtifactCreationResponse;
 import com.sap.ai.sdk.core.client.model.AiArtifactList;
 import com.sap.ai.sdk.core.client.model.AiArtifactPostData;
-import com.sap.cloud.sdk.cloudplatform.connectivity.Destination;
 import com.sap.cloud.sdk.services.openapi.apiclient.ApiClient;
 import com.sap.cloud.sdk.services.openapi.core.AbstractOpenApiService;
 import com.sap.cloud.sdk.services.openapi.core.OpenApiRequestException;
@@ -34,24 +34,19 @@
  * data and trained models.
  */
 public class ArtifactApi extends AbstractOpenApiService {
-  /**
-   * Instantiates this API class to invoke operations on the AI Core.
-   *
-   * @param httpDestination The destination that API should be used with
-   */
-  public ArtifactApi(@Nonnull final Destination httpDestination) {
-    super(httpDestination);
+
+  /** Instantiates this API class to invoke operations on the AI Core */
+  public ArtifactApi() {
+    super(new AiCoreService().client());
   }
 
   /**
-   * Instantiates this API class to invoke operations on the AI Core based on a given {@link
-   * ApiClient}.
+   * Instantiates this API class to invoke operations on the AI Core
    *
-   * @param apiClient ApiClient to invoke the API on
+   * @param aiCoreDestination The configured connectivity instance to AI Core
    */
-  @Beta
-  public ArtifactApi(@Nonnull final ApiClient apiClient) {
-    super(apiClient);
+  public ArtifactApi(@Nonnull final AiCoreDestination aiCoreDestination) {
+    super(aiCoreDestination.client());
   }
 
   /**

core/src/main/java/com/sap/ai/sdk/core/client/ConfigurationApi.java

@@ -1,11 +1,11 @@
 package com.sap.ai.sdk.core.client;
 
-import com.google.common.annotations.Beta;
+import com.sap.ai.sdk.core.AiCoreDestination;
+import com.sap.ai.sdk.core.AiCoreService;
 import com.sap.ai.sdk.core.client.model.AiConfiguration;
 import com.sap.ai.sdk.core.client.model.AiConfigurationBaseData;
 import com.sap.ai.sdk.core.client.model.AiConfigurationCreationResponse;
 import com.sap.ai.sdk.core.client.model.AiConfigurationList;
-import com.sap.cloud.sdk.cloudplatform.connectivity.Destination;
 import com.sap.cloud.sdk.services.openapi.apiclient.ApiClient;
 import com.sap.cloud.sdk.services.openapi.core.AbstractOpenApiService;
 import com.sap.cloud.sdk.services.openapi.core.OpenApiRequestException;
@@ -34,24 +34,19 @@
  * data and trained models.
  */
 public class ConfigurationApi extends AbstractOpenApiService {
-  /**
-   * Instantiates this API class to invoke operations on the AI Core.
-   *
-   * @param httpDestination The destination that API should be used with
-   */
-  public ConfigurationApi(@Nonnull final Destination httpDestination) {
-    super(httpDestination);
+
+  /** Instantiates this API class to invoke operations on the AI Core */
+  public ConfigurationApi() {
+    super(new AiCoreService().client());
   }
 
   /**
-   * Instantiates this API class to invoke operations on the AI Core based on a given {@link
-   * ApiClient}.
+   * Instantiates this API class to invoke operations on the AI Core
    *
-   * @param apiClient ApiClient to invoke the API on
+   * @param aiCoreDestination The configured connectivity instance to AI Core
    */
-  @Beta
-  public ConfigurationApi(@Nonnull final ApiClient apiClient) {
-    super(apiClient);
+  public ConfigurationApi(@Nonnull final AiCoreDestination aiCoreDestination) {
+    super(aiCoreDestination.client());
   }
 
   /**

core/src/main/java/com/sap/ai/sdk/core/client/DeploymentApi.java

@@ -1,6 +1,7 @@
 package com.sap.ai.sdk.core.client;
 
-import com.google.common.annotations.Beta;
+import com.sap.ai.sdk.core.AiCoreDestination;
+import com.sap.ai.sdk.core.AiCoreService;
 import com.sap.ai.sdk.core.client.model.AiDeploymentBulkModificationRequest;
 import com.sap.ai.sdk.core.client.model.AiDeploymentBulkModificationResponse;
 import com.sap.ai.sdk.core.client.model.AiDeploymentCreationRequest;
@@ -11,7 +12,6 @@
 import com.sap.ai.sdk.core.client.model.AiDeploymentModificationResponse;
 import com.sap.ai.sdk.core.client.model.AiDeploymentResponseWithDetails;
 import com.sap.ai.sdk.core.client.model.RTALogCommonResponse;
-import com.sap.cloud.sdk.cloudplatform.connectivity.Destination;
 import com.sap.cloud.sdk.services.openapi.apiclient.ApiClient;
 import com.sap.cloud.sdk.services.openapi.core.AbstractOpenApiService;
 import com.sap.cloud.sdk.services.openapi.core.OpenApiRequestException;
@@ -41,24 +41,19 @@
  * data and trained models.
  */
 public class DeploymentApi extends AbstractOpenApiService {
-  /**
-   * Instantiates this API class to invoke operations on the AI Core.
-   *
-   * @param httpDestination The destination that API should be used with
-   */
-  public DeploymentApi(@Nonnull final Destination httpDestination) {
-    super(httpDestination);
+
+  /** Instantiates this API class to invoke operations on the AI Core */
+  public DeploymentApi() {
+    super(new AiCoreService().client());
   }
 
   /**
-   * Instantiates this API class to invoke operations on the AI Core based on a given {@link
-   * ApiClient}.
+   * Instantiates this API class to invoke operations on the AI Core
    *
-   * @param apiClient ApiClient to invoke the API on
+   * @param aiCoreDestination The configured connectivity instance to AI Core
    */
-  @Beta
-  public DeploymentApi(@Nonnull final ApiClient apiClient) {
-    super(apiClient);
+  public DeploymentApi(@Nonnull final AiCoreDestination aiCoreDestination) {
+    super(aiCoreDestination.client());
   }
 
   /**