Compartilhar via


TrainingAPIClientGetImagesOptionalParams interface

Parâmetros opcionais.

Extends

Propriedades

filter

Uma expressão para filtrar as imagens em metadados de imagem. Somente as imagens em que a expressão é avaliada como true são incluídas na resposta. A expressão dá suporte a operadores eq (Igual), ne (Não igual) e (Lógico e) ou (Lógico ou). Aqui está um exemplo, metadata=key1 eq 'value1' e key2 ne 'value2'.

iterationId

A ID da iteração. O padrão é workspace.

orderBy

A ordenação. O padrão é o mais recente. Os valores possíveis incluem: 'Newest', 'Oldest'

skip

Número de imagens a serem ignoradas antes de iniciar o lote de imagens. Assume o padrão de 0. Valor padrão: 0.

taggingStatus

O filtro de status de marcação. Pode ser "Tudo", "Marcado" ou "Não Marcado". O padrão é "Todos". Os valores possíveis incluem: 'All', 'Tagged', 'Untagged'

tagIds

Uma lista de IDs de marcas para filtrar as imagens. O padrão é todas as imagens marcadas quando nulas. Limitado a 20.

take

Número máximo de imagens a serem retornadas. O padrão é 50, limitado a 256. Valor padrão: 50.

Propriedades herdadas

abortSignal

O sinal que pode ser usado para anular solicitações.

customHeaders

Cabeçalhos de solicitação personalizados definidos pelo usuário que serão aplicados antes do envio da solicitação.

onDownloadProgress

Retorno de chamada que é disparado após o progresso do download.

onUploadProgress

Retorno de chamada que é disparado após o progresso do upload.

timeout

O número de milissegundos que uma solicitação pode levar antes de ser encerrada automaticamente.

Detalhes da propriedade

filter

Uma expressão para filtrar as imagens em metadados de imagem. Somente as imagens em que a expressão é avaliada como true são incluídas na resposta. A expressão dá suporte a operadores eq (Igual), ne (Não igual) e (Lógico e) ou (Lógico ou). Aqui está um exemplo, metadata=key1 eq 'value1' e key2 ne 'value2'.

filter?: string

Valor da propriedade

string

iterationId

A ID da iteração. O padrão é workspace.

iterationId?: string

Valor da propriedade

string

orderBy

A ordenação. O padrão é o mais recente. Os valores possíveis incluem: 'Newest', 'Oldest'

orderBy?: OrderBy1

Valor da propriedade

skip

Número de imagens a serem ignoradas antes de iniciar o lote de imagens. Assume o padrão de 0. Valor padrão: 0.

skip?: number

Valor da propriedade

number

taggingStatus

O filtro de status de marcação. Pode ser "Tudo", "Marcado" ou "Não Marcado". O padrão é "Todos". Os valores possíveis incluem: 'All', 'Tagged', 'Untagged'

taggingStatus?: TaggingStatus

Valor da propriedade

tagIds

Uma lista de IDs de marcas para filtrar as imagens. O padrão é todas as imagens marcadas quando nulas. Limitado a 20.

tagIds?: string[]

Valor da propriedade

string[]

take

Número máximo de imagens a serem retornadas. O padrão é 50, limitado a 256. Valor padrão: 50.

take?: number

Valor da propriedade

number

Detalhes das propriedades herdadas

abortSignal

O sinal que pode ser usado para anular solicitações.

abortSignal?: AbortSignalLike

Valor da propriedade

Herdado de msRest.RequestOptionsBase.abortSignal

customHeaders

Cabeçalhos de solicitação personalizados definidos pelo usuário que serão aplicados antes do envio da solicitação.

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

Valor da propriedade

{[key: string]: string}

Herdado de msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Retorno de chamada que é disparado após o progresso do download.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

Herdado de msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Retorno de chamada que é disparado após o progresso do upload.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

Herdado de msRest.RequestOptionsBase.onUploadProgress

timeout

O número de milissegundos que uma solicitação pode levar antes de ser encerrada automaticamente.

timeout?: number

Valor da propriedade

number

Herdado de msRest.RequestOptionsBase.timeout