ListManagementImages Interface

Package:

com.microsoft.azure.cognitiveservices.vision.contentmoderator

public interface ListManagementImages

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

Method Summary

Modifier and Type	Method and Description
ListManagementImagesAddImageDefinitionStages.WithListId	addImage() Add an image to the list with list Id equal to list Id passed.
Image	addImage(String listId, AddImageOptionalParameter addImageOptionalParameter) Add an image to the list with list Id equal to list Id passed.
Observable<Image>	addImageAsync(String listId, AddImageOptionalParameter addImageOptionalParameter) Add an image to the list with list Id equal to list Id passed.
ListManagementImagesAddImageFileInputDefinitionStages.WithListId	addImageFileInput() Add an image to the list with list Id equal to list Id passed.
Image	addImageFileInput(String listId, byte[] imageStream, AddImageFileInputOptionalParameter addImageFileInputOptionalParameter) Add an image to the list with list Id equal to list Id passed.
Observable<Image>	addImageFileInputAsync(String listId, byte[] imageStream, AddImageFileInputOptionalParameter addImageFileInputOptionalParameter) Add an image to the list with list Id equal to list Id passed.
ListManagementImagesAddImageUrlInputDefinitionStages.WithListId	addImageUrlInput() Add an image to the list with list Id equal to list Id passed.
Image	addImageUrlInput(String listId, String contentType, BodyModelModel imageUrl, AddImageUrlInputOptionalParameter addImageUrlInputOptionalParameter) Add an image to the list with list Id equal to list Id passed.
Observable<Image>	addImageUrlInputAsync(String listId, String contentType, BodyModelModel imageUrl, AddImageUrlInputOptionalParameter addImageUrlInputOptionalParameter) Add an image to the list with list Id equal to list Id passed.
String	deleteAllImages(String listId) Deletes all images from the list with list Id equal to list Id passed.
Observable<String>	deleteAllImagesAsync(String listId) Deletes all images from the list with list Id equal to list Id passed.
String	deleteImage(String listId, String imageId) Deletes an image from the list with list Id and image Id passed.
Observable<String>	deleteImageAsync(String listId, String imageId) Deletes an image from the list with list Id and image Id passed.
ImageIds	getAllImageIds(String listId) Gets all image Ids from the list with list Id equal to list Id passed.
Observable<ImageIds>	getAllImageIdsAsync(String listId) Gets all image Ids from the list with list Id equal to list Id passed.

Method Details

addImage

public ListManagementImagesAddImageDefinitionStages.WithListId addImage()

Add an image to the list with list Id equal to list Id passed.

Returns:

the first stage of the addImage call

addImage

public Image addImage(String listId, AddImageOptionalParameter addImageOptionalParameter)

Add an image to the list with list Id equal to list Id passed.

Parameters:

listId - List Id of the image list.

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

Returns:

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

addImageAsync

public Observable addImageAsync(String listId, AddImageOptionalParameter addImageOptionalParameter)

Add an image to the list with list Id equal to list Id passed.

Parameters:

listId - List Id of the image list.

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

Returns:

the observable to the Image object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addImageFileInput

public ListManagementImagesAddImageFileInputDefinitionStages.WithListId addImageFileInput()

Add an image to the list with list Id equal to list Id passed.

Returns:

the first stage of the addImageFileInput call

addImageFileInput

public Image addImageFileInput(String listId, byte[] imageStream, AddImageFileInputOptionalParameter addImageFileInputOptionalParameter)

Add an image to the list with list Id equal to list Id passed.

Parameters:

listId - List Id of the image list.

imageStream - The image file.

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

Returns:

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

addImageFileInputAsync

public Observable addImageFileInputAsync(String listId, byte[] imageStream, AddImageFileInputOptionalParameter addImageFileInputOptionalParameter)

Add an image to the list with list Id equal to list Id passed.

Parameters:

listId - List Id of the image list.

imageStream - The image file.

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

Returns:

the observable to the Image object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addImageUrlInput

public ListManagementImagesAddImageUrlInputDefinitionStages.WithListId addImageUrlInput()

Add an image to the list with list Id equal to list Id passed.

Returns:

the first stage of the addImageUrlInput call

addImageUrlInput

public Image addImageUrlInput(String listId, String contentType, BodyModelModel imageUrl, AddImageUrlInputOptionalParameter addImageUrlInputOptionalParameter)

Add an image to the list with list Id equal to list Id passed.

Parameters:

listId - List Id of the image list.

contentType - The content type.

imageUrl - The image url.

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

Returns:

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

addImageUrlInputAsync

public Observable addImageUrlInputAsync(String listId, String contentType, BodyModelModel imageUrl, AddImageUrlInputOptionalParameter addImageUrlInputOptionalParameter)

Add an image to the list with list Id equal to list Id passed.

Parameters:

listId - List Id of the image list.

contentType - The content type.

imageUrl - The image url.

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

Returns:

the observable to the Image object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteAllImages

public String deleteAllImages(String listId)

Deletes all images from the list with 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

deleteAllImagesAsync

public Observable deleteAllImagesAsync(String listId)

Deletes all images from the list with 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

deleteImage

public String deleteImage(String listId, String imageId)

Deletes an image from the list with list Id and image Id passed.

Parameters:

listId - List Id of the image list.

imageId - Id of the image.

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

deleteImageAsync

public Observable deleteImageAsync(String listId, String imageId)

Deletes an image from the list with list Id and image Id passed.

Parameters:

listId - List Id of the image list.

imageId - Id of the image.

Returns:

the observable to the String object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAllImageIds

public ImageIds getAllImageIds(String listId)

Gets all image Ids from the list with list Id equal to list Id passed.

Parameters:

listId - List Id of the image list.

Returns:

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

getAllImageIdsAsync

public Observable getAllImageIdsAsync(String listId)

Gets all image Ids from the list with list Id equal to list Id passed.

Parameters:

listId - List Id of the image list.

Returns:

the observable to the ImageIds object

Throws:

IllegalArgumentException - thrown if parameters fail the validation