Class AlgorithmiaClient


  • public final class AlgorithmiaClient
    extends java.lang.Object
    Instantiate Algorithmia clients for calling algorithms and accessing data
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected AlgorithmiaClient​(Auth auth, java.lang.String apiAddress, int maxConnections)
      Instantiate Algorithmia client with the given auth and max number of connections
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Algorithm algo​(java.lang.String algoUri)
      Initialize an Algorithm object from this client
      void close()  
      DataDirectory dir​(java.lang.String path)
      Initialize a DataDirectory object from this client
      DataFile file​(java.lang.String path)
      Initialize an DataFile object from this client
      • Methods inherited from class java.lang.Object

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

      • AlgorithmiaClient

        protected AlgorithmiaClient​(Auth auth,
                                    java.lang.String apiAddress,
                                    int maxConnections)
        Instantiate Algorithmia client with the given auth and max number of connections
        Parameters:
        auth - Algorithmia Auth object, a null auth object is valid, though only correct for within the Algorithmia platform
        maxConnections -
    • Method Detail

      • algo

        public Algorithm algo​(java.lang.String algoUri)
        Initialize an Algorithm object from this client
        Parameters:
        algoUri - the algorithm's URI, e.g., algo://user/algoname
        Returns:
        an Algorithm client for the specified algorithm
      • dir

        public DataDirectory dir​(java.lang.String path)
        Initialize a DataDirectory object from this client
        Parameters:
        path - to a data directory, e.g., data://.my/foo
        Returns:
        a DataDirectory client for the specified directory
      • file

        public DataFile file​(java.lang.String path)
        Initialize an DataFile object from this client
        Parameters:
        path - to a data file, e.g., data://.my/foo/bar.txt
        Returns:
        a DataFile client for the specified file
      • close

        public void close()
                   throws java.io.IOException
        Throws:
        java.io.IOException