Update Virtual Pressure Source

The Update Virtual Pressure Source command of the WebDriver API sets a new sample for a virtual pressure source previously created using the Create Virtual Pressure Source command. The new sample is delivered to the page through the Compute Pressure API, letting tests drive pressure-dependent behavior with predetermined data.

Syntax

Method	URI template
`POST`	`/session/{session id}/pressuresource/{type}`

URL parameters

session id: Identifier of the session.
type: The pressure source type to update, for example "cpu".

Payload

The input is an object:

sample: A string giving the pressure state to report. One of "nominal", "fair", "serious", or "critical".
ownContributionEstimate Optional: A number between 0 and 1 estimating the fraction of the reported pressure that is caused by the page itself.

Return value

null if successful.

Errors

invalid session id: Session does not exist.
invalid argument: The sample is not a valid pressure state, or ownContributionEstimate is not a valid number.
unsupported operation: No virtual pressure source of the given type has been created.

Examples

undefined

Updating a virtual pressure source

With a WebDriver server running on localhost:4444, assume a virtual "cpu" pressure source has been created for the active session. To report a new pressure state, send the sample value in the request payload, replacing ID with the sessionId from the New Session response:

bash

curl -i -H "Content-Type: application/json" \
  -d '{"sample": "critical"}' \
  http://localhost:4444/session/ID/pressuresource/cpu

The server responds with a null value to indicate success:

http

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

{"value":null}

Specifications

Compute Pressure Level 1