de.ameto.client

Class Ameto

java.lang.Object

de.ameto.client.Ameto

public class Ameto
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Ameto(java.lang.String url, java.lang.String apiToken)

Method Summary

Modifier and Type	Method and Description
Asset	add(java.io.InputStream assetContent, java.lang.String name) Uploads the specified asset content.
Asset	add(java.nio.file.Path file)
Pipeline	add(java.lang.String name, Operator firstOperator, Operator... operators) Adds the specified pipeline to ameto.
java.util.Set<Asset>	getAssets() Returns Assets that have been uploaded to Ameto.
java.util.List<Job>	getJobs() Returns a list of all jobs.
java.util.Set<Pipeline>	getPipelines() Returns a collection of all pipelines.
void	remove(Asset asset) Removes the specified asset from Ameto.
void	remove(ProcessedAsset asset) Removes the specified processed asset from Ameto.

Methods inherited from class java.lang.Object

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

Constructor Detail

Ameto

public Ameto(java.lang.String url,
             java.lang.String apiToken)

Method Detail

add

public Pipeline add(java.lang.String name,
                    Operator firstOperator,
                    Operator... operators)

Adds the specified pipeline to ameto. If a pipeline with the specified name already exists, it will be overwritten.

Parameters:

name - Pipeline name

firstOperator - First processing step

operators - Subsequent processing steps

Returns:

A new pipeline

Throws:

AmetoException - if communication with the API was not possible or the response returned an error.

getPipelines

public java.util.Set<Pipeline> getPipelines()

Returns a collection of all pipelines.

Returns:

Set of pipelines

Throws:

AmetoException - if communication with the API was not possible or the response returned an error.

getAssets

public java.util.Set<Asset> getAssets()

Returns Assets that have been uploaded to Ameto. Note that the returned collection may not include very recently uploaded items.

Returns:

Assets available to Ameto

Throws:

AmetoException - if the asset list could not be retrieved

add

public Asset add(java.nio.file.Path file)

add

public Asset add(java.io.InputStream assetContent,
                 java.lang.String name)

Uploads the specified asset content. The name parameter specifies the asset name, e.g. a file name.

Parameters:

assetContent - Binary content of the asset

name - Name of the asset.

Returns:

An asset with the specified content

Throws:

AmetoException - if an error occurs during asset upload

remove

public void remove(Asset asset)

Removes the specified asset from Ameto.

Parameters:

asset - Asset to be deleted

remove

public void remove(ProcessedAsset asset)

Removes the specified processed asset from Ameto.

Parameters:

asset - Processed asset to be deleted

getJobs

public java.util.List<Job> getJobs()

Returns a list of all jobs.

Returns:

job list

Throws:

AmetoException - if the request could not be sent