Struct CreateSessionOptions 

pub struct CreateSessionOptions {
    pub profile_id: Option<String>,
    pub recording: bool,
    pub stealth: bool,
    pub captcha: bool,
    pub proxy: Option<ProxySpec>,
    pub timeout_seconds: Option<u32>,
    pub keep_alive: bool,
    pub user_metadata: Option<Map<String, Value>>,
}

Options accepted by POST /sessions.

Falsy fields are omitted from the request body; if every field is falsy the request is sent with no body at all.

Fields

profile_id: Option<String>

Attach a stored browser profile (cookies + localStorage).

recording: bool

Enable session recording. Off by default.

stealth: bool

Enable the runtime stealth shim. Off by default.

captcha: bool

Enable managed captcha solving. Requires stealth.

proxy: Option<ProxySpec>

Request managed proxy egress. Requires stealth.

timeout_seconds: Option<u32>

End the session earlier than the plan maximum. None leaves the plan maximum; the gateway refuses anything under 60.

keep_alive: bool

Hold the session after the client disconnects, until its deadline (timeout_seconds, else an hour, never past the plan maximum) or until it is released, so a dropped client can reconnect.

user_metadata: Option<Map<String, Value>>

Free-form JSON stored with the session and returned by get and list.

Implementations

impl CreateSessionOptions

pub fn new() -> Self

pub fn profile_id(self, id: impl Into<String>) -> Self

pub fn recording(self, on: bool) -> Self

pub fn stealth(self, on: bool) -> Self

pub fn captcha(self, on: bool) -> Self

pub fn proxy(self, spec: impl Into<ProxySpec>) -> Self

pub fn timeout_seconds(self, seconds: u32) -> Self

pub fn keep_alive(self, on: bool) -> Self

pub fn user_metadata(self, metadata: Map<String, Value>) -> Self

Trait Implementations

impl Clone for CreateSessionOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateSessionOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateSessionOptions

fn default() -> Self

Returns the “default value” for a type.