ListManagementImageLists Interface

Package:

com.microsoft.azure.cognitiveservices.vision.contentmoderator

public interface ListManagementImageLists

An instance of this class provides access to all the operations defined in ListManagementImageLists.

Method Summary

Modifier and Type	Method and Description
ImageList	create(String contentType, BodyModel bodyParameter) Creates an image list.
Observable<ImageList>	createAsync(String contentType, BodyModel bodyParameter) Creates an image list.
String	delete(String listId) Deletes image list with the list Id equal to list Id passed.
Observable<String>	deleteAsync(String listId) Deletes image list with the list Id equal to list Id passed.
List<ImageList>	getAllImageLists() Gets all the Image Lists.
Observable<List<ImageList>>	getAllImageListsAsync() Gets all the Image Lists.
ImageList	getDetails(String listId) Returns the details of the image list with list Id equal to list Id passed.
Observable<ImageList>	getDetailsAsync(String listId) Returns the details of the image list with list Id equal to list Id passed.
RefreshIndex	refreshIndexMethod(String listId) Refreshes the index of the list with list Id equal to list Id passed.
Observable<RefreshIndex>	refreshIndexMethodAsync(String listId) Refreshes the index of the list with list Id equal to list Id passed.
ImageList	update(String listId, String contentType, BodyModel bodyParameter) Updates an image list with list Id equal to list Id passed.
Observable<ImageList>	updateAsync(String listId, String contentType, BodyModel bodyParameter) Updates an image list with list Id equal to list Id passed.

Method Details

create

public ImageList create(String contentType, BodyModel bodyParameter)

Creates an image list.

Parameters:

contentType - The content type.

bodyParameter - Schema of the body.

Returns:

the ImageList object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

createAsync

public Observable createAsync(String contentType, BodyModel bodyParameter)

Creates an image list.

Parameters:

contentType - The content type.

bodyParameter - Schema of the body.

Returns:

the observable to the ImageList object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

delete

public String delete(String listId)

Deletes image list with the list Id equal to list Id passed.

Parameters:

listId - List Id of the image list.

Returns:

the String object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteAsync

public Observable deleteAsync(String listId)

Deletes image list with the list Id equal to list Id passed.

Parameters:

listId - List Id of the image list.

Returns:

the observable to the String object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAllImageLists

public List getAllImageLists()

Gets all the Image Lists.

Returns:

the List<ImageList> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getAllImageListsAsync

public Observable> getAllImageListsAsync()

Gets all the Image Lists.

Returns:

the observable to the List<ImageList> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getDetails

public ImageList getDetails(String listId)

Returns the details of the image list with list Id equal to list Id passed.

Parameters:

listId - List Id of the image list.

Returns:

the ImageList object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getDetailsAsync

public Observable getDetailsAsync(String listId)

Returns the details of the image list with list Id equal to list Id passed.

Parameters:

listId - List Id of the image list.

Returns:

the observable to the ImageList object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

refreshIndexMethod

public RefreshIndex refreshIndexMethod(String listId)

Refreshes the index of the list with list Id equal to list Id passed.

Parameters:

listId - List Id of the image list.

Returns:

the RefreshIndex object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

refreshIndexMethodAsync

public Observable refreshIndexMethodAsync(String listId)

Refreshes the index of the list with list Id equal to list Id passed.

Parameters:

listId - List Id of the image list.

Returns:

the observable to the RefreshIndex object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

update

public ImageList update(String listId, String contentType, BodyModel bodyParameter)

Updates an image list with list Id equal to list Id passed.

Parameters:

listId - List Id of the image list.

contentType - The content type.

bodyParameter - Schema of the body.

Returns:

the ImageList object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

APIErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateAsync

public Observable updateAsync(String listId, String contentType, BodyModel bodyParameter)

Updates an image list with list Id equal to list Id passed.

Parameters:

listId - List Id of the image list.

contentType - The content type.

bodyParameter - Schema of the body.

Returns:

the observable to the ImageList object

Throws:

IllegalArgumentException - thrown if parameters fail the validation