ListManagementTerms Interface

Package:

com.microsoft.azure.cognitiveservices.vision.contentmoderator

public interface ListManagementTerms

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

Method Summary

Modifier and Type	Method and Description
Object	addTerm(String listId, String term, String language) Add a term to the term list with list Id equal to list Id passed.
Observable<Object>	addTermAsync(String listId, String term, String language) Add a term to the term list with list Id equal to list Id passed.
String	deleteAllTerms(String listId, String language) Deletes all terms from the list with list Id equal to the list Id passed.
Observable<String>	deleteAllTermsAsync(String listId, String language) Deletes all terms from the list with list Id equal to the list Id passed.
String	deleteTerm(String listId, String term, String language) Deletes a term from the list with list Id equal to the list Id passed.
Observable<String>	deleteTermAsync(String listId, String term, String language) Deletes a term from the list with list Id equal to the list Id passed.
ListManagementTermsGetAllTermsDefinitionStages.WithListId	getAllTerms() Gets all terms from the list with list Id equal to the list Id passed.
Terms	getAllTerms(String listId, String language, GetAllTermsOptionalParameter getAllTermsOptionalParameter) Gets all terms from the list with list Id equal to the list Id passed.
Observable<Terms>	getAllTermsAsync(String listId, String language, GetAllTermsOptionalParameter getAllTermsOptionalParameter) Gets all terms from the list with list Id equal to the list Id passed.

Method Details

addTerm

public Object addTerm(String listId, String term, String language)

Add a term to the term list with list Id equal to list Id passed.

Parameters:

listId - List Id of the image list.

term - Term to be deleted.

language - Language of the terms.

Returns:

the Object 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

addTermAsync

public Observable

Add a term to the term list with list Id equal to list Id passed.

Parameters:

listId - List Id of the image list.

term - Term to be deleted.

language - Language of the terms.

Returns:

the observable to the Object object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteAllTerms

public String deleteAllTerms(String listId, String language)

Deletes all terms from the list with list Id equal to the list Id passed.

Parameters:

listId - List Id of the image list.

language - Language of the terms.

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

deleteAllTermsAsync

public Observable deleteAllTermsAsync(String listId, String language)

Deletes all terms from the list with list Id equal to the list Id passed.

Parameters:

listId - List Id of the image list.

language - Language of the terms.

Returns:

the observable to the String object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteTerm

public String deleteTerm(String listId, String term, String language)

Deletes a term from the list with list Id equal to the list Id passed.

Parameters:

listId - List Id of the image list.

term - Term to be deleted.

language - Language of the terms.

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

deleteTermAsync

public Observable deleteTermAsync(String listId, String term, String language)

Deletes a term from the list with list Id equal to the list Id passed.

Parameters:

listId - List Id of the image list.

term - Term to be deleted.

language - Language of the terms.

Returns:

the observable to the String object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAllTerms

public ListManagementTermsGetAllTermsDefinitionStages.WithListId getAllTerms()

Gets all terms from the list with list Id equal to the list Id passed.

Returns:

the first stage of the getAllTerms call

getAllTerms

public Terms getAllTerms(String listId, String language, GetAllTermsOptionalParameter getAllTermsOptionalParameter)

Gets all terms from the list with list Id equal to the list Id passed.

Parameters:

listId - List Id of the image list.

language - Language of the terms.

getAllTermsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the Terms 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

getAllTermsAsync

public Observable getAllTermsAsync(String listId, String language, GetAllTermsOptionalParameter getAllTermsOptionalParameter)

Gets all terms from the list with list Id equal to the list Id passed.

Parameters:

listId - List Id of the image list.

language - Language of the terms.

getAllTermsOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the Terms object

Throws:

IllegalArgumentException - thrown if parameters fail the validation