com.algorithmia.algo

Class Algorithm

java.lang.Object

com.algorithmia.algo.Algorithm

public final 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 for a given input.
FutureAlgoResponse	pipeAsync(java.lang.Object input) Calls the Algorithmia API asynchronously for a given input.
AlgoResponse	pipeJson(java.lang.String inputJson) Calls the Algorithmia API for given input that will be treated as JSON
FutureAlgoResponse	pipeJsonAsync(java.lang.String inputJson) Calls the Algorithmia API asynchronously for given input that will be treated as JSON The future response will complete when the algorithm has completed or errored

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 for a given input. Attempts to automatically serialize the input to 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 asynchronously for a given input. Attempts to automatically serialize the input to JSON. 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)

pipeJson

public AlgoResponse pipeJson(java.lang.String inputJson)
                      throws APIException

Calls the Algorithmia API for given input that will be treated as JSON

Parameters:

inputJson - json input value

Returns:

success or failure

Throws:

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

pipeJsonAsync

public FutureAlgoResponse pipeJsonAsync(java.lang.String inputJson)

Calls the Algorithmia API asynchronously for given input that will be treated as JSON The future response will complete when the algorithm has completed or errored

Parameters:

inputJson - json input value

Returns:

success or failure