TrainingAPIClientGetImagesOptionalParams interface
Parámetros opcionales.
- Extends
Propiedades
| filter | Expresión para filtrar las imágenes en los metadatos de la imagen. En la respuesta solo se incluyen imágenes en las que la expresión se evalúa como true. La expresión admite operadores eq (Equal), ne (Not equal) y (Logical y) o (Logical o). Este es un ejemplo, metadata=key1 eq 'value1' y key2 ne 'value2'. |
| iteration |
Identificador de iteración. El valor predeterminado es el área de trabajo. |
| order |
La ordenación. El valor predeterminado es el más reciente. Entre los valores posibles se incluyen: "Newest", "Oldest" |
| skip | Número de imágenes que se omitirán antes de comenzar el lote de imágenes. El valor predeterminado es 0. Valor predeterminado: 0. |
| tagging |
Filtro de estado de etiquetado. Puede ser "All", "Tagged" o "Untagged". El valor predeterminado es "All". Entre los valores posibles se incluyen: "All", "Tagged", "Untagged" |
| tag |
Lista de identificadores de etiquetas para filtrar las imágenes. El valor predeterminado es todas las imágenes etiquetadas cuando es NULL. Limitado a 20. |
| take | Número máximo de imágenes que se van a devolver. El valor predeterminado es 50, limitado a 256. Valor predeterminado: 50. |
Propiedades heredadas
| abort |
Señal que se puede usar para anular las solicitudes. |
| custom |
Encabezados de solicitud personalizados definidos por el usuario que se aplicarán antes de enviar la solicitud. |
| on |
Devolución de llamada que se desencadena tras el progreso de la descarga. |
| on |
Devolución de llamada que se desencadena tras el progreso de la carga. |
| timeout | El número de milisegundos que puede tomar una solicitud antes de finalizarse automáticamente. |
Detalles de las propiedades
filter
Expresión para filtrar las imágenes en los metadatos de la imagen. En la respuesta solo se incluyen imágenes en las que la expresión se evalúa como true. La expresión admite operadores eq (Equal), ne (Not equal) y (Logical y) o (Logical o). Este es un ejemplo, metadata=key1 eq 'value1' y key2 ne 'value2'.
filter?: string
Valor de propiedad
string
iterationId
Identificador de iteración. El valor predeterminado es el área de trabajo.
iterationId?: string
Valor de propiedad
string
orderBy
La ordenación. El valor predeterminado es el más reciente. Entre los valores posibles se incluyen: "Newest", "Oldest"
orderBy?: OrderBy1
Valor de propiedad
skip
Número de imágenes que se omitirán antes de comenzar el lote de imágenes. El valor predeterminado es 0. Valor predeterminado: 0.
skip?: number
Valor de propiedad
number
taggingStatus
Filtro de estado de etiquetado. Puede ser "All", "Tagged" o "Untagged". El valor predeterminado es "All". Entre los valores posibles se incluyen: "All", "Tagged", "Untagged"
taggingStatus?: TaggingStatus
Valor de propiedad
tagIds
Lista de identificadores de etiquetas para filtrar las imágenes. El valor predeterminado es todas las imágenes etiquetadas cuando es NULL. Limitado a 20.
tagIds?: string[]
Valor de propiedad
string[]
take
Número máximo de imágenes que se van a devolver. El valor predeterminado es 50, limitado a 256. Valor predeterminado: 50.
take?: number
Valor de propiedad
number
Detalles de las propiedades heredadas
abortSignal
Señal que se puede usar para anular las solicitudes.
abortSignal?: AbortSignalLike
Valor de propiedad
Se hereda de msRest.RequestOptionsBase.abortSignal
customHeaders
Encabezados de solicitud personalizados definidos por el usuario que se aplicarán antes de enviar la solicitud.
customHeaders?: {[key: string]: string}
Valor de propiedad
{[key: string]: string}
Heredado de msRest.RequestOptionsBase.customHeaders
onDownloadProgress
Devolución de llamada que se desencadena tras el progreso de la descarga.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Valor de propiedad
(progress: TransferProgressEvent) => void
Se hereda de msRest.RequestOptionsBase.onDownloadProgress
onUploadProgress
Devolución de llamada que se desencadena tras el progreso de la carga.
onUploadProgress?: (progress: TransferProgressEvent) => void
Valor de propiedad
(progress: TransferProgressEvent) => void
heredado de msRest.RequestOptionsBase.onUploadProgress
timeout
El número de milisegundos que puede tomar una solicitud antes de finalizarse automáticamente.
timeout?: number
Valor de propiedad
number
se hereda de msRest.RequestOptionsBase.timeout