TrainingAPIClientGetImagesOptionalParams interface
選擇性參數。
- Extends
屬性
filter | 用來篩選影像與影像中繼資料的運算式。 只有運算式評估為 true 的影像才會包含在回應中。 運算式支援 eq (Equal) 、ne (Not equal) ,以及 (Logical 和) ,或 (Logical 或) 運算子。 以下是 metadata=key1 eq 'value1' 和 key2 ne 'value2' 的範例。 |
iteration |
反復專案識別碼。預設為工作區。 |
order |
排序。 預設為最新版本。 可能的值包括:'Newest'、'Oldest' |
skip | 開始映射批次之前要略過的映射數目。 預設為 0。 預設值:0. |
tagging |
標記狀態篩選準則。 它可以是 'All'、'Tagged' 或 'Untagged'。 預設為 'All'。 可能的值包括:'All'、'Tagged'、'Untagged' |
tag |
用來篩選影像的標記識別項清單。 當 Null 時,預設為所有標記的影像。 限制為 20。 |
take | 要傳回的影像數目上限。 預設為 50,限制為 256。 預設值:50。 |
繼承的屬性
abort |
可用來中止要求的訊號。 |
custom |
使用者定義自訂要求標頭,將在傳送要求之前套用。 |
on |
下載進度時引發的回呼。 |
on |
上傳進度時引發的回呼。 |
timeout | 要求在自動終止之前可能需要的毫秒數。 |
屬性詳細資料
filter
用來篩選影像與影像中繼資料的運算式。 只有運算式評估為 true 的影像才會包含在回應中。 運算式支援 eq (Equal) 、ne (Not equal) ,以及 (Logical 和) ,或 (Logical 或) 運算子。 以下是 metadata=key1 eq 'value1' 和 key2 ne 'value2' 的範例。
filter?: string
屬性值
string
iterationId
反復專案識別碼。預設為工作區。
iterationId?: string
屬性值
string
orderBy
skip
開始映射批次之前要略過的映射數目。 預設為 0。 預設值:0.
skip?: number
屬性值
number
taggingStatus
標記狀態篩選準則。 它可以是 'All'、'Tagged' 或 'Untagged'。 預設為 'All'。 可能的值包括:'All'、'Tagged'、'Untagged'
taggingStatus?: TaggingStatus
屬性值
tagIds
用來篩選影像的標記識別項清單。 當 Null 時,預設為所有標記的影像。 限制為 20。
tagIds?: string[]
屬性值
string[]
take
要傳回的影像數目上限。 預設為 50,限制為 256。 預設值:50。
take?: number
屬性值
number
繼承的屬性詳細資料
abortSignal
可用來中止要求的訊號。
abortSignal?: AbortSignalLike
屬性值
繼承自 msRest.RequestOptionsBase.abortSignal
customHeaders
使用者定義自訂要求標頭,將在傳送要求之前套用。
customHeaders?: {[key: string]: string}
屬性值
{[key: string]: string}
繼承自 msRest.RequestOptionsBase.customHeaders
onDownloadProgress
下載進度時引發的回呼。
onDownloadProgress?: (progress: TransferProgressEvent) => void
屬性值
(progress: TransferProgressEvent) => void
繼承自 msRest.RequestOptionsBase.onDownloadProgress
onUploadProgress
上傳進度時引發的回呼。
onUploadProgress?: (progress: TransferProgressEvent) => void
屬性值
(progress: TransferProgressEvent) => void
繼承自 msRest.RequestOptionsBase.onUploadProgress
timeout
要求在自動終止之前可能需要的毫秒數。
timeout?: number
屬性值
number
繼承自 msRest.RequestOptionsBase.timeout