Index

A B C D E F G H I J L M N O P R S T V

A

AbstractDataIterator<T> - Class in com.algorithmia.data
AbstractDataIterator(DataDirectory) - Constructor for class com.algorithmia.data.AbstractDataIterator
algo(String) - Static method in class com.algorithmia.Algorithmia: Initialize an Algorithm object using the default client
algo(String) - Method in class com.algorithmia.AlgorithmiaClient: Initialize an Algorithm object from this client
AlgoFailure - Class in com.algorithmia.algo: A result representing failure
AlgoFailure(AlgorithmException) - Constructor for class com.algorithmia.algo.AlgoFailure
AlgoResponse - Class in com.algorithmia.algo: A generic result, can be either AlgoSuccess or AlgoFailure
AlgoResponse() - Constructor for class com.algorithmia.algo.AlgoResponse
Algorithm - Class in com.algorithmia.algo: Represents an Algorithmia algorithm that can be called.
Algorithm(HttpClient, AlgorithmRef) - Constructor for class com.algorithmia.algo.Algorithm
AlgorithmException - Exception in com.algorithmia: AlgorithmExceptions indicate an problem when running an algorithm.
AlgorithmException(String) - Constructor for exception com.algorithmia.AlgorithmException: Constructs a new algorithm exception with the specified detail message, no stack trace.
AlgorithmException(String, Throwable) - Constructor for exception com.algorithmia.AlgorithmException: Constructs a new algorithm exception with the specified detail message and cause.
AlgorithmException(Throwable) - Constructor for exception com.algorithmia.AlgorithmException: Constructs a new algorithm exception from an existing exception
AlgorithmException(String, AlgorithmException, String) - Constructor for exception com.algorithmia.AlgorithmException: Constructs a new algorithm exception from an exception message and stacktrace
Algorithmia - Class in com.algorithmia: Instantiate Algorithmia clients for calling algorithms and accessing data
AlgorithmiaClient - Class in com.algorithmia: Instantiate Algorithmia clients for calling algorithms and accessing data
AlgorithmiaClient() - Constructor for class com.algorithmia.AlgorithmiaClient: Instantiate Algorithmia client without credentials This only works for when running the client on top of the Algorithmia platform
AlgorithmiaClient(Auth) - Constructor for class com.algorithmia.AlgorithmiaClient: Instantiate Algorithmia client with auth
AlgorithmiaConf - Class in com.algorithmia: Stores configuration for the Algorithmia client library
AlgorithmRef - Class in com.algorithmia.algo: A reference to an algorithm and possibly a specific version.
AlgorithmRef(String) - Constructor for class com.algorithmia.algo.AlgorithmRef: Build an AlgorithmRef from an algorithm url like "/user/algo/version"
AlgoSuccess - Class in com.algorithmia.algo: A result representing success
AlgoSuccess(JsonElement, Metadata) - Constructor for class com.algorithmia.algo.AlgoSuccess
algoUri - Variable in class com.algorithmia.algo.AlgorithmRef
apiAddress() - Static method in class com.algorithmia.AlgorithmiaConf: Returns the base address of the API server (https://api.algorithmia.com)
APIException - Exception in com.algorithmia: APIException indicates a problem communicating with Algorithmia
APIException(String) - Constructor for exception com.algorithmia.APIException: Constructs a new API exception with the specified detail message, no stack trace.
APIException(String, Throwable) - Constructor for exception com.algorithmia.APIException: Constructs a new API exception with the specified detail message and cause.
apiKey() - Static method in class com.algorithmia.AlgorithmiaConf
as(Class<T>) - Method in class com.algorithmia.algo.AlgoFailure
as(Type) - Method in class com.algorithmia.algo.AlgoFailure
as(Class<T>) - Method in class com.algorithmia.algo.AlgoResponse: Convert the result to a specific class
as(Type) - Method in class com.algorithmia.algo.AlgoResponse: Convert the result to a specific type
as(TypeToken) - Method in class com.algorithmia.algo.AlgoResponse: Convert the result to a specific type.
as(Class<T>) - Method in class com.algorithmia.algo.AlgoSuccess
as(Type) - Method in class com.algorithmia.algo.AlgoSuccess
asJsonString() - Method in class com.algorithmia.algo.AlgoFailure
asJsonString() - Method in class com.algorithmia.algo.AlgoResponse: Return JSON representation of the result.
asJsonString() - Method in class com.algorithmia.algo.AlgoSuccess
asString() - Method in class com.algorithmia.algo.AlgoFailure
asString() - Method in class com.algorithmia.algo.AlgoResponse: Return String representation of the result.
asString() - Method in class com.algorithmia.algo.AlgoSuccess
Auth - Class in com.algorithmia.client: A result representing success
Auth() - Constructor for class com.algorithmia.client.Auth
authenticateRequest(HttpRequest) - Method in class com.algorithmia.client.Auth
authenticateRequest(HttpRequest) - Method in class com.algorithmia.client.SimpleAuth

B

buildResult(HttpContext) - Method in class com.algorithmia.client.HttpClientHelpers.AlgoResponseHandler
buildResult(HttpContext) - Method in class com.algorithmia.client.HttpClientHelpers.JsonDeserializeResponseHandler

C

cancel(boolean) - Method in class com.algorithmia.algo.FutureAlgoResponse
children - Variable in class com.algorithmia.data.AbstractDataIterator
client() - Static method in class com.algorithmia.Algorithmia: Returns the default Algorithmia client which will look for ALGORITHMI_API_KEY environment variable or java property If no key is found, then requests will be unauthenticated which only works when making requests from an algorithm running within the Algorithmia cluster
client(String) - Static method in class com.algorithmia.Algorithmia: Builds an Algorithmia client that makes all requests with your API key If API key is null, the default client is returned, which will look for ALGORITHMI_API_KEY environment variable or java property If no key is found, then requests will be unauthenticated which only works when making requests from an algorithm running within the Algorithmia cluster
client - Variable in class com.algorithmia.data.DataObject
com.algorithmia - package com.algorithmia: Package for leveraging Algorithmia's algorithm marketplace and data APIs
com.algorithmia.algo - package com.algorithmia.algo: Provides objects and methods for interacting with Algorithmia algorithms
com.algorithmia.client - package com.algorithmia.client: The internal client used for interacting with the Algorithmia API
com.algorithmia.data - package com.algorithmia.data: Provides objects and methods for interacting with Algorithmia data
ContentType - Enum in com.algorithmia.algo
create() - Method in class com.algorithmia.data.DataDirectory: Creates this directory via the Algorithmia Data API

D

DataDirectory - Class in com.algorithmia.data: A data stream
DataDirectory(HttpClient, String) - Constructor for class com.algorithmia.data.DataDirectory
DataDirectory.DirectoryListResponse - Class in com.algorithmia.data
DataDirectory.DirectoryListResponse(List<DataDirectory.FileMetadata>, List<DataDirectory.DirectoryMetadata>) - Constructor for class com.algorithmia.data.DataDirectory.DirectoryListResponse
DataDirectory.DirectoryMetadata - Class in com.algorithmia.data
DataDirectory.DirectoryMetadata(String) - Constructor for class com.algorithmia.data.DataDirectory.DirectoryMetadata
DataDirectory.FileMetadata - Class in com.algorithmia.data
DataDirectory.FileMetadata(String) - Constructor for class com.algorithmia.data.DataDirectory.FileMetadata
DataDirectoryIterator - Class in com.algorithmia.data
DataDirectoryIterator(DataDirectory) - Constructor for class com.algorithmia.data.DataDirectoryIterator
DataFile - Class in com.algorithmia.data: A reference to a file in the data api
DataFile(HttpClient, String) - Constructor for class com.algorithmia.data.DataFile
DataFileIterator - Class in com.algorithmia.data
DataFileIterator(DataDirectory) - Constructor for class com.algorithmia.data.DataFileIterator
DataObject - Class in com.algorithmia.data: An abstract object for common functionality of DataFile and DataDirectory
DataObject(HttpClient, String) - Constructor for class com.algorithmia.data.DataObject
delete(String) - Method in class com.algorithmia.client.HttpClient: DELETE requests
delete(String, HttpAsyncResponseConsumer<T>) - Method in class com.algorithmia.client.HttpClient
delete(boolean) - Method in class com.algorithmia.data.DataDirectory: Creates this directory vi the Algorithmia Data API
delete() - Method in class com.algorithmia.data.DataFile: Deletes this file.
dir(String) - Static method in class com.algorithmia.Algorithmia: Initialize a DataDirectory object using the default client
dir(String) - Method in class com.algorithmia.AlgorithmiaClient: Initialize a DataDirectory object from this client
dir - Variable in class com.algorithmia.data.AbstractDataIterator

E

error - Variable in class com.algorithmia.algo.AlgoFailure
exists() - Method in class com.algorithmia.data.DataDirectory: Determine if this Algorithmia data directory exists
exists() - Method in class com.algorithmia.data.DataFile: Returns whether the file exists in the Data API
exists() - Method in class com.algorithmia.data.DataObject

F

file(String) - Static method in class com.algorithmia.Algorithmia: Initialize an DataFile object using the default client
file(String) - Method in class com.algorithmia.AlgorithmiaClient: Initialize an DataFile object from this client
file(String) - Method in class com.algorithmia.data.DataDirectory: Queries the DataAPI for a particular data file
filename - Variable in class com.algorithmia.data.DataDirectory.FileMetadata
files - Variable in class com.algorithmia.data.DataDirectory.DirectoryListResponse
folders - Variable in class com.algorithmia.data.DataDirectory.DirectoryListResponse
fromHttpResponse(HttpResponse) - Static method in exception com.algorithmia.APIException
fromString(String) - Static method in enum com.algorithmia.algo.ContentType
FutureAlgoResponse - Class in com.algorithmia.algo: A request object to represent that an algorithm has been call asynchronously Wrapping Future<AlgoResponse> will allow other async scenarios (e.g.
FutureAlgoResponse() - Constructor for class com.algorithmia.algo.FutureAlgoResponse
FutureAlgoResponse(Future<AlgoResponse>) - Constructor for class com.algorithmia.algo.FutureAlgoResponse

G

get() - Method in class com.algorithmia.algo.FutureAlgoResponse
get(long, TimeUnit) - Method in class com.algorithmia.algo.FutureAlgoResponse
get(String) - Method in class com.algorithmia.client.HttpClient
get(String, TypeToken<T>) - Method in class com.algorithmia.client.HttpClient
get(String, HttpAsyncResponseConsumer<T>) - Method in class com.algorithmia.client.HttpClient
getBytes() - Method in class com.algorithmia.data.DataFile: Gets the data for this file as as string
getContentType() - Method in class com.algorithmia.algo.Metadata
getDirIter() - Method in class com.algorithmia.data.DataDirectory
getDuration() - Method in class com.algorithmia.algo.Metadata
getFile() - Method in class com.algorithmia.data.DataFile: Gets the data for this file and saves it to a local temporary file
getFileIter() - Method in class com.algorithmia.data.DataDirectory: Get an iterator for retrieving files in this DataDirectory The file list retrieval is done in batches, generally ~1000 files at a time
getInputStream() - Method in class com.algorithmia.data.DataFile: Gets the data for this file as an InputStream
getMetadata() - Method in class com.algorithmia.algo.AlgoFailure
getMetadata() - Method in class com.algorithmia.algo.AlgoResponse
getMetadata() - Method in class com.algorithmia.algo.AlgoSuccess
getName() - Method in class com.algorithmia.data.DataObject
getPage(String) - Method in class com.algorithmia.data.DataDirectory: Gets a single page of the directory listing.
getParent() - Method in class com.algorithmia.data.DataObject
getStdout() - Method in class com.algorithmia.algo.Metadata
getString() - Method in class com.algorithmia.data.DataFile: Gets the data for this file as as string using UTF-8 charset
getString(Charset) - Method in class com.algorithmia.data.DataFile: Gets the data for this file as as string using a custom charset
getUrl() - Method in class com.algorithmia.algo.AlgorithmRef: Resolves this file reference into an HTTP url
getUrl() - Method in class com.algorithmia.data.DataObject: Resolves this collection into an HTTP url

H

hashCode() - Method in class com.algorithmia.algo.AlgorithmRef
hasNext() - Method in class com.algorithmia.data.AbstractDataIterator
head(String) - Method in class com.algorithmia.client.HttpClient: HEAD requests
head(String, HttpAsyncResponseConsumer<T>) - Method in class com.algorithmia.client.HttpClient
HttpClient - Class in com.algorithmia.client
HttpClient(Auth) - Constructor for class com.algorithmia.client.HttpClient
HttpClientHelpers - Class in com.algorithmia.client: Various HTTP actions, using our HttpClient class, and automatically adding authorization
HttpClientHelpers.AbstractBasicResponseConsumer<T> - Class in com.algorithmia.client
HttpClientHelpers.AbstractBasicResponseConsumer() - Constructor for class com.algorithmia.client.HttpClientHelpers.AbstractBasicResponseConsumer
HttpClientHelpers.AlgoResponseHandler - Class in com.algorithmia.client
HttpClientHelpers.AlgoResponseHandler() - Constructor for class com.algorithmia.client.HttpClientHelpers.AlgoResponseHandler
HttpClientHelpers.JsonDeserializeResponseHandler<T> - Class in com.algorithmia.client
HttpClientHelpers.JsonDeserializeResponseHandler(TypeToken) - Constructor for class com.algorithmia.client.HttpClientHelpers.JsonDeserializeResponseHandler

I

isCancelled() - Method in class com.algorithmia.algo.FutureAlgoResponse
isDone() - Method in class com.algorithmia.algo.FutureAlgoResponse
isFailure() - Method in class com.algorithmia.algo.AlgoFailure
isFailure() - Method in class com.algorithmia.algo.AlgoResponse
isFailure() - Method in class com.algorithmia.algo.AlgoSuccess
isSuccess() - Method in class com.algorithmia.algo.AlgoFailure
isSuccess() - Method in class com.algorithmia.algo.AlgoResponse
isSuccess() - Method in class com.algorithmia.algo.AlgoSuccess

J

jsonToAlgoResponse(JsonElement) - Static method in class com.algorithmia.client.HttpClientHelpers

L

loadNextPage() - Method in class com.algorithmia.data.AbstractDataIterator
loadNextPage() - Method in class com.algorithmia.data.DataDirectoryIterator
loadNextPage() - Method in class com.algorithmia.data.DataFileIterator

M

marker - Variable in class com.algorithmia.data.AbstractDataIterator
Metadata - Class in com.algorithmia.algo: Algorithm response metadata
Metadata(ContentType, Double) - Constructor for class com.algorithmia.algo.Metadata
Metadata(ContentType, Double, String) - Constructor for class com.algorithmia.algo.Metadata

N

name - Variable in enum com.algorithmia.algo.ContentType
name - Variable in class com.algorithmia.data.DataDirectory.DirectoryMetadata
newDataObjectInstance(String) - Method in class com.algorithmia.data.AbstractDataIterator
newDataObjectInstance(String) - Method in class com.algorithmia.data.DataDirectoryIterator
newDataObjectInstance(String) - Method in class com.algorithmia.data.DataFileIterator
next() - Method in class com.algorithmia.data.AbstractDataIterator

O

offset - Variable in class com.algorithmia.data.AbstractDataIterator
onContentReceived(ContentDecoder, IOControl) - Method in class com.algorithmia.client.HttpClientHelpers.AbstractBasicResponseConsumer
onEntityEnclosed(HttpEntity, ContentType) - Method in class com.algorithmia.client.HttpClientHelpers.AbstractBasicResponseConsumer
onResponseReceived(HttpResponse) - Method in class com.algorithmia.client.HttpClientHelpers.AbstractBasicResponseConsumer

P

parseResponseJson(HttpResponse) - Static method in class com.algorithmia.client.HttpClientHelpers
path - Variable in class com.algorithmia.data.DataObject
pipe(Object) - Method in class com.algorithmia.algo.Algorithm: Calls the Algorithmia API for a given input.
pipeAsync(Object) - Method in class com.algorithmia.algo.Algorithm: Calls the Algorithmia API asynchronously for a given input.
pipeJson(String) - Method in class com.algorithmia.algo.Algorithm: Calls the Algorithmia API for given input that will be treated as JSON
pipeJsonAsync(String) - Method in class com.algorithmia.algo.Algorithm: 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
post(String, HttpEntity) - Method in class com.algorithmia.client.HttpClient: POST requests
post(String, HttpEntity, HttpAsyncResponseConsumer<T>) - Method in class com.algorithmia.client.HttpClient
promise - Variable in class com.algorithmia.algo.FutureAlgoResponse
put(String, HttpEntity) - Method in class com.algorithmia.client.HttpClient: PUT requests
put(String, HttpEntity, HttpAsyncResponseConsumer<T>) - Method in class com.algorithmia.client.HttpClient
put(String) - Method in class com.algorithmia.data.DataFile: Upload string data to this file as UTF-8 text
put(String, Charset) - Method in class com.algorithmia.data.DataFile: Upload string data to this file as text using a custom Charset
put(byte[]) - Method in class com.algorithmia.data.DataFile: Upload raw data to this file as binary
put(InputStream) - Method in class com.algorithmia.data.DataFile: Upload raw data to this file as an input stream
put(File) - Method in class com.algorithmia.data.DataFile: Upload new data to this file from an existing file.
putFile(File) - Method in class com.algorithmia.data.DataDirectory: Convenience wrapper for putting a File

R

releaseResources() - Method in class com.algorithmia.client.HttpClientHelpers.AbstractBasicResponseConsumer
remove() - Method in class com.algorithmia.data.AbstractDataIterator
response - Variable in class com.algorithmia.client.HttpClientHelpers.AbstractBasicResponseConsumer

S

SimpleAuth - Class in com.algorithmia.client: An Auth implementation for the Algorithmia Simple Auth API Key
SimpleAuth(String) - Constructor for class com.algorithmia.client.SimpleAuth
stacktrace - Variable in exception com.algorithmia.AlgorithmException

T

throwIfJsonHasError(JsonElement) - Static method in class com.algorithmia.client.HttpClientHelpers
throwIfNotOk(HttpResponse) - Static method in class com.algorithmia.client.HttpClientHelpers
toString() - Method in class com.algorithmia.algo.AlgorithmRef
toString() - Method in enum com.algorithmia.algo.ContentType
toString() - Method in exception com.algorithmia.AlgorithmException
toString() - Method in class com.algorithmia.data.DataObject
TypeToken<T> - Class in com.algorithmia: TypeToken used for converting JSON into specific types
TypeToken() - Constructor for class com.algorithmia.TypeToken

V

valueOf(String) - Static method in enum com.algorithmia.algo.ContentType: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.algorithmia.algo.ContentType: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I J L M N O P R S T V