Package org.openqa.selenium.devtools.v141.storage.model

Class SharedStorageAccessParams

java.lang.Object

org.openqa.selenium.devtools.v141.storage.model.SharedStorageAccessParams

public class SharedStorageAccessParams
extends Object

Bundles the parameters for shared storage access events whose presence/absence can vary according to SharedStorageAccessType.

Constructor Summary

Constructors

Constructor

Description

SharedStorageAccessParams(Optional<String> scriptSourceUrl, Optional<String> dataOrigin, Optional<String> operationName, Optional<String> operationId, Optional<Boolean> keepAlive, Optional<SharedStoragePrivateAggregationConfig> privateAggregationConfig, Optional<String> serializedData, Optional<List<SharedStorageUrlWithMetadata>> urlsWithMetadata, Optional<String> urnUuid, Optional<String> key, Optional<String> value, Optional<Boolean> ignoreIfPresent, Optional<Integer> workletOrdinal, Optional<TargetID> workletTargetId, Optional<String> withLock, Optional<String> batchUpdateId, Optional<Integer> batchSize)

Method Summary

Modifier and Type	Method	Description
Optional<Integer>	getBatchSize()	Number of modifier methods sent in batch.
Optional<String>	getBatchUpdateId()	If the method has been called as part of a batchUpdate, then this number identifies the batch to which it belongs.
Optional<String>	getDataOrigin()	String denoting "context-origin", "script-origin", or a custom origin to be used as the worklet's data origin.
Optional<Boolean>	getIgnoreIfPresent()	Whether or not to set an entry for a key if that key is already present.
Optional<Boolean>	getKeepAlive()	Whether or not to keep the worket alive for future run or selectURL calls.
Optional<String>	getKey()	Key for a specific entry in an origin's shared storage.
Optional<String>	getOperationId()	ID of the operation call.
Optional<String>	getOperationName()	Name of the registered operation to be run.
Optional<SharedStoragePrivateAggregationConfig>	getPrivateAggregationConfig()	Configures the private aggregation options.
Optional<String>	getScriptSourceUrl()	Spec of the module script URL.
Optional<String>	getSerializedData()	The operation's serialized data in bytes (converted to a string).
Optional<List<SharedStorageUrlWithMetadata>>	getUrlsWithMetadata()	Array of candidate URLs' specs, along with any associated metadata.
Optional<String>	getUrnUuid()	Spec of the URN:UUID generated for a selectURL call.
Optional<String>	getValue()	Value for a specific entry in an origin's shared storage.
Optional<String>	getWithLock()	Name of the lock to be acquired, if present.
Optional<Integer>	getWorkletOrdinal()	A number denoting the (0-based) order of the worklet's creation relative to all other shared storage worklets created by documents using the current storage partition.
Optional<TargetID>	getWorkletTargetId()	Hex representation of the DevTools token used as the TargetID for the associated shared storage worklet.

Methods inherited from class java.lang.Object

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

Constructor Details

SharedStorageAccessParams

public SharedStorageAccessParams(Optional<String> scriptSourceUrl,
 Optional<String> dataOrigin,
 Optional<String> operationName,
 Optional<String> operationId,
 Optional<Boolean> keepAlive,
 Optional<SharedStoragePrivateAggregationConfig> privateAggregationConfig,
 Optional<String> serializedData,
 Optional<List<SharedStorageUrlWithMetadata>> urlsWithMetadata,
 Optional<String> urnUuid,
 Optional<String> key,
 Optional<String> value,
 Optional<Boolean> ignoreIfPresent,
 Optional<Integer> workletOrdinal,
 Optional<TargetID> workletTargetId,
 Optional<String> withLock,
 Optional<String> batchUpdateId,
 Optional<Integer> batchSize)

Method Details

getScriptSourceUrl

public Optional<String> getScriptSourceUrl()

Spec of the module script URL. Present only for SharedStorageAccessMethods: addModule and createWorklet.

getDataOrigin

public Optional<String> getDataOrigin()

String denoting "context-origin", "script-origin", or a custom origin to be used as the worklet's data origin. Present only for SharedStorageAccessMethod: createWorklet.

getOperationName

public Optional<String> getOperationName()

Name of the registered operation to be run. Present only for SharedStorageAccessMethods: run and selectURL.

getOperationId

public Optional<String> getOperationId()

ID of the operation call. Present only for SharedStorageAccessMethods: run and selectURL.

getKeepAlive

public Optional<Boolean> getKeepAlive()

Whether or not to keep the worket alive for future run or selectURL calls. Present only for SharedStorageAccessMethods: run and selectURL.

getPrivateAggregationConfig

public Optional<SharedStoragePrivateAggregationConfig> getPrivateAggregationConfig()

Configures the private aggregation options. Present only for SharedStorageAccessMethods: run and selectURL.

getSerializedData

public Optional<String> getSerializedData()

The operation's serialized data in bytes (converted to a string). Present only for SharedStorageAccessMethods: run and selectURL. TODO(crbug.com/401011862): Consider updating this parameter to binary.

getUrlsWithMetadata

public Optional<List<SharedStorageUrlWithMetadata>> getUrlsWithMetadata()

Array of candidate URLs' specs, along with any associated metadata. Present only for SharedStorageAccessMethod: selectURL.

getUrnUuid

public Optional<String> getUrnUuid()

Spec of the URN:UUID generated for a selectURL call. Present only for SharedStorageAccessMethod: selectURL.

getKey

public Optional<String> getKey()

Key for a specific entry in an origin's shared storage. Present only for SharedStorageAccessMethods: set, append, delete, and get.

getValue

public Optional<String> getValue()

Value for a specific entry in an origin's shared storage. Present only for SharedStorageAccessMethods: set and append.

getIgnoreIfPresent

public Optional<Boolean> getIgnoreIfPresent()

Whether or not to set an entry for a key if that key is already present. Present only for SharedStorageAccessMethod: set.

getWorkletOrdinal

public Optional<Integer> getWorkletOrdinal()

A number denoting the (0-based) order of the worklet's creation relative to all other shared storage worklets created by documents using the current storage partition. Present only for SharedStorageAccessMethods: addModule, createWorklet.

getWorkletTargetId

public Optional<TargetID> getWorkletTargetId()

Hex representation of the DevTools token used as the TargetID for the associated shared storage worklet. Present only for SharedStorageAccessMethods: addModule, createWorklet, run, selectURL, and any other SharedStorageAccessMethod when the SharedStorageAccessScope is sharedStorageWorklet.

getWithLock

public Optional<String> getWithLock()

Name of the lock to be acquired, if present. Optionally present only for SharedStorageAccessMethods: batchUpdate, set, append, delete, and clear.

getBatchUpdateId

public Optional<String> getBatchUpdateId()

If the method has been called as part of a batchUpdate, then this number identifies the batch to which it belongs. Optionally present only for SharedStorageAccessMethods: batchUpdate (required), set, append, delete, and clear.

getBatchSize

public Optional<Integer> getBatchSize()

Number of modifier methods sent in batch. Present only for SharedStorageAccessMethod: batchUpdate.