PipelineRequest interface
Métadonnées relatives à une requête effectuée par le pipeline.
Propriétés
abort |
Utilisé pour abandonner la requête ultérieurement. |
agent | NODEJS UNIQUEMENT Option Node uniquement pour fournir une |
allow |
Défini sur true si la requête est envoyée via HTTP au lieu de HTTPS |
body | Contenu du corps HTTP (le cas échéant) |
disable |
Si la connexion ne doit pas être réutilisée. |
enable |
NAVIGATEUR UNIQUEMENT Option de navigateur uniquement pour activer les flux de navigateur. Si cette option est définie et qu’une réponse est un flux, la réponse aura une propriété La valeur par défaut est false |
form |
Pour simuler une publication de formulaire de navigateur |
headers | En-têtes HTTP à utiliser lors de la requête. |
method | Méthode HTTP à utiliser lors de l’établissement de la requête. |
multipart |
Corps d’une requête multipart. |
on |
Rappel qui se déclenche lors de la progression du téléchargement. |
on |
Rappel qui se déclenche lors de la progression du chargement. |
proxy |
Configuration du proxy. |
request |
Identificateur unique de la requête. Utilisé pour la journalisation et le suivi. |
stream |
Liste des codes d’état de réponse dont le corps PipelineResponse correspondant doit être traité comme un flux. Lorsque streamResponseStatusCodes contient la valeur Number.POSITIVE_INFINITY tout état serait traité comme un flux. |
timeout | Le nombre de millisecondes qu’une demande peut prendre avant de se terminer automatiquement.
Si la demande est terminée, une |
tls |
Paramètres de configuration de l’authentification TLS |
tracing |
Options de suivi à utiliser pour toutes les étendues créées. |
url | URL à laquelle effectuer la requête. |
with |
Indique si l’agent utilisateur doit envoyer des cookies à partir de l’autre domaine en cas de requêtes inter-origines. La valeur par défaut est false. |
Détails de la propriété
abortSignal
Utilisé pour abandonner la requête ultérieurement.
abortSignal?: AbortSignalLike
Valeur de propriété
agent
NODEJS UNIQUEMENT
Option Node uniquement pour fournir une http.Agent
/https.Agent
personnalisée.
Ne fait rien lors de l’exécution dans le navigateur.
agent?: Agent
Valeur de propriété
allowInsecureConnection
Défini sur true si la requête est envoyée via HTTP au lieu de HTTPS
allowInsecureConnection?: boolean
Valeur de propriété
boolean
body
disableKeepAlive
Si la connexion ne doit pas être réutilisée.
disableKeepAlive?: boolean
Valeur de propriété
boolean
enableBrowserStreams
NAVIGATEUR UNIQUEMENT
Option de navigateur uniquement pour activer les flux de navigateur. Si cette option est définie et qu’une réponse est un flux, la réponse aura une propriété browserStream
au lieu de blobBody
qui ne sera pas définie.
La valeur par défaut est false
enableBrowserStreams?: boolean
Valeur de propriété
boolean
formData
Pour simuler une publication de formulaire de navigateur
formData?: FormDataMap
Valeur de propriété
headers
method
Méthode HTTP à utiliser lors de l’établissement de la requête.
method: HttpMethods
Valeur de propriété
multipartBody
Corps d’une requête multipart.
multipartBody?: MultipartRequestBody
Valeur de propriété
onDownloadProgress
Rappel qui se déclenche lors de la progression du téléchargement.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Valeur de propriété
(progress: TransferProgressEvent) => void
onUploadProgress
Rappel qui se déclenche lors de la progression du chargement.
onUploadProgress?: (progress: TransferProgressEvent) => void
Valeur de propriété
(progress: TransferProgressEvent) => void
proxySettings
requestId
Identificateur unique de la requête. Utilisé pour la journalisation et le suivi.
requestId: string
Valeur de propriété
string
streamResponseStatusCodes
Liste des codes d’état de réponse dont le corps PipelineResponse correspondant doit être traité comme un flux. Lorsque streamResponseStatusCodes contient la valeur Number.POSITIVE_INFINITY tout état serait traité comme un flux.
streamResponseStatusCodes?: Set<number>
Valeur de propriété
Set<number>
timeout
Le nombre de millisecondes qu’une demande peut prendre avant de se terminer automatiquement.
Si la demande est terminée, une AbortError
est levée.
La valeur par défaut est 0, ce qui désactive le délai d’expiration.
timeout: number
Valeur de propriété
number
tlsSettings
Paramètres de configuration de l’authentification TLS
tlsSettings?: TlsSettings
Valeur de propriété
tracingOptions
Options de suivi à utiliser pour toutes les étendues créées.
tracingOptions?: OperationTracingOptions
Valeur de propriété
url
URL à laquelle effectuer la requête.
url: string
Valeur de propriété
string
withCredentials
Indique si l’agent utilisateur doit envoyer des cookies à partir de l’autre domaine en cas de requêtes inter-origines. La valeur par défaut est false.
withCredentials: boolean
Valeur de propriété
boolean