Package com.ellucian.ethos.integration.client.proxy

Class EthosProxyClientAsync<T>

  • public class EthosProxyClientAsync<T>
extends EthosProxyClient
    An EthosProxyClient used to retrieve data from the Ethos Integration Proxy API, asynchronously. This class has the same function and purpose as EthosProxyClient, but the methods returning a List of EthosResponses have potentially longer response times due to quantity of data returned. This class therefore wraps returns from those methods in CompletableFutures so that those calls can be made in an asynchronous way.

    CompletableFutures can be handled as follows: 

     CompletableFuture<List<String>> asyncResponse = ethosProxyClient.getAllPagesFromOffsetAsStringsAsync(resourceName, offset);

 // using .join here so there is no exception thrown - all exceptions will be unchecked.  This is the
 // same as in C# where the default is to use the async processing without checked exceptions.
 List<String> stringList = asyncResponse.join();

 // or use .get or .getNow to handle with checked exceptions:
 List<String> anotherStringList = asyncResponse.get();

    • Constructor Detail

      • EthosProxyClientAsync

        public EthosProxyClientAsync​(String apiKey,
                             Integer connectionTimeout,
                             Integer connectionRequestTimeout,
                             Integer socketTimeout)
        Instantiates this class using the given API key.

        Note that the preferred way to get an instance of this class is through the EthosClientBuilder.

        Parameters:
        apiKey - A valid API key from Ethos Integration. This is required to be a valid 36 character GUID string. If it is null, empty, or not in a valid GUID format, then an IllegalArgumentException will be thrown.
        connectionTimeout - The timeout in seconds for a connection to be established.
        connectionRequestTimeout - The timeout in seconds when requesting a connection from the Apache connection manager.
        socketTimeout - The timeout in seconds when waiting for data between consecutive data packets.

    • Method Detail

      • getAllPagesAsync

        public CompletableFuture<List<EthosResponse>> getAllPagesAsync​(String resourceName)
                                                        throws CompletionException
        Gets all pages for the given resource. Uses the default page size of the response body content length, and the default version.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the resource to get data for.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where the content of each EthosResponse in the list represents a page of data.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesAsync

        public CompletableFuture<List<EthosResponse>> getAllPagesAsync​(String resourceName,
                                                               String version)
                                                        throws CompletionException
        Gets all pages for the given resource and version. Uses the default page size of the response body content length.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where the content of each EthosResponse in the list represents a page of data according to the requested version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesAsync

        public CompletableFuture<List<EthosResponse>> getAllPagesAsync​(String resourceName,
                                                               int pageSize)
                                                        throws CompletionException
        Gets all pages for the given resource and page size. Uses the default version of the resource.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the resource to get data for.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where the content of each EthosResponse in the list represents a page of data with the given page size according to the current version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesAsync

        public CompletableFuture<List<EthosResponse>> getAllPagesAsync​(String resourceName,
                                                               String version,
                                                               int pageSize)
                                                        throws CompletionException
        Gets all pages for the given resource, version, and page size.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where the content of each EthosResponse in the list represents a page of data with the given page size according to the requested version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesAsync

        public CompletableFuture<List<EthosResponse>> getAllPagesAsync​(String resourceName,
                                                               String version,
                                                               int pageSize,
                                                               Class classType)
                                                        throws CompletionException
        Gets all pages for the given resource, version, page size, and return the response bodies as generic type objects of the given class in each returned EthosResponse, if the classType is not null. If the classType is null, the returned EthosResponse will not contain a generic type object response body, but only a JSON formatted string response body.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where the content of each EthosResponse in the list represents a page of data with the given page size according to the requested version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesAsync

        public CompletableFuture<List<EthosResponse>> getAllPagesAsync​(String resourceName,
                                                               int pageSize,
                                                               Class classType)
                                                        throws CompletionException
        Gets all pages for the given resource and page size, and return the response bodies as generic type objects of the given class in each returned EthosResponse. Uses the default version of the resource.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the resource to get data for.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where the content of each EthosResponse in the list represents a page of data with the given page size according to the current version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesAsync

        public CompletableFuture<List<EthosResponse>> getAllPagesAsync​(String resourceName,
                                                               Class classType)
                                                        throws CompletionException
        Gets all pages for the given resource, and return the response bodies as generic type objects of the given class in each returned EthosResponse. Uses the default page size of the response body content length, and the default version.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the resource to get data for.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where the content of each EthosResponse in the list represents a page of data.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesAsync

        public CompletableFuture<List<EthosResponse>> getAllPagesAsync​(String resourceName,
                                                               String version,
                                                               Class classType)
                                                        throws CompletionException
        Gets all pages for the given resource and version, and return the response bodies as generic type objects of the given class in each returned EthosResponse. Uses the default page size of the response body content length.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where the content of each EthosResponse in the list represents a page of data according to the requested version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesAsStringsAsync

        public CompletableFuture<List<String>> getAllPagesAsStringsAsync​(String resourceName)
                                                          throws CompletionException
        Gets all pages for the given resource. Uses the default page size of the response body content length, and the default version.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the resource to get data for.
        Returns:
        A CompletableFuture wrapping a list of Strings where each String in the list represents a page of data according to the default version of the resource. The page size of each page is determined by the response body content length.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesAsStringsAsync

        public CompletableFuture<List<String>> getAllPagesAsStringsAsync​(String resourceName,
                                                                 String version)
                                                          throws CompletionException
        Gets all pages for the given resource and version. Uses the default page size of the response body content length.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        Returns:
        A CompletableFuture wrapping a list of Strings where each String in the list represents a page of data according to the requested version of the resource. The page size of each page is determined by the response body content length.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesAsStringsAsync

        public CompletableFuture<List<String>> getAllPagesAsStringsAsync​(String resourceName,
                                                                 int pageSize)
                                                          throws CompletionException
        Gets all pages for the given resource and page size. Uses the default version of the resource.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        pageSize - The number of rows to include in each page (String) of the list returned.
        Returns:
        A CompletableFuture wrapping a list of Strings where each String in the list represents a page of data with the given page size according to the default version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesAsStringsAsync

        public CompletableFuture<List<String>> getAllPagesAsStringsAsync​(String resourceName,
                                                                 String version,
                                                                 int pageSize)
                                                          throws CompletionException
        Gets all pages for the given resource, version, and page size.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page (String) of the list returned.
        Returns:
        A CompletableFuture wrapping a list of Strings where each String in the list represents a page of data with the given page size according to the requested version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getAllPagesAsJsonNodesAsync​(String resourceName)
                                                                                             throws CompletionException
        Gets all pages for the given resource. Uses the default page size of the response body content length, and the default version.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a page of data according to the default version of the resource. The page size of each page is determined by the response body content length.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getAllPagesAsJsonNodesAsync​(String resourceName,
                                                                                                    String version)
                                                                                             throws CompletionException
        Gets all pages for the given resource and version. Uses the default page size of the response body content length.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a page of data according to the requested version of the resource. The page size of each page is determined by the response body content length.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getAllPagesAsJsonNodesAsync​(String resourceName,
                                                                                                    int pageSize)
                                                                                             throws CompletionException
        Gets all pages for the given resource and page size. Uses the default version.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        pageSize - The number of rows to include in each page (JsonNode) of the list returned.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a page of data with the given page size according to the default version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getAllPagesAsJsonNodesAsync​(String resourceName,
                                                                                                    String version,
                                                                                                    int pageSize)
                                                                                             throws CompletionException
        Gets all pages for the given resource, version, and page size.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page (JsonNode) of the list returned.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a page of data with the given page size according to the requested version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getAllPagesFromOffsetAsync​(String resourceName,
                                                                         int offset)
                                                                  throws CompletionException
        Gets all pages for the given resource from the given offset. Uses the default page size of the response body content length, and the default version.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        offset - The 0 based index from which to begin paging for the given resource.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses from the given offset where the content of each EthosResponse in the list represents a page of data according to the default version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getAllPagesFromOffsetAsync​(String resourceName,
                                                                         int offset,
                                                                         int pageSize)
                                                                  throws CompletionException
        Gets all pages for the given resource, offset, and page size. Uses the default version of the resource.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        offset - The 0 based index from which to begin paging for the given resource.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses from the given offset where the content of each EthosResponse in the list represents a page of data with the given page size according to the default version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getAllPagesFromOffsetAsync​(String resourceName,
                                                                         String version,
                                                                         int offset)
                                                                  throws CompletionException
        Gets all pages for the given resource, version, and offset. Uses the default page size of the response body content length.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        offset - The 0 based index from which to begin paging for the given resource.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses from the given offset where the content of each EthosResponse in the list represents a page of data with the response content body length as the page size according to the requested version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getAllPagesFromOffsetAsync​(String resourceName,
                                                                         String version,
                                                                         int offset,
                                                                         int pageSize)
                                                                  throws CompletionException
        Gets all pages for the given resource, version, and page size, from the offset. If the offset is negative, all pages will be returned.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        offset - The 0 based index from which to begin paging for the given resource.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses from the given offset where the content of each EthosResponse in the list represents a page of data with the given page size according to the requested version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getAllPagesFromOffsetAsync​(String resourceName,
                                                                         String version,
                                                                         int offset,
                                                                         int pageSize,
                                                                         Class classType)
                                                                  throws CompletionException
        Gets all pages for the given resource, version, and page size, from the offset. Returns the response bodies as generic type objects of the given class in each returned EthosResponse, if the classType is not null. If the classType is null, the returned EthosResponse will not contain a generic type object response body, but only a JSON formatted string response body. If the offset is negative, all pages will be returned.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        offset - The 0 based index from which to begin paging for the given resource.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses from the given offset where the content of each EthosResponse in the list represents a page of data with the given page size according to the requested version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getAllPagesFromOffsetAsync​(String resourceName,
                                                                         int offset,
                                                                         Class classType)
                                                                  throws CompletionException
        Gets all pages for the given resource from the given offset. Uses the default page size of the response body content length, and the default version. Returns the response bodies as generic type objects of the given class in each returned EthosResponse.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        offset - The 0 based index from which to begin paging for the given resource.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses from the given offset where the content of each EthosResponse in the list represents a page of data according to the default version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getAllPagesFromOffsetAsync​(String resourceName,
                                                                         int offset,
                                                                         int pageSize,
                                                                         Class classType)
                                                                  throws CompletionException
        Gets all pages for the given resource, offset, and page size. Uses the default version of the resource. Returns the response bodies as generic type objects of the given class in each returned EthosResponse.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        offset - The 0 based index from which to begin paging for the given resource.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses from the given offset where the content of each EthosResponse in the list represents a page of data with the given page size according to the default version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getAllPagesFromOffsetAsync​(String resourceName,
                                                                         String version,
                                                                         int offset,
                                                                         Class classType)
                                                                  throws CompletionException
        Gets all pages for the given resource, version, and offset. Uses the default page size of the response body content length. Returns the response bodies as generic type objects of the given class in each returned EthosResponse.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        offset - The 0 based index from which to begin paging for the given resource.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses from the given offset where the content of each EthosResponse in the list represents a page of data with the response content body length as the page size according to the requested version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesFromOffsetAsStringsAsync

        public CompletableFuture<List<String>> getAllPagesFromOffsetAsStringsAsync​(String resourceName,
                                                                           int offset)
                                                                    throws CompletionException
        Gets all pages for the given resource from the given offset. Uses the default page size of the response body content length, and the default version of the resource.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        offset - The 0 based index from which to begin paging for the given resource.
        Returns:
        A CompletableFuture wrapping a list of Strings where each String in the list represents a page of data from the given offset with the response content body length as the page size according to the default version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesFromOffsetAsStringsAsync

        public CompletableFuture<List<String>> getAllPagesFromOffsetAsStringsAsync​(String resourceName,
                                                                           int offset,
                                                                           int pageSize)
                                                                    throws CompletionException
        Gets all pages for the given resource from the given offset with the given page size. Uses the default version of the resource.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        offset - The 0 based index from which to begin paging for the given resource.
        pageSize - The number of rows to include in each page (String) of the list returned.
        Returns:
        A CompletableFuture wrapping a list of Strings where each String in the list represents a page of data from the given offset with the given page size according to the default version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesFromOffsetAsStringsAsync

        public CompletableFuture<List<String>> getAllPagesFromOffsetAsStringsAsync​(String resourceName,
                                                                           String version,
                                                                           int offset)
                                                                    throws CompletionException
        Gets all pages for the given resource and version from the given offset. Uses the default page size of the response body content length.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        offset - The 0 based index from which to begin paging for the given resource.
        Returns:
        A CompletableFuture wrapping a list of Strings where each String in the list represents a page of data from the given offset with the response content body length as the page size according to the requested version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesFromOffsetAsStringsAsync

        public CompletableFuture<List<String>> getAllPagesFromOffsetAsStringsAsync​(String resourceName,
                                                                           String version,
                                                                           int offset,
                                                                           int pageSize)
                                                                    throws CompletionException
        Gets all pages for the given resource, version, and page size from the given offset.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        offset - The 0 based index from which to begin paging for the given resource.
        pageSize - The number of rows to include in each page (String) of the list returned.
        Returns:
        A CompletableFuture wrapping a list of Strings where each String in the list represents a page of data from the given offset with the given page size according to the requested version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesFromOffsetAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getAllPagesFromOffsetAsJsonNodesAsync​(String resourceName,
                                                                                                              int offset)
                                                                                                       throws CompletionException
        Gets all pages for the given resource from the given offset. Uses the default page size of the response body content length, and the default version.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        offset - The 0 based index from which to begin paging for the given resource.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a page of data from the given offset with the response content body length as the page size according to the default version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesFromOffsetAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getAllPagesFromOffsetAsJsonNodesAsync​(String resourceName,
                                                                                                              int offset,
                                                                                                              int pageSize)
                                                                                                       throws CompletionException
        Gets all pages for the given resource and page size from the given offset. Uses the default version.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        offset - The 0 based index from which to begin paging for the given resource.
        pageSize - The number of rows to include in each page (JsonNode) of the list returned.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a page of data from the given offset with the given page size according to the default version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesFromOffsetAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getAllPagesFromOffsetAsJsonNodesAsync​(String resourceName,
                                                                                                              String version,
                                                                                                              int offset)
                                                                                                       throws CompletionException
        Gets all pages for the given resource and version from the given offset. Uses the default page size of the response body content length.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        offset - The 0 based index from which to begin paging for the given resource.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a page of data from the given offset with the response content body length as the page size according to the requested version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getAllPagesFromOffsetAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getAllPagesFromOffsetAsJsonNodesAsync​(String resourceName,
                                                                                                              String version,
                                                                                                              int offset,
                                                                                                              int pageSize)
                                                                                                       throws CompletionException
        Gets all pages for the given resource, version, and page size, from the given offset.

        NOTE: This method could result in a long running process and return a large volume of data. It is possible that an OutOfMemoryError could occur if trying to get a large quantity of data. This is NOT intended to be used for any kind of resource bulk loading of data. The Ethos bulk loading solution should be used for loading data in Ethos data model format in bulk.

        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        offset - The 0 based index from which to begin paging for the given resource.
        pageSize - The number of rows to include in each page (JsonNode) of the list returned.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a page of data from the given offset with the given page size according to the requested version of the resource.
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesAsync

        public CompletableFuture<List<EthosResponse>> getPagesAsync​(String resourceName,
                                                            int numPages)
                                                     throws CompletionException
        Gets some number of pages for the given resource. Uses the default page size of the response body content length, and default version.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the response content body length as the page size according to the default version of the resource, up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesAsync

        public CompletableFuture<List<EthosResponse>> getPagesAsync​(String resourceName,
                                                            String version,
                                                            int numPages)
                                                     throws CompletionException
        Gets some number of pages for the given resource and version. Uses the default page size of the response body content length.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the response content body length as the page size according to the requested version of the resource, up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesAsync

        public CompletableFuture<List<EthosResponse>> getPagesAsync​(String resourceName,
                                                            int pageSize,
                                                            int numPages)
                                                     throws CompletionException
        Gets some number of pages for the given resource and page size. Uses the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the given page size according to the default version of the resource, up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesAsync

        public CompletableFuture<List<EthosResponse>> getPagesAsync​(String resourceName,
                                                            String version,
                                                            int pageSize,
                                                            int numPages)
                                                     throws CompletionException
        Gets some number of pages for the given resource, version, and page size. If numPages is negative, all pages will be returned.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the given page size according to the requested version of the resource, up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesAsync

        public CompletableFuture<List<EthosResponse>> getPagesAsync​(String resourceName,
                                                            String version,
                                                            int pageSize,
                                                            int numPages,
                                                            Class classType)
                                                     throws CompletionException
        Gets some number of pages for the given resource, version, and page size. If numPages is negative, all pages will be returned. Returns the response bodies as generic type objects of the given class in each returned EthosResponse, if the classType is not null. If the classType is null, the returned EthosResponse will not contain a generic type object response body, but only a JSON formatted string response body.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        numPages - The number of pages of the given resource to return.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the given page size according to the requested version of the resource, up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesAsync

        public CompletableFuture<List<EthosResponse>> getPagesAsync​(String resourceName,
                                                            int numPages,
                                                            Class classType)
                                                     throws CompletionException
        Gets some number of pages for the given resource. Uses the default page size of the response body content length, and default version. Returns the response bodies as generic type objects of the given class in each returned EthosResponse.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        numPages - The number of pages of the given resource to return.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the response content body length as the page size according to the default version of the resource, up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesAsync

        public CompletableFuture<List<EthosResponse>> getPagesAsync​(String resourceName,
                                                            String version,
                                                            int numPages,
                                                            Class classType)
                                                     throws CompletionException
        Gets some number of pages for the given resource and version. Uses the default page size of the response body content length. Returns the response bodies as generic type objects of the given class in each returned EthosResponse.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        numPages - The number of pages of the given resource to return.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the response content body length as the page size according to the requested version of the resource, up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesAsync

        public CompletableFuture<List<EthosResponse>> getPagesAsync​(String resourceName,
                                                            int pageSize,
                                                            int numPages,
                                                            Class classType)
                                                     throws CompletionException
        Gets some number of pages for the given resource and page size. Uses the default version of the resource. Returns the response bodies as generic type objects of the given class in each returned EthosResponse.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        numPages - The number of pages of the given resource to return.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the given page size according to the default version of the resource, up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesAsStringsAsync

        public CompletableFuture<List<String>> getPagesAsStringsAsync​(String resourceName,
                                                              int numPages)
                                                       throws CompletionException
        Gets some number of pages for the given resource. Uses the default page size of the response body content length, and the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of Strings where each String in the list represents a page of data with the response content body length as the page size according to the default version of the resource, up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesAsStringsAsync

        public CompletableFuture<List<String>> getPagesAsStringsAsync​(String resourceName,
                                                              String version,
                                                              int numPages)
                                                       throws CompletionException
        Gets some number of pages for the given resource. Uses the default page size of the response body content length.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of Strings where each String in the list represents a page of data with the response content body length as the page size according to the requested version of the resource, up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesAsStringsAsync

        public CompletableFuture<List<String>> getPagesAsStringsAsync​(String resourceName,
                                                              int pageSize,
                                                              int numPages)
                                                       throws CompletionException
        Gets some number of pages for the given resource and page size. Uses the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        pageSize - The number of rows to include in each page (String) of the list returned.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of Strings where each String in the list represents a page of data with the given page size according to the default version of the resource, up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesAsStringsAsync

        public CompletableFuture<List<String>> getPagesAsStringsAsync​(String resourceName,
                                                              String version,
                                                              int pageSize,
                                                              int numPages)
                                                       throws CompletionException
        Gets some number of pages for the given resource, version, and page size.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page (String) of the list returned.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of Strings where each String in the list represents a page of data with the given page size according to the requested version of the resource, up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getPagesAsJsonNodesAsync​(String resourceName,
                                                                                                 int numPages)
                                                                                          throws CompletionException
        Gets some number of pages for the given resource. Uses the default page size of the response body content length, and the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a page of data with the response content body length as the page size according to the default version of the resource, up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getPagesAsJsonNodesAsync​(String resourceName,
                                                                                                 String version,
                                                                                                 int numPages)
                                                                                          throws CompletionException
        Gets some number of pages for the given resource and version. Uses the default page size of the response body content length.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a page of data with the response content body length as the page size according to the requested version of the resource, up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getPagesAsJsonNodesAsync​(String resourceName,
                                                                                                 int pageSize,
                                                                                                 int numPages)
                                                                                          throws CompletionException
        Gets some number of pages for the given resource and page size. Uses the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        pageSize - The number of rows to include in each page (JsonNode) of the list returned.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a page of data with the given page size according to the default version of the resource, up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getPagesAsJsonNodesAsync​(String resourceName,
                                                                                                 String version,
                                                                                                 int pageSize,
                                                                                                 int numPages)
                                                                                          throws CompletionException
        Gets some number of pages for the given resource, version, and page size.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page (JsonNode) of the list returned.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a page of data with the given page size according to the requested version of the resource, up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getPagesFromOffsetAsync​(String resourceName,
                                                                      int offset,
                                                                      int numPages)
                                                               throws CompletionException
        Gets some number of pages for the given resource from the given offset. Uses the default page size of the response body content length, and the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        offset - The 0 based index from which to begin paging for the given resource.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the response content body length as the page size according to the default version of the resource, beginning at the given offset index and up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getPagesFromOffsetAsync​(String resourceName,
                                                                      int pageSize,
                                                                      int offset,
                                                                      int numPages)
                                                               throws CompletionException
        Gets some number of pages for the given resource and page size from the given offset. Uses the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        offset - The 0 based index from which to begin paging for the given resource.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the given page size according to the default version of the resource, beginning at the given offset index and up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getPagesFromOffsetAsync​(String resourceName,
                                                                      String version,
                                                                      int offset,
                                                                      int numPages)
                                                               throws CompletionException
        Gets some number of pages for the given resource and version from the given offset. Uses the default page size of the response body content length.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        offset - The 0 based index from which to begin paging for the given resource.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the response content body length as the page size according to the requested version of the resource, beginning at the given offset index and up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getPagesFromOffsetAsync​(String resourceName,
                                                                      String version,
                                                                      int pageSize,
                                                                      int offset,
                                                                      int numPages)
                                                               throws CompletionException
        Gets some number of pages for the given resource, version, and page size, from the given offset. If both the offset and numPages are negative, all pages will be returned. If the offset is negative, pages up to the numPages will be returned. If numPages is negative, all pages from the offset will be returned.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        offset - The 0 based index from which to begin paging for the given resource.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the given page size according to the requested version of the resource, beginning at the given offset index and up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getPagesFromOffsetAsync​(String resourceName,
                                                                      String version,
                                                                      int pageSize,
                                                                      int offset,
                                                                      int numPages,
                                                                      Class classType)
                                                               throws CompletionException
        Gets some number of pages for the given resource, version, and page size, from the given offset. If both the offset and numPages are negative, all pages will be returned. If the offset is negative, pages up to the numPages will be returned. If numPages is negative, all pages from the offset will be returned. Returns the response bodies as generic type objects of the given class in each returned EthosResponse, if the classType is not null. If the classType is null, the returned EthosResponse will not contain a generic type object response body, but only a JSON formatted string response body.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        offset - The 0 based index from which to begin paging for the given resource.
        numPages - The number of pages of the given resource to return.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the given page size according to the requested version of the resource, beginning at the given offset index and up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getPagesFromOffsetAsync​(String resourceName,
                                                                      int offset,
                                                                      int numPages,
                                                                      Class classType)
                                                               throws CompletionException
        Gets some number of pages for the given resource from the given offset. Uses the default page size of the response body content length, and the default version of the resource. Returns the response bodies as generic type objects of the given class in each returned EthosResponse.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        offset - The 0 based index from which to begin paging for the given resource.
        numPages - The number of pages of the given resource to return.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the response content body length as the page size according to the default version of the resource, beginning at the given offset index and up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getPagesFromOffsetAsync​(String resourceName,
                                                                      int pageSize,
                                                                      int offset,
                                                                      int numPages,
                                                                      Class classType)
                                                               throws CompletionException
        Gets some number of pages for the given resource and page size from the given offset. Uses the default version of the resource. Returns the response bodies as generic type objects of the given class in each returned EthosResponse.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        offset - The 0 based index from which to begin paging for the given resource.
        numPages - The number of pages of the given resource to return.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the given page size according to the default version of the resource, beginning at the given offset index and up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getPagesFromOffsetAsync​(String resourceName,
                                                                      String version,
                                                                      int offset,
                                                                      int numPages,
                                                                      Class classType)
                                                               throws CompletionException
        Gets some number of pages for the given resource and version from the given offset. Uses the default page size of the response body content length. Returns the response bodies as generic type objects of the given class in each returned EthosResponse.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        offset - The 0 based index from which to begin paging for the given resource.
        numPages - The number of pages of the given resource to return.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the response content body length as the page size according to the requested version of the resource, beginning at the given offset index and up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesFromOffsetAsStringsAsync

        public CompletableFuture<List<String>> getPagesFromOffsetAsStringsAsync​(String resourceName,
                                                                        int offset,
                                                                        int numPages)
                                                                 throws CompletionException
        Gets some number of pages for the given resource from the given offset. Uses the default page size of the response body content length, and the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        offset - The 0 based index from which to begin paging for the given resource.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of Strings where each String in the list represents a page of data with the response content body length as the page size according to the default version of the resource, beginning at the given offset index and up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesFromOffsetAsStringsAsync

        public CompletableFuture<List<String>> getPagesFromOffsetAsStringsAsync​(String resourceName,
                                                                        int pageSize,
                                                                        int offset,
                                                                        int numPages)
                                                                 throws CompletionException
        Gets some number of pages for the given resource and page size from the given offset. Uses the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        pageSize - The number of rows to include in each page (String) of the list returned.
        offset - The 0 based index from which to begin paging for the given resource.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of Strings where each String in the list represents a page of data with the given page size according to the default version of the resource, beginning at the given offset index and up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesFromOffsetAsStringsAsync

        public CompletableFuture<List<String>> getPagesFromOffsetAsStringsAsync​(String resourceName,
                                                                        String version,
                                                                        int offset,
                                                                        int numPages)
                                                                 throws CompletionException
        Gets some number of pages for the given resource and version from the given offset. Uses the default page size of the response body content length.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        offset - The 0 based index from which to begin paging for the given resource.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of Strings where each String in the list represents a page of data with the response content body length as the page size according to the requested version of the resource, beginning at the given offset index and up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesFromOffsetAsStringsAsync

        public CompletableFuture<List<String>> getPagesFromOffsetAsStringsAsync​(String resourceName,
                                                                        String version,
                                                                        int pageSize,
                                                                        int offset,
                                                                        int numPages)
                                                                 throws CompletionException
        Gets some number of pages for the given resource, version, and page size, from the given offset.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page (String) of the list returned.
        offset - The 0 based index from which to begin paging for the given resource.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of Strings where each String in the list represents a page of data with the given page size according to the requested version of the resource, beginning at the given offset index and up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesFromOffsetAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getPagesFromOffsetAsJsonNodesAsync​(String resourceName,
                                                                                                           int offset,
                                                                                                           int numPages)
                                                                                                    throws CompletionException
        Gets some number of pages for the given resource from the given offset. Uses the default page size of the response body content length, and the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        offset - The 0 based index from which to begin paging for the given resource.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a page of data with the response content body length as the page size according to the default version of the resource, beginning at the given offset index and up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesFromOffsetAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getPagesFromOffsetAsJsonNodesAsync​(String resourceName,
                                                                                                           int pageSize,
                                                                                                           int offset,
                                                                                                           int numPages)
                                                                                                    throws CompletionException
        Gets some number of pages for the given resource and page size, from the given offset. Uses the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        pageSize - The number of rows to include in each page (JsonNode) of the list returned.
        offset - The 0 based index from which to begin paging for the given resource.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a page of data with the given page size according to the default version of the resource, beginning at the given offset index and up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesFromOffsetAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getPagesFromOffsetAsJsonNodesAsync​(String resourceName,
                                                                                                           String version,
                                                                                                           int offset,
                                                                                                           int numPages)
                                                                                                    throws CompletionException
        Gets some number of pages for the given resource and version, from the given offset. Uses the default page size of the response body content length.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        offset - The 0 based index from which to begin paging for the given resource.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a page of data with the response content body length as the page size according to the requested version of the resource, beginning at the given offset index and up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getPagesFromOffsetAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getPagesFromOffsetAsJsonNodesAsync​(String resourceName,
                                                                                                           String version,
                                                                                                           int pageSize,
                                                                                                           int offset,
                                                                                                           int numPages)
                                                                                                    throws CompletionException
        Gets some number of pages for the given resource, version, and page size, from the given offset.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page (JsonNode) of the list returned.
        offset - The 0 based index from which to begin paging for the given resource.
        numPages - The number of pages of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a page of data with given page size according to the requested version of the resource, beginning at the given offset index and up to the number of pages specified or the max number of pages (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsAsync

        public CompletableFuture<List<EthosResponse>> getRowsAsync​(String resourceName,
                                                           int numRows)
                                                    throws CompletionException
        Gets some number of rows for the given resource. The number of rows is returned as a paged-based list of EthosResponses, altogether containing the number of rows. Uses the default page size of the response body content length, and the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the response content body length as the page size according to the default version of the resource, up to the number of rows specified or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsAsync

        public CompletableFuture<List<EthosResponse>> getRowsAsync​(String resourceName,
                                                           String version,
                                                           int numRows)
                                                    throws CompletionException
        Gets some number of rows for the given resource and version. The number of rows is returned as a paged-based list of EthosResponses, altogether containing the number of rows. Uses the default page size of the response body content length.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the response content body length as the page size according to the requested version of the resource, up to the number of rows specified or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsAsync

        public CompletableFuture<List<EthosResponse>> getRowsAsync​(String resourceName,
                                                           int pageSize,
                                                           int numRows)
                                                    throws CompletionException
        Gets some number of rows for the given resource and page size. The number of rows is returned as a paged-based list of EthosResponses, altogether containing the number of rows. Uses the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the given page size according to the default version of the resource, up to the number of rows specified or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsAsync

        public CompletableFuture<List<EthosResponse>> getRowsAsync​(String resourceName,
                                                           String version,
                                                           int pageSize,
                                                           int numRows)
                                                    throws CompletionException
        Gets some number of rows for the given resource, version, and page size. The number of rows is returned as a paged-based list of EthosResponses, altogether containing the number of rows. If numRows is negative, all pages will be returned.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the given page size according to the requested version of the resource, up to the number of rows specified or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsAsync

        public CompletableFuture<List<EthosResponse>> getRowsAsync​(String resourceName,
                                                           String version,
                                                           int pageSize,
                                                           int numRows,
                                                           Class classType)
                                                    throws CompletionException
        Gets some number of rows for the given resource, version, and page size. The number of rows is returned as a paged-based list of EthosResponses, altogether containing the number of rows. If numRows is negative, all pages will be returned. Returns the response bodies as generic type objects of the given class in each returned EthosResponse, if the classType is not null. If the classType is null, the returned EthosResponse will not contain a generic type object response body, but only a JSON formatted string response body.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        numRows - The number of rows of the given resource to return.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the given page size according to the requested version of the resource, up to the number of rows specified or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsAsync

        public CompletableFuture<List<EthosResponse>> getRowsAsync​(String resourceName,
                                                           int numRows,
                                                           Class classType)
                                                    throws CompletionException
        Gets some number of rows for the given resource. The number of rows is returned as a paged-based list of EthosResponses, altogether containing the number of rows. Uses the default page size of the response body content length, and the default version of the resource. Returns the response bodies as generic type objects of the given class in each returned EthosResponse.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        numRows - The number of rows of the given resource to return.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the response content body length as the page size according to the default version of the resource, up to the number of rows specified or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsAsync

        public CompletableFuture<List<EthosResponse>> getRowsAsync​(String resourceName,
                                                           String version,
                                                           int numRows,
                                                           Class classType)
                                                    throws CompletionException
        Gets some number of rows for the given resource and version. The number of rows is returned as a paged-based list of EthosResponses, altogether containing the number of rows. Uses the default page size of the response body content length. Returns the response bodies as generic type objects of the given class in each returned EthosResponse.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        numRows - The number of rows of the given resource to return.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the response content body length as the page size according to the requested version of the resource, up to the number of rows specified or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsAsync

        public CompletableFuture<List<EthosResponse>> getRowsAsync​(String resourceName,
                                                           int pageSize,
                                                           int numRows,
                                                           Class classType)
                                                    throws CompletionException
        Gets some number of rows for the given resource and page size. The number of rows is returned as a paged-based list of EthosResponses, altogether containing the number of rows. Uses the default version of the resource. Returns the response bodies as generic type objects of the given class in each returned EthosResponse.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        numRows - The number of rows of the given resource to return.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the given page size according to the default version of the resource, up to the number of rows specified or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsAsStringsAsync

        public CompletableFuture<List<String>> getRowsAsStringsAsync​(String resourceName,
                                                             int numRows)
                                                      throws CompletionException
        Gets some number of rows for the given resource. The number of rows is returned as a row-based list of Strings, the size of which is the number of rows requested. Uses the default version of the resource, and the default page size of the response body content length during internal paging operations.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JSON formatted Strings where each String in the list represents a row (or individual instance) of a resource, where the length of the list returned is the number of rows requested or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsAsStringsAsync

        public CompletableFuture<List<String>> getRowsAsStringsAsync​(String resourceName,
                                                             String version,
                                                             int numRows)
                                                      throws CompletionException
        Gets some number of rows for the given resource. The number of rows is returned as a row-based list of Strings, the size of which is the number of rows requested. Uses the default page size of the response body content length during internal paging operations.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JSON formatted Strings where each String in the list represents a row (or individual instance) of a resource, where the length of the list returned is the number of rows requested or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsAsStringsAsync

        public CompletableFuture<List<String>> getRowsAsStringsAsync​(String resourceName,
                                                             int pageSize,
                                                             int numRows)
                                                      throws CompletionException
        Gets some number of rows for the given resource and page size. The number of rows is returned as a row-based list of Strings, the size of which is the number of rows requested. Uses the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        pageSize - The number of rows to include in each page during execution of paging operations. This value is used internally by the SDK during paging operations.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JSON formatted Strings where each String in the list represents a row (or individual instance) of a resource, where the length of the list returned is the number of rows requested or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsAsStringsAsync

        public CompletableFuture<List<String>> getRowsAsStringsAsync​(String resourceName,
                                                             String version,
                                                             int pageSize,
                                                             int numRows)
                                                      throws CompletionException
        Gets some number of rows for the given resource, version, and page size. The number of rows is returned as a row-based list of Strings, the size of which is the number of rows requested.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page during execution of paging operations. This value is used internally by the SDK during paging operations.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JSON formatted Strings where each String in the list represents a row (or individual instance) of a resource, where the length of the list returned is the number of rows requested or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getRowsAsJsonNodesAsync​(String resourceName,
                                                                                                int numRows)
                                                                                         throws CompletionException
        Gets some number of rows for the given resource. The number of rows is returned as a row-based list of JsonNodes, the size of which is the number of rows requested. Uses the default version of the resource, and the default page size of the response body content length during internal paging operations.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a row (or individual instance) of a resource, where the length of the list returned is the number of rows requested or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getRowsAsJsonNodesAsync​(String resourceName,
                                                                                                String version,
                                                                                                int numRows)
                                                                                         throws CompletionException
        Gets some number of rows for the given resource and version. The number of rows is returned as a row-based list of JsonNodes, the size of which is the number of rows requested. Uses the default page size of the response body content length during internal paging operations.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a row (or individual instance) of a resource, where the length of the list returned is the number of rows requested or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getRowsAsJsonNodesAsync​(String resourceName,
                                                                                                int pageSize,
                                                                                                int numRows)
                                                                                         throws CompletionException
        Gets some number of rows for the given resource and page size. The number of rows is returned as a row-based list of JsonNodes, the size of which is the number of rows requested. Uses the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        pageSize - The number of rows to include in each page during execution of paging operations. This value is used internally by the SDK during paging operations.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a row (or individual instance) of a resource, where the length of the list returned is the number of rows requested or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getRowsAsJsonNodesAsync​(String resourceName,
                                                                                                String version,
                                                                                                int pageSize,
                                                                                                int numRows)
                                                                                         throws CompletionException
        Gets some number of rows for the given resource, version, and page size. The number of rows is returned as a row-based list of JsonNodes, the size of which is the number of rows requested.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page during execution of paging operations. This value is used internally by the SDK during paging operations.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a row (or individual instance) of a resource, where the length of the list returned is the number of rows requested or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getRowsFromOffsetAsync​(String resourceName,
                                                                     int offset,
                                                                     int numRows)
                                                              throws CompletionException
        Gets some number of rows for the given resource from the given offset. The number of rows is returned in a list of pages altogether containing the number of rows. Uses the default page size of the response body content length and the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        offset - The 0 based index from which to begin paging for the given resource.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the response content body length as the page size according to the default version of the resource, beginning at the given offset index and up to the number of rows specified or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getRowsFromOffsetAsync​(String resourceName,
                                                                     int pageSize,
                                                                     int offset,
                                                                     int numRows)
                                                              throws CompletionException
        Gets some number of rows for the given resource and page size from the given offset. The number of rows is returned in a list of pages altogether containing the number of rows. Uses the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        offset - The 0 based index from which to begin paging for the given resource.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the given page size according to the default version of the resource, beginning at the given offset index and up to the number of rows specified or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getRowsFromOffsetAsync​(String resourceName,
                                                                     String version,
                                                                     int offset,
                                                                     int numRows)
                                                              throws CompletionException
        Gets some number of rows for the given resource and version from the given offset. The number of rows is returned in a list of pages altogether containing the number of rows. Uses the default page size of the response body content length.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        offset - The 0 based index from which to begin paging for the given resource.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the response content body length as the page size according to the requested version of the resource, beginning at the given offset index and up to the number of rows specified or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getRowsFromOffsetAsync​(String resourceName,
                                                                     String version,
                                                                     int pageSize,
                                                                     int offset,
                                                                     int numRows)
                                                              throws CompletionException
        Gets some number of rows for the given resource, version, and page size, from the given offset. The number of rows is returned in a list of pages altogether containing the number of rows. If both the offset and numRows are negative, all pages will be returned. If the offset is negative, pages up to the numRows will be returned. If numRows is negative, all pages from the offset will be returned.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        offset - The 0 based index from which to begin paging for the given resource.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the given page size according to the requested version of the resource, beginning at the given offset index and up to the number of rows specified or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getRowsFromOffsetAsync​(String resourceName,
                                                                     String version,
                                                                     int pageSize,
                                                                     int offset,
                                                                     int numRows,
                                                                     Class classType)
                                                              throws CompletionException
        Gets some number of rows for the given resource, version, and page size, from the given offset. The number of rows is returned in a list of pages altogether containing the number of rows. If both the offset and numRows are negative, all pages will be returned. If the offset is negative, pages up to the numRows will be returned. If numRows is negative, all pages from the offset will be returned. Returns the response bodies as generic type objects of the given class in each returned EthosResponse, if the classType is not null. If the classType is null, the returned EthosResponse will not contain a generic type object response body, but only a JSON formatted string response body.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        offset - The 0 based index from which to begin paging for the given resource.
        numRows - The number of rows of the given resource to return.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the given page size according to the requested version of the resource, beginning at the given offset index and up to the number of rows specified or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getRowsFromOffsetAsync​(String resourceName,
                                                                     int offset,
                                                                     int numRows,
                                                                     Class classType)
                                                              throws CompletionException
        Gets some number of rows for the given resource from the given offset. The number of rows is returned in a list of pages altogether containing the number of rows. Uses the default page size of the response body content length and the default version of the resource. Returns the response bodies as generic type objects of the given class in each returned EthosResponse.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        offset - The 0 based index from which to begin paging for the given resource.
        numRows - The number of rows of the given resource to return.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the response content body length as the page size according to the default version of the resource, beginning at the given offset index and up to the number of rows specified or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getRowsFromOffsetAsync​(String resourceName,
                                                                     int pageSize,
                                                                     int offset,
                                                                     int numRows,
                                                                     Class classType)
                                                              throws CompletionException
        Gets some number of rows for the given resource and page size from the given offset. The number of rows is returned in a list of pages altogether containing the number of rows. Uses the default version of the resource. Returns the response bodies as generic type objects of the given class in each returned EthosResponse.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        pageSize - The number of rows to include in each page (EthosResponse) of the list returned.
        offset - The 0 based index from which to begin paging for the given resource.
        numRows - The number of rows of the given resource to return.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the given page size according to the default version of the resource, beginning at the given offset index and up to the number of rows specified or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsFromOffsetAsync

        public CompletableFuture<List<EthosResponse>> getRowsFromOffsetAsync​(String resourceName,
                                                                     String version,
                                                                     int offset,
                                                                     int numRows,
                                                                     Class classType)
                                                              throws CompletionException
        Gets some number of rows for the given resource and version from the given offset. The number of rows is returned in a list of pages altogether containing the number of rows. Uses the default page size of the response body content length. Returns the response bodies as generic type objects of the given class in each returned EthosResponse.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        offset - The 0 based index from which to begin paging for the given resource.
        numRows - The number of rows of the given resource to return.
        classType - The class of the generic type object containing the response body to return within the EthosResponse.
        Returns:
        A CompletableFuture wrapping a list of EthosResponses where each EthosResponse in the list represents a page of data with the response content body length as the page size according to the requested version of the resource, beginning at the given offset index and up to the number of rows specified or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsFromOffsetAsStringsAsync

        public CompletableFuture<List<String>> getRowsFromOffsetAsStringsAsync​(String resourceName,
                                                                       int offset,
                                                                       int numRows)
                                                                throws CompletionException
        Gets some number of rows for the given resource from the given offset. The number of rows is returned as a row-based list of Strings, the size of which is the number of rows requested. Uses the default page size of the response body content length during internal paging operations, and the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        offset - The 0 based index from which to begin paging for the given resource.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JSON formatted Strings where each String in the list represents a row (or individual instance) of a resource, where the length of the list returned is the number of rows requested or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsFromOffsetAsStringsAsync

        public CompletableFuture<List<String>> getRowsFromOffsetAsStringsAsync​(String resourceName,
                                                                       int pageSize,
                                                                       int offset,
                                                                       int numRows)
                                                                throws CompletionException
        Gets some number of rows for the given resource and page size, from the given offset. The number of rows is returned as a row-based list of Strings, the size of which is the number of rows requested. Uses the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        pageSize - The number of rows to include in each page during execution of paging operations. This value is used internally by the SDK during paging operations.
        offset - The 0 based index from which to begin paging for the given resource.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JSON formatted Strings where each String in the list represents a row (or individual instance) of a resource, where the length of the list returned is the number of rows requested or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsFromOffsetAsStringsAsync

        public CompletableFuture<List<String>> getRowsFromOffsetAsStringsAsync​(String resourceName,
                                                                       String version,
                                                                       int offset,
                                                                       int numRows)
                                                                throws CompletionException
        Gets some number of rows for the given resource and version, from the given offset. The number of rows is returned as a row-based list of Strings, the size of which is the number of rows requested. Uses the default page size of the response body content length during internal paging operations.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        offset - The 0 based index from which to begin paging for the given resource.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JSON formatted Strings where each String in the list represents a row (or individual instance) of a resource, where the length of the list returned is the number of rows requested or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsFromOffsetAsStringsAsync

        public CompletableFuture<List<String>> getRowsFromOffsetAsStringsAsync​(String resourceName,
                                                                       String version,
                                                                       int pageSize,
                                                                       int offset,
                                                                       int numRows)
                                                                throws CompletionException
        Gets some number of rows for the given resource, version, and page size, from the given offset. The number of rows is returned as a row-based list of Strings, the size of which is the number of rows requested.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page during execution of paging operations. This value is used internally by the SDK during paging operations.
        offset - The 0 based index from which to begin paging for the given resource.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JSON formatted Strings where each String in the list represents a row (or individual instance) of a resource, where the length of the list returned is the number of rows requested or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsFromOffsetAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getRowsFromOffsetAsJsonNodesAsync​(String resourceName,
                                                                                                          int offset,
                                                                                                          int numRows)
                                                                                                   throws CompletionException
        Gets some number of rows for the given resource from the given offset. The number of rows is returned as a row-based list of JsonNodes, the size of which is the number of rows requested. Uses the default page size of the response body content length during internal paging operations, and the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        offset - The 0 based index from which to begin paging for the given resource.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a row (or individual instance) of a resource, where the length of the list returned is the number of rows requested or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsFromOffsetAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getRowsFromOffsetAsJsonNodesAsync​(String resourceName,
                                                                                                          int pageSize,
                                                                                                          int offset,
                                                                                                          int numRows)
                                                                                                   throws CompletionException
        Gets some number of rows for the given resource and page size, from the given offset. The number of rows is returned as a row-based list of JsonNodes, the size of which is the number of rows requested. Uses the default version of the resource.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        pageSize - The number of rows to include in each page during execution of paging operations. This value is used internally by the SDK during paging operations.
        offset - The 0 based index from which to begin paging for the given resource.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a row (or individual instance) of a resource, where the length of the list returned is the number of rows requested or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsFromOffsetAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getRowsFromOffsetAsJsonNodesAsync​(String resourceName,
                                                                                                          String version,
                                                                                                          int offset,
                                                                                                          int numRows)
                                                                                                   throws CompletionException
        Gets some number of rows for the given resource and version, from the given offset. The number of rows is returned as a row-based list of JsonNodes, the size of which is the number of rows requested. Uses the default page size of the response body content length during internal paging operations.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        offset - The 0 based index from which to begin paging for the given resource.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a row (or individual instance) of a resource, where the length of the list returned is the number of rows requested or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.

      • getRowsFromOffsetAsJsonNodesAsync

        public CompletableFuture<List<com.fasterxml.jackson.databind.JsonNode>> getRowsFromOffsetAsJsonNodesAsync​(String resourceName,
                                                                                                          String version,
                                                                                                          int pageSize,
                                                                                                          int offset,
                                                                                                          int numRows)
                                                                                                   throws CompletionException
        Gets some number of rows for the given resource, version, and page size, from the given offset. The number of rows is returned as a row-based list of JsonNodes, the size of which is the number of rows requested.
        Parameters:
        resourceName - The name of the Ethos resource to get data for.
        version - The desired resource version header to use, as provided in the HTTP Accept Header of the request.
        pageSize - The number of rows to include in each page during execution of paging operations. This value is used internally by the SDK during paging operations.
        offset - The 0 based index from which to begin paging for the given resource.
        numRows - The number of rows of the given resource to return.
        Returns:
        A CompletableFuture wrapping a list of JsonNodes where each JsonNode in the list represents a row (or individual instance) of a resource, where the length of the list returned is the number of rows requested or the total count of the resource (whichever is less).
        Throws:
        CompletionException - Propagates a wrapped IOException if it occurs when making the call in the EthosClient.