Package org.openqa.selenium.devtools.v125.preload.model

Class RuleSet

java.lang.Object

org.openqa.selenium.devtools.v125.preload.model.RuleSet

public class RuleSet
extends Object

Corresponds to SpeculationRuleSet

Constructor Summary

Constructors

Constructor	Description
RuleSet(RuleSetId id, LoaderId loaderId, String sourceText, Optional<BackendNodeId> backendNodeId, Optional<String> url, Optional<RequestId> requestId, Optional<RuleSetErrorType> errorType, Optional<String> errorMessage)

Method Summary

Modifier and Type	Method	Description
Optional<BackendNodeId>	getBackendNodeId()	A speculation rule set is either added through an inline `script` tag or through an external resource via the 'Speculation-Rules' HTTP header.
Optional<String>	getErrorMessage()	Deprecated.
Optional<RuleSetErrorType>	getErrorType()	Error information `errorMessage` is null iff `errorType` is null.
RuleSetId	getId()
LoaderId	getLoaderId()	Identifies a document which the rule set is associated with.
Optional<RequestId>	getRequestId()
String	getSourceText()	Source text of JSON representing the rule set.
Optional<String>	getUrl()

Methods inherited from class java.lang.Object

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

Constructor Details

RuleSet

public RuleSet(RuleSetId id,
 LoaderId loaderId,
 String sourceText,
 Optional<BackendNodeId> backendNodeId,
 Optional<String> url,
 Optional<RequestId> requestId,
 Optional<RuleSetErrorType> errorType,
 Optional<String> errorMessage)

Method Details

getId

public RuleSetId getId()

getLoaderId

public LoaderId getLoaderId()

Identifies a document which the rule set is associated with.

getSourceText

public String getSourceText()

Source text of JSON representing the rule set. If it comes from `script` tag, it is the textContent of the node. Note that it is a JSON for valid case. See also: - https://wicg.github.io/nav-speculation/speculation-rules.html - https://github.com/WICG/nav-speculation/blob/main/triggers.md

getBackendNodeId

public Optional<BackendNodeId> getBackendNodeId()

A speculation rule set is either added through an inline `script` tag or through an external resource via the 'Speculation-Rules' HTTP header. For the first case, we include the BackendNodeId of the relevant `script` tag. For the second case, we include the external URL where the rule set was loaded from, and also RequestId if Network domain is enabled. See also: - https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-script - https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-header

getUrl

public Optional<String> getUrl()

getRequestId

public Optional<RequestId> getRequestId()

getErrorType

public Optional<RuleSetErrorType> getErrorType()

Error information `errorMessage` is null iff `errorType` is null.

getErrorMessage

@Deprecated
public Optional<String> getErrorMessage()

Deprecated.

TODO(https://crbug.com/1425354): Replace this property with structured error.