feat: add support for application list pagination

Application list results are now paginated.
Add properties and helper classes for accessing application list pages.

Signed-off-by: Subin Shekhar <[email protected]>

Author: subinpc

modules/examples/src/main/java/com/ibm/cloud/iaesdk/ibm_analytics_engine_api/v3/IbmAnalyticsEngineApiExamples.java

@@ -13,11 +13,12 @@
 
 package com.ibm.cloud.iaesdk.ibm_analytics_engine_api.v3;
 
-import com.ibm.cloud.iaesdk.ibm_analytics_engine_api.v3.model.ApplicationCollection;
+import com.ibm.cloud.iaesdk.ibm_analytics_engine_api.v3.model.Application;
 import com.ibm.cloud.iaesdk.ibm_analytics_engine_api.v3.model.ApplicationGetResponse;
 import com.ibm.cloud.iaesdk.ibm_analytics_engine_api.v3.model.ApplicationGetStateResponse;
 import com.ibm.cloud.iaesdk.ibm_analytics_engine_api.v3.model.ApplicationRequestApplicationDetails;
 import com.ibm.cloud.iaesdk.ibm_analytics_engine_api.v3.model.ApplicationResponse;
+import com.ibm.cloud.iaesdk.ibm_analytics_engine_api.v3.model.ApplicationsPager;
 import com.ibm.cloud.iaesdk.ibm_analytics_engine_api.v3.model.ConfigurePlatformLoggingOptions;
 import com.ibm.cloud.iaesdk.ibm_analytics_engine_api.v3.model.CreateApplicationOptions;
 import com.ibm.cloud.iaesdk.ibm_analytics_engine_api.v3.model.CurrentResourceConsumptionResponse;
@@ -53,6 +54,9 @@
 import com.ibm.cloud.sdk.core.http.Response;
 import com.ibm.cloud.sdk.core.service.exception.ServiceResponseException;
 import com.ibm.cloud.sdk.core.util.CredentialUtils;
+import com.ibm.cloud.sdk.core.util.GsonSingleton;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Map;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -237,6 +241,7 @@ public static void main(String[] args) throws Exception {
       // begin-replace_instance_default_runtime
       ReplaceInstanceDefaultRuntimeOptions replaceInstanceDefaultRuntimeOptions = new ReplaceInstanceDefaultRuntimeOptions.Builder()
         .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
+        .sparkVersion("3.3")
         .build();
 
       Response<Runtime> response = ibmAnalyticsEngineApiService.replaceInstanceDefaultRuntime(replaceInstanceDefaultRuntimeOptions).execute();
@@ -280,12 +285,21 @@ public static void main(String[] args) throws Exception {
       // begin-list_applications
       ListApplicationsOptions listApplicationsOptions = new ListApplicationsOptions.Builder()
         .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
+        .addState("accepted")
+        .addState("running")
+        .addState("finished")
+        .addState("failed")
+        .limit(Long.valueOf("10"))
         .build();
 
-      Response<ApplicationCollection> response = ibmAnalyticsEngineApiService.listApplications(listApplicationsOptions).execute();
-      ApplicationCollection applicationCollection = response.getResult();
+      ApplicationsPager pager = new ApplicationsPager(ibmAnalyticsEngineApiService, listApplicationsOptions);
+      List<Application> allResults = new ArrayList<>();
+      while (pager.hasNext()) {
+        List<Application> nextPage = pager.getNext();
+        allResults.addAll(nextPage);
+      }
 
-      System.out.println(applicationCollection);
+      System.out.println(GsonSingleton.getGson().toJson(allResults));
       // end-list_applications
     } catch (ServiceResponseException e) {
         logger.error(String.format("Service returned status code %s: %s%nError details: %s",
@@ -367,6 +381,7 @@ public static void main(String[] args) throws Exception {
       // begin-replace_log_forwarding_config
       ReplaceLogForwardingConfigOptions replaceLogForwardingConfigOptions = new ReplaceLogForwardingConfigOptions.Builder()
         .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
+        .enabled(true)
         .build();
 
       Response<LogForwardingConfigResponse> response = ibmAnalyticsEngineApiService.replaceLogForwardingConfig(replaceLogForwardingConfigOptions).execute();
@@ -401,6 +416,7 @@ public static void main(String[] args) throws Exception {
       // begin-configure_platform_logging
       ConfigurePlatformLoggingOptions configurePlatformLoggingOptions = new ConfigurePlatformLoggingOptions.Builder()
         .instanceGuid("e64c907a-e82f-46fd-addc-ccfafbd28b09")
+        .enable(true)
         .build();
 
       Response<LoggingConfigurationResponse> response = ibmAnalyticsEngineApiService.configurePlatformLogging(configurePlatformLoggingOptions).execute();

modules/ibm-analytics-engine-api/src/main/java/com/ibm/cloud/iaesdk/ibm_analytics_engine_api/v3/IbmAnalyticsEngineApi.java

@@ -452,6 +452,12 @@ public ServiceCall<ApplicationCollection> listApplications(ListApplicationsOptio
     if (listApplicationsOptions.state() != null) {
       builder.query("state", RequestUtils.join(listApplicationsOptions.state(), ","));
     }
+    if (listApplicationsOptions.limit() != null) {
+      builder.query("limit", String.valueOf(listApplicationsOptions.limit()));
+    }
+    if (listApplicationsOptions.start() != null) {
+      builder.query("start", String.valueOf(listApplicationsOptions.start()));
+    }
     ResponseConverter<ApplicationCollection> responseConverter =
       ResponseConverterUtils.getValue(new com.google.gson.reflect.TypeToken<ApplicationCollection>() { }.getType());
     return createServiceCall(builder.build(), responseConverter);

modules/ibm-analytics-engine-api/src/main/java/com/ibm/cloud/iaesdk/ibm_analytics_engine_api/v3/model/ApplicationCollection.java

@@ -17,11 +17,15 @@
 import com.ibm.cloud.sdk.core.service.model.GenericModel;
 
 /**
- * An array of application details.
+ * A paginated collection of applications.
  */
 public class ApplicationCollection extends GenericModel {
 
   protected List<Application> applications;
+  protected PageLink first;
+  protected PageLink next;
+  protected PageLink previous;
+  protected Long limit;
 
   protected ApplicationCollection() { }
 
@@ -35,5 +39,49 @@ protected ApplicationCollection() { }
   public List<Application> getApplications() {
     return applications;
   }
+
+  /**
+   * Gets the first.
+   *
+   * A reference to a page in a paginated collection.
+   *
+   * @return the first
+   */
+  public PageLink getFirst() {
+    return first;
+  }
+
+  /**
+   * Gets the next.
+   *
+   * A reference to a page in a paginated collection.
+   *
+   * @return the next
+   */
+  public PageLink getNext() {
+    return next;
+  }
+
+  /**
+   * Gets the previous.
+   *
+   * A reference to a page in a paginated collection.
+   *
+   * @return the previous
+   */
+  public PageLink getPrevious() {
+    return previous;
+  }
+
+  /**
+   * Gets the limit.
+   *
+   * The maximum number of results in this page of the collection.
+   *
+   * @return the limit
+   */
+  public Long getLimit() {
+    return limit;
+  }
 }
 

modules/ibm-analytics-engine-api/src/main/java/com/ibm/cloud/iaesdk/ibm_analytics_engine_api/v3/model/ApplicationsPager.java

@@ -0,0 +1,107 @@
+/*
+ * (C) Copyright IBM Corp. 2023.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+package com.ibm.cloud.iaesdk.ibm_analytics_engine_api.v3.model;
+
+import com.ibm.cloud.iaesdk.ibm_analytics_engine_api.v3.IbmAnalyticsEngineApi;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.NoSuchElementException;
+
+/**
+ * ApplicationsPager can be used to simplify the use of the "listApplications" method.
+ */
+public class ApplicationsPager {
+  private static class PageContext {
+    private String next;
+    public String getNext() {
+      return next;
+    }
+    public void setNext(String next) {
+      this.next = next;
+    }
+  }
+
+  protected boolean hasNext;
+  protected ListApplicationsOptions options;
+  protected IbmAnalyticsEngineApi client;
+  protected PageContext pageContext;
+
+  // Hide the default ctor.
+  protected ApplicationsPager() { }
+
+  /**
+   * Constructs a new ApplicationsPager instance with the specified client and options model instance.
+   * @param client the IbmAnalyticsEngineApi instance to be used to invoke the "listApplications" method
+   * @param options the ListApplicationsOptions instance to be used to invoke the "listApplications" method
+   */
+  public ApplicationsPager(IbmAnalyticsEngineApi client, ListApplicationsOptions options) {
+    if (options.start() != null) {
+      throw new IllegalArgumentException("The options 'start' field should not be set");
+    }
+
+    this.hasNext = true;
+    this.client = client;
+    this.options = options.newBuilder().build();
+    this.pageContext = new PageContext();
+  }
+
+  /**
+   * Returns true if there are more results to be retrieved.
+   * @return boolean
+   */
+  public boolean hasNext() {
+    return hasNext;
+  }
+
+  /**
+   * Returns the next page of results.
+   * @return a List<Application> that contains the next page of results
+   */
+  public List<Application> getNext() {
+    if (!hasNext()) {
+      throw new NoSuchElementException("No more results available");
+    }
+
+    ListApplicationsOptions.Builder builder = this.options.newBuilder();
+    if (this.pageContext.getNext() != null) {
+      builder.start(this.pageContext.getNext());
+    }
+    this.options = builder.build();
+
+    ApplicationCollection result = client.listApplications(options).execute().getResult();
+
+    String next = null;
+    if (result.getNext() != null) {
+      next = result.getNext().getStart();
+    }
+    this.pageContext.setNext(next);
+    if (next == null) {
+      this.hasNext = false;
+    }
+
+    return result.getApplications();
+  }
+
+  /**
+   * Returns all results by invoking getNext() repeatedly until all pages of results have been retrieved.
+   * @return a List&lt;Application&gt; containing all results returned by the "listApplications" method
+   */
+  public List<Application> getAll() {
+    List<Application> results = new ArrayList<>();
+    while (hasNext()) {
+      List<Application> nextPage = getNext();
+      results.addAll(nextPage);
+    }
+    return results;
+  }
+}

modules/ibm-analytics-engine-api/src/main/java/com/ibm/cloud/iaesdk/ibm_analytics_engine_api/v3/model/ListApplicationsOptions.java

@@ -44,13 +44,17 @@ public interface State {
 
   protected String instanceId;
   protected List<String> state;
+  protected Long limit;
+  protected String start;
 
   /**
    * Builder.
    */
   public static class Builder {
     private String instanceId;
     private List<String> state;
+    private Long limit;
+    private String start;
 
     /**
      * Instantiates a new Builder from an existing ListApplicationsOptions instance.
@@ -60,6 +64,8 @@ public static class Builder {
     private Builder(ListApplicationsOptions listApplicationsOptions) {
       this.instanceId = listApplicationsOptions.instanceId;
       this.state = listApplicationsOptions.state;
+      this.limit = listApplicationsOptions.limit;
+      this.start = listApplicationsOptions.start;
     }
 
     /**
@@ -124,6 +130,28 @@ public Builder state(List<String> state) {
       this.state = state;
       return this;
     }
+
+    /**
+     * Set the limit.
+     *
+     * @param limit the limit
+     * @return the ListApplicationsOptions builder
+     */
+    public Builder limit(long limit) {
+      this.limit = limit;
+      return this;
+    }
+
+    /**
+     * Set the start.
+     *
+     * @param start the start
+     * @return the ListApplicationsOptions builder
+     */
+    public Builder start(String start) {
+      this.start = start;
+      return this;
+    }
   }
 
   protected ListApplicationsOptions() { }
@@ -133,6 +161,8 @@ protected ListApplicationsOptions(Builder builder) {
       "instanceId cannot be empty");
     instanceId = builder.instanceId;
     state = builder.state;
+    limit = builder.limit;
+    start = builder.start;
   }
 
   /**
@@ -165,5 +195,27 @@ public String instanceId() {
   public List<String> state() {
     return state;
   }
+
+  /**
+   * Gets the limit.
+   *
+   * Number of application entries to be included in the response.
+   *
+   * @return the limit
+   */
+  public Long limit() {
+    return limit;
+  }
+
+  /**
+   * Gets the start.
+   *
+   * Token used to fetch the next or the previous page of the applications list.
+   *
+   * @return the start
+   */
+  public String start() {
+    return start;
+  }
 }