ListManagementTermLists Interface

Package:

com.microsoft.azure.cognitiveservices.vision.contentmoderator

public interface ListManagementTermLists

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

Method Summary

Modifier and Type	Method and Description
TermList	create(String contentType, BodyModel bodyParameter) Creates a Term List.
Observable<TermList>	createAsync(String contentType, BodyModel bodyParameter) Creates a Term List.
String	delete(String listId) Deletes term list with the list Id equal to list Id passed.
Observable<String>	deleteAsync(String listId) Deletes term list with the list Id equal to list Id passed.
List<TermList>	getAllTermLists() gets all the Term Lists.
Observable<List<TermList>>	getAllTermListsAsync() gets all the Term Lists.
TermList	getDetails(String listId) Returns list Id details of the term list with list Id equal to list Id passed.
Observable<TermList>	getDetailsAsync(String listId) Returns list Id details of the term list with list Id equal to list Id passed.
RefreshIndex	refreshIndexMethod(String listId, String language) Refreshes the index of the list with list Id equal to list ID passed.
Observable<RefreshIndex>	refreshIndexMethodAsync(String listId, String language) Refreshes the index of the list with list Id equal to list ID passed.
TermList	update(String listId, String contentType, BodyModel bodyParameter) Updates an Term List.
Observable<TermList>	updateAsync(String listId, String contentType, BodyModel bodyParameter) Updates an Term List.

Method Details

create

public TermList create(String contentType, BodyModel bodyParameter)

Creates a Term List.

Parameters:

contentType - The content type.

bodyParameter - Schema of the body.

Returns:

the TermList 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 a Term List.

Parameters:

contentType - The content type.

bodyParameter - Schema of the body.

Returns:

the observable to the TermList object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

delete

public String delete(String listId)

Deletes term 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 term 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

getAllTermLists

public List getAllTermLists()

gets all the Term Lists.

Returns:

the List<TermList> 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

getAllTermListsAsync

public Observable<>> getAllTermListsAsync()

gets all the Term Lists.

Returns:

the observable to the List<TermList> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getDetails

public TermList getDetails(String listId)

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

Parameters:

listId - List Id of the image list.

Returns:

the TermList 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 list Id details of the term list with list Id equal to list Id passed.

Parameters:

listId - List Id of the image list.

Returns:

the observable to the TermList object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

refreshIndexMethod

public RefreshIndex refreshIndexMethod(String listId, String language)

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

Parameters:

listId - List Id of the image list.

language - Language of the terms.

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, String language)

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

Parameters:

listId - List Id of the image list.

language - Language of the terms.

Returns:

the observable to the RefreshIndex object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

update

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

Updates an Term List.

Parameters:

listId - List Id of the image list.

contentType - The content type.

bodyParameter - Schema of the body.

Returns:

the TermList 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 Term List.

Parameters:

listId - List Id of the image list.

contentType - The content type.

bodyParameter - Schema of the body.

Returns:

the observable to the TermList object

Throws:

IllegalArgumentException - thrown if parameters fail the validation