TrainingAPIClientGetImagesOptionalParams interface
省略可能なパラメーター。
- Extends
プロパティ
filter | 画像メタデータに対して画像をフィルター処理する式。 式が true と評価される画像のみが応答に含まれます。 式は、eq (Equal)、ne (Not equal)、および (Logical and)、または (Logical or) 演算子をサポートします。 metadata=key1 eq 'value1' と key2 ne 'value2' の例を次に示します。 |
iteration |
イテレーション ID。既定値はワークスペースです。 |
order |
順序付け。 既定値は最新です。 使用可能な値は、'Newest'、'Oldest' です。 |
skip | イメージ バッチを開始する前にスキップするイメージの数。 既定値は 0 です。 既定値:0。 |
tagging |
タグ付けの状態フィルター。 'All'、'Tagged'、または 'Untagged' を指定できます。 既定値は 'All' です。 使用可能な値は、'All'、'Tagged'、'Untagged' です。 |
tag |
画像をフィルター処理するタグ ID の一覧。 null の場合、既定ではタグ付けされたすべての画像が設定されます。 20 に制限されます。 |
take | 返される画像の最大数。 既定値は 50 で、制限は 256 です。 既定値: 50。 |
継承されたプロパティ
abort |
要求を中止するために使用できるシグナル。 |
custom |
要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。 |
on |
ダウンロードの進行状況時に発生するコールバック。 |
on |
アップロードの進行状況時に発生するコールバック。 |
timeout | 要求が自動的に終了するまでの時間 (ミリ秒)。 |
プロパティの詳細
filter
画像メタデータに対して画像をフィルター処理する式。 式が true と評価される画像のみが応答に含まれます。 式は、eq (Equal)、ne (Not equal)、および (Logical and)、または (Logical or) 演算子をサポートします。 metadata=key1 eq 'value1' と key2 ne 'value2' の例を次に示します。
filter?: string
プロパティ値
string
iterationId
イテレーション ID。既定値はワークスペースです。
iterationId?: string
プロパティ値
string
orderBy
skip
イメージ バッチを開始する前にスキップするイメージの数。 既定値は 0 です。 既定値:0。
skip?: number
プロパティ値
number
taggingStatus
タグ付けの状態フィルター。 'All'、'Tagged'、または 'Untagged' を指定できます。 既定値は 'All' です。 使用可能な値は、'All'、'Tagged'、'Untagged' です。
taggingStatus?: TaggingStatus
プロパティ値
tagIds
画像をフィルター処理するタグ ID の一覧。 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