Class ApiConnection


  • public class ApiConnection
    extends java.lang.Object
    The ApiConnection object is responsible for low-level HTTP requests and mapping JSON responses to POJO objects. It is not meant to be used directly.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String JSON_TYPE  
    • Constructor Summary

      Constructors 
      Constructor Description
      ApiConnection​(java.lang.String endpoint, java.lang.String key, IDataRobotAIClient client)
      The ApiConnection object is responsible for low-level HTTP requests /responses and mapping JSON responses to POJO objects.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void delete​(java.lang.String path, java.util.Map<java.lang.String,​java.lang.Object> parameters, Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)  
      <T> T get​(java.lang.Class<T> type, java.lang.String path, java.util.Map<java.lang.String,​java.lang.Object> parameters, Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)  
      <T> T get​(java.lang.Class<T> type, java.lang.String path, java.util.Map<java.lang.String,​java.lang.Object> parameters, Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer, java.lang.String acceptType)  
      void get​(java.lang.String path, java.util.Map<java.lang.String,​java.lang.Object> parameters, Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer, java.io.OutputStream output)  
      void get​(java.lang.String path, java.util.Map<java.lang.String,​java.lang.Object> parameters, Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer, java.io.OutputStream output, java.lang.String acceptType)  
      com.google.api.client.http.HttpHeaders head​(java.lang.String path, java.util.Map<java.lang.String,​java.lang.Object> parameters, Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)  
      <T> T makeRequest​(java.lang.Class<T> type, com.google.api.client.http.HttpRequest request, Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)  
      <T> T post​(java.lang.Class<T> type, java.lang.String path, java.util.Map<java.lang.String,​java.lang.Object> parameters, java.lang.Object body, Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)  
      <T> T postFile​(java.lang.Class<T> type, java.lang.String path, java.util.Map<java.lang.String,​java.lang.Object> parameters, java.lang.String streamName, java.io.InputStream body, java.lang.String contentType, Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)  
      <T> T postStream​(java.lang.Class<T> type, java.lang.String path, java.util.Map<java.lang.String,​java.lang.Object> parameters, java.io.File body, java.lang.String contentType, Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)  
      <T> T put​(java.lang.Class<T> type, java.lang.String path, java.util.Map<java.lang.String,​java.lang.Object> parameters, java.lang.Object body, Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)  
      <T> T putFile​(java.lang.Class<T> type, java.lang.String path, java.util.Map<java.lang.String,​java.lang.Object> parameters, java.io.InputStream body, java.lang.String streamName, java.lang.String contentType, Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)  
      <T> T putStream​(java.lang.Class<T> type, java.lang.String path, java.util.Map<java.lang.String,​java.lang.Object> parameters, java.io.File body, java.lang.String contentType, Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ApiConnection

        public ApiConnection​(java.lang.String endpoint,
                             java.lang.String key,
                             IDataRobotAIClient client)
        The ApiConnection object is responsible for low-level HTTP requests /responses and mapping JSON responses to POJO objects.
        Parameters:
        endpoint - The URL of the DataRobot AI API.
        key - The API key used in the Authorization header to gain access to the DataRobot AI API.
        client - A reference to the DataRobot AI API Client so it can assign it to models
    • Method Detail

      • get

        public void get​(java.lang.String path,
                        java.util.Map<java.lang.String,​java.lang.Object> parameters,
                        Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer,
                        java.io.OutputStream output)
                 throws ClientException
        Throws:
        ClientException
      • get

        public void get​(java.lang.String path,
                        java.util.Map<java.lang.String,​java.lang.Object> parameters,
                        Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer,
                        java.io.OutputStream output,
                        java.lang.String acceptType)
                 throws ClientException
        Throws:
        ClientException
      • get

        public <T> T get​(java.lang.Class<T> type,
                         java.lang.String path,
                         java.util.Map<java.lang.String,​java.lang.Object> parameters,
                         Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)
                  throws ClientException
        Throws:
        ClientException
      • get

        public <T> T get​(java.lang.Class<T> type,
                         java.lang.String path,
                         java.util.Map<java.lang.String,​java.lang.Object> parameters,
                         Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer,
                         java.lang.String acceptType)
                  throws ClientException
        Throws:
        ClientException
      • head

        public com.google.api.client.http.HttpHeaders head​(java.lang.String path,
                                                           java.util.Map<java.lang.String,​java.lang.Object> parameters,
                                                           Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)
                                                    throws ClientException
        Throws:
        ClientException
      • put

        public <T> T put​(java.lang.Class<T> type,
                         java.lang.String path,
                         java.util.Map<java.lang.String,​java.lang.Object> parameters,
                         java.lang.Object body,
                         Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)
                  throws ClientException
        Throws:
        ClientException
      • putFile

        public <T> T putFile​(java.lang.Class<T> type,
                             java.lang.String path,
                             java.util.Map<java.lang.String,​java.lang.Object> parameters,
                             java.io.InputStream body,
                             java.lang.String streamName,
                             java.lang.String contentType,
                             Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)
                      throws ClientException
        Throws:
        ClientException
      • putStream

        public <T> T putStream​(java.lang.Class<T> type,
                               java.lang.String path,
                               java.util.Map<java.lang.String,​java.lang.Object> parameters,
                               java.io.File body,
                               java.lang.String contentType,
                               Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)
                        throws ClientException
        Throws:
        ClientException
      • post

        public <T> T post​(java.lang.Class<T> type,
                          java.lang.String path,
                          java.util.Map<java.lang.String,​java.lang.Object> parameters,
                          java.lang.Object body,
                          Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)
                   throws ClientException
        Throws:
        ClientException
      • postStream

        public <T> T postStream​(java.lang.Class<T> type,
                                java.lang.String path,
                                java.util.Map<java.lang.String,​java.lang.Object> parameters,
                                java.io.File body,
                                java.lang.String contentType,
                                Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)
                         throws ClientException
        Throws:
        ClientException
      • postFile

        public <T> T postFile​(java.lang.Class<T> type,
                              java.lang.String path,
                              java.util.Map<java.lang.String,​java.lang.Object> parameters,
                              java.lang.String streamName,
                              java.io.InputStream body,
                              java.lang.String contentType,
                              Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)
                       throws ClientException
        Throws:
        ClientException
      • delete

        public void delete​(java.lang.String path,
                           java.util.Map<java.lang.String,​java.lang.Object> parameters,
                           Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)
                    throws ClientException
        Throws:
        ClientException
      • makeRequest

        public <T> T makeRequest​(java.lang.Class<T> type,
                                 com.google.api.client.http.HttpRequest request,
                                 Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)
                          throws ClientException
        Throws:
        ClientException