TrainingAPIClientDeleteImagesOptionalParams interface

Package:

@azure/cognitiveservices-customvision-training

Optional Parameters.

Extends

RequestOptionsBase

Properties

allImages	Flag to specify delete all images, specify this flag or a list of images. Using this flag will return a 202 response to indicate the images are being deleted.
allIterations	Removes these images from all iterations, not just the current workspace. Using this flag will return a 202 response to indicate the images are being deleted.
imageIds	Ids of the images to be deleted. Limited to 256 images per batch.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
customHeaders	User defined custom request headers that will be applied before the request is sent.
onDownloadProgress	Callback which fires upon download progress.
onUploadProgress	Callback which fires upon upload progress.
timeout	The number of milliseconds a request can take before automatically being terminated.

Property Details

allImages

Flag to specify delete all images, specify this flag or a list of images. Using this flag will return a 202 response to indicate the images are being deleted.

allImages?: boolean

Property Value

boolean

allIterations

Removes these images from all iterations, not just the current workspace. Using this flag will return a 202 response to indicate the images are being deleted.

allIterations?: boolean

Property Value

boolean

imageIds

Ids of the images to be deleted. Limited to 256 images per batch.

imageIds?: string[]

Property Value

string[]

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From msRest.RequestOptionsBase.abortSignal

customHeaders

User defined custom request headers that will be applied before the request is sent.

customHeaders?: {[key: string]: string}

Property Value

{[key: string]: string}

Inherited From msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From msRest.RequestOptionsBase.onUploadProgress

timeout

The number of milliseconds a request can take before automatically being terminated.

timeout?: number

Property Value

number

Inherited From msRest.RequestOptionsBase.timeout