Partilhar via


TrainingAPIClientGetImagesOptionalParams interface

Parâmetros opcionais.

Extends

Propriedades

filter

Uma expressão para filtrar as imagens em relação aos metadados da imagem. Apenas as imagens em que a expressão é avaliada como verdadeira são incluídas na resposta. A expressão suporta os operadores eq (Equal), ne (Not equal) e (Logical and) ou (Logical or). Aqui está um exemplo, metadata=key1 eq 'value1' e key2 ne 'value2'.

iterationId

O id da iteração. O padrão é o espaço de trabalho.

orderBy

A encomenda. O padrão é o mais recente. Os valores possíveis incluem: 'Mais novo', 'Mais antigo'

skip

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

taggingStatus

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

tagIds

Uma lista de tags ids para filtrar as imagens. O padrão é para todas as imagens marcadas quando nulo. Limitado a 20.

take

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

Propriedades Herdadas

abortSignal

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

customHeaders

Cabeçalhos de solicitação personalizados definidos pelo usuário que serão aplicados antes que a solicitação seja enviada.

onDownloadProgress

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

onUploadProgress

Retorno de chamada que é acionado após o progresso do carregamento.

timeout

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

Detalhes de Propriedade

filter

Uma expressão para filtrar as imagens em relação aos metadados da imagem. Apenas as imagens em que a expressão é avaliada como verdadeira são incluídas na resposta. A expressão suporta os operadores eq (Equal), ne (Not equal) e (Logical and) ou (Logical or). Aqui está um exemplo, metadata=key1 eq 'value1' e key2 ne 'value2'.

filter?: string

Valor de Propriedade

string

iterationId

O id da iteração. O padrão é o espaço de trabalho.

iterationId?: string

Valor de Propriedade

string

orderBy

A encomenda. O padrão é o mais recente. Os valores possíveis incluem: 'Mais novo', 'Mais antigo'

orderBy?: OrderBy1

Valor de Propriedade

skip

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

skip?: number

Valor de Propriedade

number

taggingStatus

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

taggingStatus?: TaggingStatus

Valor de Propriedade

tagIds

Uma lista de tags ids para filtrar as imagens. O padrão é para todas as imagens marcadas quando nulo. Limitado a 20.

tagIds?: string[]

Valor de Propriedade

string[]

take

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

take?: number

Valor de Propriedade

number

Detalhes da Propriedade Herdada

abortSignal

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

abortSignal?: AbortSignalLike

Valor de Propriedade

herdado de msRest.RequestOptionsBase.abortSignal

customHeaders

Cabeçalhos de solicitação personalizados definidos pelo usuário que serão aplicados antes que a solicitação seja enviada.

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

Valor de Propriedade

{[key: string]: string}

herdado de msRest.RequestOptionsBase.customHeaders

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

herdado de msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Retorno de chamada que é acionado após o progresso do carregamento.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de 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 de Propriedade

number

herdado de msRest.RequestOptionsBase.timeout