com.algorithmia.algo

Class Algorithm

java.lang.Object

com.algorithmia.algo.Algorithm

public class Algorithm
extends java.lang.Object

Represents an Algorithmia algorithm that can be called.

Constructor Summary

Constructors

Constructor and Description
Algorithm(HttpClient client, AlgorithmRef algoRef)

Method Summary

Modifier and Type	Method and Description
AlgoResponse	pipe(java.lang.Object input) Calls the Algorithmia API on a given input.
FutureAlgoResponse	pipeAsync(java.lang.Object input) Calls the Algorithmia API on a given input asynchronously.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Algorithm

public Algorithm(HttpClient client,
                 AlgorithmRef algoRef)

Method Detail

pipe

public AlgoResponse pipe(java.lang.Object input)
                  throws APIException

Calls the Algorithmia API on a given input. Attempts to automatically format the input as JSON.

Parameters:

input - algorithm input, will automatically be converted into JSON

Returns:

algorithm result (AlgoSuccess or AlgoFailure)

Throws:

APIException - if there is a problem communication with the Algorithmia API.

pipeAsync

public FutureAlgoResponse pipeAsync(java.lang.Object input)

Calls the Algorithmia API on a given input asynchronously. The future response will complete when the algorithm has completed or errored

Parameters:

input - algorithm input, will automatically be converted into JSON

Returns:

future algorithm result (AlgoSuccess or AlgoFailure)