Package org.openqa.selenium.devtools.v126.fetch.model

Class RequestPaused

java.lang.Object

org.openqa.selenium.devtools.v126.fetch.model.RequestPaused

public class RequestPaused
extends Object

Issued when the domain is enabled and the request URL matches the specified filter. The request is paused until the client responds with one of continueRequest, failRequest or fulfillRequest. The stage of the request can be determined by presence of responseErrorReason and responseStatusCode -- the request is at the response stage if either of these fields is present and in the request stage otherwise. Redirect responses and subsequent requests are reported similarly to regular responses and requests. Redirect responses may be distinguished by the value of `responseStatusCode` (which is one of 301, 302, 303, 307, 308) along with presence of the `location` header. Requests resulting from a redirect will have `redirectedRequestId` field set.

Constructor Summary

Constructors

Constructor	Description
RequestPaused(RequestId requestId, Request request, FrameId frameId, ResourceType resourceType, Optional<ErrorReason> responseErrorReason, Optional<Integer> responseStatusCode, Optional<String> responseStatusText, Optional<List<HeaderEntry>> responseHeaders, Optional<RequestId> networkId, Optional<RequestId> redirectedRequestId)

Method Summary

Modifier and Type	Method	Description
FrameId	getFrameId()	The id of the frame that initiated the request.
Optional<RequestId>	getNetworkId()	If the intercepted request had a corresponding Network.requestWillBeSent event fired for it, then this networkId will be the same as the requestId present in the requestWillBeSent event.
Optional<RequestId>	getRedirectedRequestId()	If the request is due to a redirect response from the server, the id of the request that has caused the redirect.
Request	getRequest()	The details of the request.
RequestId	getRequestId()	Each request the page makes will have a unique id.
ResourceType	getResourceType()	How the requested resource will be used.
Optional<ErrorReason>	getResponseErrorReason()	Response error if intercepted at response stage.
Optional<List<HeaderEntry>>	getResponseHeaders()	Response headers if intercepted at the response stage.
Optional<Integer>	getResponseStatusCode()	Response code if intercepted at response stage.
Optional<String>	getResponseStatusText()	Response status text if intercepted at response stage.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RequestPaused

public RequestPaused(RequestId requestId,
 Request request,
 FrameId frameId,
 ResourceType resourceType,
 Optional<ErrorReason> responseErrorReason,
 Optional<Integer> responseStatusCode,
 Optional<String> responseStatusText,
 Optional<List<HeaderEntry>> responseHeaders,
 Optional<RequestId> networkId,
 Optional<RequestId> redirectedRequestId)

Method Details

getRequestId

public RequestId getRequestId()

Each request the page makes will have a unique id.

getRequest

public Request getRequest()

The details of the request.

getFrameId

public FrameId getFrameId()

The id of the frame that initiated the request.

getResourceType

public ResourceType getResourceType()

How the requested resource will be used.

getResponseErrorReason

public Optional<ErrorReason> getResponseErrorReason()

Response error if intercepted at response stage.

getResponseStatusCode

public Optional<Integer> getResponseStatusCode()

Response code if intercepted at response stage.

getResponseStatusText

public Optional<String> getResponseStatusText()

Response status text if intercepted at response stage.

getResponseHeaders

public Optional<List<HeaderEntry>> getResponseHeaders()

Response headers if intercepted at the response stage.

getNetworkId

public Optional<RequestId> getNetworkId()

If the intercepted request had a corresponding Network.requestWillBeSent event fired for it, then this networkId will be the same as the requestId present in the requestWillBeSent event.

getRedirectedRequestId

@Beta
public Optional<RequestId> getRedirectedRequestId()

If the request is due to a redirect response from the server, the id of the request that has caused the redirect.