PipelineRequest interface

Pacote:

@typespec/ts-http-runtime

Metadados sobre uma solicitação que está sendo feita pelo pipeline.

Propriedades

abortSignal	Usado para abortar a solicitação mais tarde.
agent	SOMENTE NODEJS Uma opção somente nó para fornecer um http.Agent/https.Agentpersonalizado. Não faz nada ao executar no navegador.
allowInsecureConnection	Defina como true se a solicitação for enviada por HTTP em vez de HTTPS
authSchemes	Lista de esquemas de autenticação utilizados para este pedido específico. Esses esquemas definem como a solicitação será autenticada. Se os valores forem fornecidos, esses esquemas substituirão os esquemas de autenticação no nível do cliente. Se uma matriz vazia for fornecida, ela não especifica explicitamente nenhuma autenticação para a solicitação. Se não for fornecido no nível da solicitação, os esquemas de autenticação no nível do cliente serão usados.
body	O conteúdo do corpo HTTP (se houver)
disableKeepAlive	Se a conexão não deve ser reutilizada.
enableBrowserStreams	APENAS NAVEGADOR Uma opção apenas do navegador para ativar os Streams do navegador. Se essa opção estiver definida e uma resposta for um fluxo, a resposta terá uma propriedade browserStream em vez de blobBody que será indefinida. O valor padrão é false
formData	Para simular uma postagem de formulário do navegador
headers	Os cabeçalhos HTTP a serem usados ao fazer a solicitação.
method	O método HTTP a ser usado ao fazer a solicitação.
multipartBody	Corpo para um pedido de várias partes.
onDownloadProgress	Retorno de chamada que é acionado após o progresso do download.
onUploadProgress	Retorno de chamada que é acionado após o progresso do carregamento.
proxySettings	Configuração de proxy.
requestId	Um identificador exclusivo para a solicitação. Usado para registro e rastreamento.
requestOverrides	Opções adicionais para definir na solicitação. Isso fornece uma maneira de substituir as existentes ou fornecer propriedades de solicitação que não são declaradas. Para obter possíveis propriedades válidas, consulte Opções NodeJS https.request: https://nodejs.org/api/http.html#httprequestoptions-callback Navegador RequestInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit AVISO: As opções especificadas aqui substituirão quaisquer propriedades de mesmo nome quando a solicitação for enviada por HttpClient.
streamResponseStatusCodes	Uma lista de códigos de status de resposta cujo corpo PipelineResponse correspondente deve ser tratado como um fluxo. Quando streamResponseStatusCodes contém o valor Number.POSITIVE_INFINITY qualquer status seria tratado como um fluxo.
timeout	O número de milissegundos que uma solicitação pode levar antes de ser encerrada automaticamente. Se a solicitação for encerrada, uma AbortError será lançada. O padrão é 0, o que desativa o tempo limite.
tlsSettings	Configurações para configurar a autenticação TLS
url	O URL para o qual fazer a solicitação.
withCredentials	Indica se o agente do usuário deve enviar cookies do outro domínio no caso de solicitações de origem cruzada. É definido para false por padrão.

Detalhes de Propriedade

abortSignal

Usado para abortar a solicitação mais tarde.

abortSignal?: AbortSignal

Valor de Propriedade

AbortSignal

agent

SOMENTE NODEJS

Uma opção somente nó para fornecer um http.Agent/https.Agentpersonalizado. Não faz nada ao executar no navegador.

agent?: Agent

Valor de Propriedade

Agent

allowInsecureConnection

Defina como true se a solicitação for enviada por HTTP em vez de HTTPS

allowInsecureConnection?: boolean

Valor de Propriedade

boolean

authSchemes

Lista de esquemas de autenticação utilizados para este pedido específico. Esses esquemas definem como a solicitação será autenticada.

Se os valores forem fornecidos, esses esquemas substituirão os esquemas de autenticação no nível do cliente. Se uma matriz vazia for fornecida, ela não especifica explicitamente nenhuma autenticação para a solicitação. Se não for fornecido no nível da solicitação, os esquemas de autenticação no nível do cliente serão usados.

authSchemes?: AuthScheme[]

Valor de Propriedade

AuthScheme[]

body

O conteúdo do corpo HTTP (se houver)

body?: RequestBodyType

Valor de Propriedade

RequestBodyType

disableKeepAlive

Se a conexão não deve ser reutilizada.

disableKeepAlive?: boolean

Valor de Propriedade

boolean

enableBrowserStreams

APENAS NAVEGADOR

Uma opção apenas do navegador para ativar os Streams do navegador. Se essa opção estiver definida e uma resposta for um fluxo, a resposta terá uma propriedade browserStream em vez de blobBody que será indefinida.

O valor padrão é false

enableBrowserStreams?: boolean

Valor de Propriedade

boolean

formData

Para simular uma postagem de formulário do navegador

formData?: FormDataMap

Valor de Propriedade

FormDataMap

headers

Os cabeçalhos HTTP a serem usados ao fazer a solicitação.

headers: HttpHeaders

Valor de Propriedade

HttpHeaders

method

O método HTTP a ser usado ao fazer a solicitação.

method: HttpMethods

Valor de Propriedade

HttpMethods

multipartBody

Corpo para um pedido de várias partes.

multipartBody?: MultipartRequestBody

Valor de Propriedade

MultipartRequestBody

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

onUploadProgress

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

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

proxySettings

Configuração de proxy.

proxySettings?: ProxySettings

Valor de Propriedade

ProxySettings

requestId

Um identificador exclusivo para a solicitação. Usado para registro e rastreamento.

requestId: string

Valor de Propriedade

string

requestOverrides

Opções adicionais para definir na solicitação. Isso fornece uma maneira de substituir as existentes ou fornecer propriedades de solicitação que não são declaradas.

Para obter possíveis propriedades válidas, consulte

• Opções NodeJS https.request: https://nodejs.org/api/http.html#httprequestoptions-callback
• Navegador RequestInit: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit

AVISO: As opções especificadas aqui substituirão quaisquer propriedades de mesmo nome quando a solicitação for enviada por HttpClient.

requestOverrides?: Record<string, unknown>

Valor de Propriedade

Record<string, unknown>

streamResponseStatusCodes

Uma lista de códigos de status de resposta cujo corpo PipelineResponse correspondente deve ser tratado como um fluxo. Quando streamResponseStatusCodes contém o valor Number.POSITIVE_INFINITY qualquer status seria tratado como um fluxo.

streamResponseStatusCodes?: Set<number>

Valor de Propriedade

Set<number>

timeout

O número de milissegundos que uma solicitação pode levar antes de ser encerrada automaticamente. Se a solicitação for encerrada, uma AbortError será lançada. O padrão é 0, o que desativa o tempo limite.

timeout: number

Valor de Propriedade

number

tlsSettings

Configurações para configurar a autenticação TLS

tlsSettings?: TlsSettings

Valor de Propriedade

TlsSettings

url

O URL para o qual fazer a solicitação.

url: string

Valor de Propriedade

string

withCredentials

Indica se o agente do usuário deve enviar cookies do outro domínio no caso de solicitações de origem cruzada. É definido para false por padrão.

withCredentials: boolean

Valor de Propriedade

boolean