PipelineRequest interface
Metagegevens over een aanvraag die wordt gedaan door de pijplijn.
Eigenschappen
abort |
Wordt gebruikt om de aanvraag later af te breken. |
agent | ALLEEN NODEJS Een optie voor alleen knooppunten om een aangepaste |
allow |
Ingesteld op true als de aanvraag wordt verzonden via HTTP in plaats van HTTPS |
body | De HTTP-hoofdtekstinhoud (indien aanwezig) |
disable |
Als de verbinding niet opnieuw moet worden gebruikt. |
enable |
ALLEEN BROWSER Een browseroptie voor het inschakelen van browserstreams. Als deze optie is ingesteld en een antwoord een stream is, heeft het antwoord een eigenschap De standaardwaarde is onwaar |
form |
Een bericht in een browserformulier simuleren |
headers | De HTTP-headers die moeten worden gebruikt bij het maken van de aanvraag. |
method | De HTTP-methode die moet worden gebruikt bij het maken van de aanvraag. |
on |
Callback die wordt geactiveerd bij de voortgang van het downloaden. |
on |
Callback die wordt geactiveerd bij de voortgang van het uploaden. |
proxy |
Proxyconfiguratie. |
request |
Een unieke id voor de aanvraag. Wordt gebruikt voor logboekregistratie en tracering. |
stream |
Een lijst met antwoordstatuscodes waarvan de bijbehorende PipelineResponse-hoofdtekst moet worden behandeld als een stroom. Wanneer streamResponseStatusCodes de waarde Number.POSITIVE_INFINITY wordt elke status behandeld als een stroom. |
timeout | Het aantal milliseconden dat een aanvraag kan duren voordat deze automatisch wordt beëindigd.
Als de aanvraag wordt beëindigd, wordt een |
tls |
Instellingen voor het configureren van TLS-verificatie |
tracing |
Traceringsopties die moeten worden gebruikt voor gemaakte spans. |
url | De URL waarnaar de aanvraag moet worden verzonden. |
with |
Geeft aan of de gebruikersagent cookies van het andere domein moet verzenden in het geval van cross-origin-aanvragen. De standaardinstelling is false. |
Eigenschapdetails
abortSignal
Wordt gebruikt om de aanvraag later af te breken.
abortSignal?: AbortSignalLike
Waarde van eigenschap
AbortSignalLike
agent
ALLEEN NODEJS Een optie voor alleen knooppunten om een aangepaste http.Agent
/https.Agent
.
Doet niets wanneer deze wordt uitgevoerd in de browser.
agent?: Agent
Waarde van eigenschap
allowInsecureConnection
Ingesteld op true als de aanvraag wordt verzonden via HTTP in plaats van HTTPS
allowInsecureConnection?: boolean
Waarde van eigenschap
boolean
body
De HTTP-hoofdtekstinhoud (indien aanwezig)
body?: RequestBodyType
Waarde van eigenschap
disableKeepAlive
Als de verbinding niet opnieuw moet worden gebruikt.
disableKeepAlive?: boolean
Waarde van eigenschap
boolean
enableBrowserStreams
ALLEEN BROWSER Een browseroptie voor het inschakelen van browserstreams. Als deze optie is ingesteld en een antwoord een stream is, heeft het antwoord een eigenschap browserStream
in plaats van blobBody
deze niet-gedefinieerd.
De standaardwaarde is onwaar
enableBrowserStreams?: boolean
Waarde van eigenschap
boolean
formData
Een bericht in een browserformulier simuleren
formData?: FormDataMap
Waarde van eigenschap
headers
De HTTP-headers die moeten worden gebruikt bij het maken van de aanvraag.
headers: HttpHeaders
Waarde van eigenschap
method
De HTTP-methode die moet worden gebruikt bij het maken van de aanvraag.
method: HttpMethods
Waarde van eigenschap
onDownloadProgress
Callback die wordt geactiveerd bij de voortgang van het downloaden.
onDownloadProgress?: (progress: TransferProgressEvent) => void
Waarde van eigenschap
(progress: TransferProgressEvent) => void
onUploadProgress
Callback die wordt geactiveerd bij de voortgang van het uploaden.
onUploadProgress?: (progress: TransferProgressEvent) => void
Waarde van eigenschap
(progress: TransferProgressEvent) => void
proxySettings
requestId
Een unieke id voor de aanvraag. Wordt gebruikt voor logboekregistratie en tracering.
requestId: string
Waarde van eigenschap
string
streamResponseStatusCodes
Een lijst met antwoordstatuscodes waarvan de bijbehorende PipelineResponse-hoofdtekst moet worden behandeld als een stroom. Wanneer streamResponseStatusCodes de waarde Number.POSITIVE_INFINITY wordt elke status behandeld als een stroom.
streamResponseStatusCodes?: Set<number>
Waarde van eigenschap
Set<number>
timeout
Het aantal milliseconden dat een aanvraag kan duren voordat deze automatisch wordt beëindigd.
Als de aanvraag wordt beëindigd, wordt een AbortError
gegenereerd.
De standaardwaarde is 0, waardoor de time-out wordt uitgeschakeld.
timeout: number
Waarde van eigenschap
number
tlsSettings
Instellingen voor het configureren van TLS-verificatie
tlsSettings?: TlsSettings
Waarde van eigenschap
tracingOptions
Traceringsopties die moeten worden gebruikt voor gemaakte spans.
tracingOptions?: OperationTracingOptions
Waarde van eigenschap
OperationTracingOptions
url
De URL waarnaar de aanvraag moet worden verzonden.
url: string
Waarde van eigenschap
string
withCredentials
Geeft aan of de gebruikersagent cookies van het andere domein moet verzenden in het geval van cross-origin-aanvragen. De standaardinstelling is false.
withCredentials: boolean
Waarde van eigenschap
boolean