Class SharedStorageAccessParams


  • public class SharedStorageAccessParams
    extends java.lang.Object
    Bundles the parameters for shared storage access events whose presence/absence can vary according to SharedStorageAccessType.
    • Constructor Summary

      Constructors 
      Constructor Description
      SharedStorageAccessParams​(java.util.Optional<java.lang.String> scriptSourceUrl, java.util.Optional<java.lang.String> operationName, java.util.Optional<java.lang.String> serializedData, java.util.Optional<java.util.List<SharedStorageUrlWithMetadata>> urlsWithMetadata, java.util.Optional<java.lang.String> key, java.util.Optional<java.lang.String> value, java.util.Optional<java.lang.Boolean> ignoreIfPresent)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<java.lang.Boolean> getIgnoreIfPresent()
      Whether or not to set an entry for a key if that key is already present.
      java.util.Optional<java.lang.String> getKey()
      Key for a specific entry in an origin's shared storage.
      java.util.Optional<java.lang.String> getOperationName()
      Name of the registered operation to be run.
      java.util.Optional<java.lang.String> getScriptSourceUrl()
      Spec of the module script URL.
      java.util.Optional<java.lang.String> getSerializedData()
      The operation's serialized data in bytes (converted to a string).
      java.util.Optional<java.util.List<SharedStorageUrlWithMetadata>> getUrlsWithMetadata()
      Array of candidate URLs' specs, along with any associated metadata.
      java.util.Optional<java.lang.String> getValue()
      Value for a specific entry in an origin's shared storage.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • SharedStorageAccessParams

        public SharedStorageAccessParams​(java.util.Optional<java.lang.String> scriptSourceUrl,
                                         java.util.Optional<java.lang.String> operationName,
                                         java.util.Optional<java.lang.String> serializedData,
                                         java.util.Optional<java.util.List<SharedStorageUrlWithMetadata>> urlsWithMetadata,
                                         java.util.Optional<java.lang.String> key,
                                         java.util.Optional<java.lang.String> value,
                                         java.util.Optional<java.lang.Boolean> ignoreIfPresent)
    • Method Detail

      • getScriptSourceUrl

        public java.util.Optional<java.lang.String> getScriptSourceUrl()
        Spec of the module script URL. Present only for SharedStorageAccessType.documentAddModule.
      • getOperationName

        public java.util.Optional<java.lang.String> getOperationName()
        Name of the registered operation to be run. Present only for SharedStorageAccessType.documentRun and SharedStorageAccessType.documentSelectURL.
      • getSerializedData

        public java.util.Optional<java.lang.String> getSerializedData()
        The operation's serialized data in bytes (converted to a string). Present only for SharedStorageAccessType.documentRun and SharedStorageAccessType.documentSelectURL.
      • getUrlsWithMetadata

        public java.util.Optional<java.util.List<SharedStorageUrlWithMetadata>> getUrlsWithMetadata()
        Array of candidate URLs' specs, along with any associated metadata. Present only for SharedStorageAccessType.documentSelectURL.
      • getKey

        public java.util.Optional<java.lang.String> getKey()
        Key for a specific entry in an origin's shared storage. Present only for SharedStorageAccessType.documentSet, SharedStorageAccessType.documentAppend, SharedStorageAccessType.documentDelete, SharedStorageAccessType.workletSet, SharedStorageAccessType.workletAppend, SharedStorageAccessType.workletDelete, and SharedStorageAccessType.workletGet.
      • getValue

        public java.util.Optional<java.lang.String> getValue()
        Value for a specific entry in an origin's shared storage. Present only for SharedStorageAccessType.documentSet, SharedStorageAccessType.documentAppend, SharedStorageAccessType.workletSet, and SharedStorageAccessType.workletAppend.
      • getIgnoreIfPresent

        public java.util.Optional<java.lang.Boolean> getIgnoreIfPresent()
        Whether or not to set an entry for a key if that key is already present. Present only for SharedStorageAccessType.documentSet and SharedStorageAccessType.workletSet.