Class SessionObserveParams
-
- All Implemented Interfaces:
-
com.browserbase.api.core.Params
public final class SessionObserveParams implements Params
Identifies and returns available actions on the current page that match the given instruction.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classSessionObserveParams.BuilderA builder for SessionObserveParams.
public final classSessionObserveParams.Bodypublic final classSessionObserveParams.Optionspublic final classSessionObserveParams.XStreamResponseWhether to stream the response via SSE
-
Method Summary
Modifier and Type Method Description final Optional<String>id()Unique session identifier final Optional<SessionObserveParams.XStreamResponse>xStreamResponse()Whether to stream the response via SSE final Optional<String>frameId()Target frame ID for the observation final Optional<String>instruction()Natural language instruction for what actions to find final Optional<SessionObserveParams.Options>options()final JsonField<String>_frameId()Returns the raw JSON value of frameId. final JsonField<String>_instruction()Returns the raw JSON value of instruction. final JsonField<SessionObserveParams.Options>_options()Returns the raw JSON value of options. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final SessionObserveParams.BuildertoBuilder()final SessionObserveParams.Body_body()final String_pathParam(Integer index)Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static SessionObserveParamsnone()final static SessionObserveParams.Builderbuilder()Returns a mutable builder for constructing an instance of SessionObserveParams. -
-
Method Detail
-
xStreamResponse
final Optional<SessionObserveParams.XStreamResponse> xStreamResponse()
Whether to stream the response via SSE
-
instruction
final Optional<String> instruction()
Natural language instruction for what actions to find
-
options
final Optional<SessionObserveParams.Options> options()
-
_frameId
final JsonField<String> _frameId()
Returns the raw JSON value of frameId.
Unlike frameId, this method doesn't throw if the JSON field has an unexpected type.
-
_instruction
final JsonField<String> _instruction()
Returns the raw JSON value of instruction.
Unlike instruction, this method doesn't throw if the JSON field has an unexpected type.
-
_options
final JsonField<SessionObserveParams.Options> _options()
Returns the raw JSON value of options.
Unlike options, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final SessionObserveParams.Builder toBuilder()
-
_body
final SessionObserveParams.Body _body()
-
_pathParam
final String _pathParam(Integer index)
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
none
final static SessionObserveParams none()
-
builder
final static SessionObserveParams.Builder builder()
Returns a mutable builder for constructing an instance of SessionObserveParams.
-
-
-
-