Class BetaToolComputerUse20250124
-
- All Implemented Interfaces:
public final class BetaToolComputerUse20250124
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBetaToolComputerUse20250124.BuilderA builder for BetaToolComputerUse20250124.
public final classBetaToolComputerUse20250124.AllowedCallerSpecifies who can invoke a tool.
Values: direct: The model can call this tool directly. code_execution_20250825: The tool can be called from the code execution environment (v1). code_execution_20260120: The tool can be called from the code execution environment (v2 with persistence).
public final classBetaToolComputerUse20250124.InputExample
-
Method Summary
Modifier and Type Method Description final LongdisplayHeightPx()The height of the display in pixels. final LongdisplayWidthPx()The width of the display in pixels. final JsonValue_name()Name of the tool. final JsonValue_type()Expected to always return the following:
However, this method can be useful for debugging and logging (e.g.JsonValue.from("computer_20250124")final Optional<List<BetaToolComputerUse20250124.AllowedCaller>>allowedCallers()final Optional<BetaCacheControlEphemeral>cacheControl()Create a cache control breakpoint at this content block. final Optional<Boolean>deferLoading()If true, tool will not be included in initial system prompt. final Optional<Long>displayNumber()The X11 display number (e.g. final Optional<List<BetaToolComputerUse20250124.InputExample>>inputExamples()final Optional<Boolean>strict()When true, guarantees schema validation on tool names and inputs final JsonField<Long>_displayHeightPx()Returns the raw JSON value of displayHeightPx. final JsonField<Long>_displayWidthPx()Returns the raw JSON value of displayWidthPx. final JsonField<List<BetaToolComputerUse20250124.AllowedCaller>>_allowedCallers()Returns the raw JSON value of allowedCallers. final JsonField<BetaCacheControlEphemeral>_cacheControl()Returns the raw JSON value of cacheControl. final JsonField<Boolean>_deferLoading()Returns the raw JSON value of deferLoading. final JsonField<Long>_displayNumber()Returns the raw JSON value of displayNumber. final JsonField<List<BetaToolComputerUse20250124.InputExample>>_inputExamples()Returns the raw JSON value of inputExamples. final JsonField<Boolean>_strict()Returns the raw JSON value of strict. final Map<String, JsonValue>_additionalProperties()final BetaToolComputerUse20250124.BuildertoBuilder()final BetaToolComputerUse20250124validate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static BetaToolComputerUse20250124.Builderbuilder()Returns a mutable builder for constructing an instance of BetaToolComputerUse20250124. -
-
Method Detail
-
displayHeightPx
final Long displayHeightPx()
The height of the display in pixels.
-
displayWidthPx
final Long displayWidthPx()
The width of the display in pixels.
-
_name
final JsonValue _name()
Name of the tool.
This is how the tool will be called by the model and in
tool_useblocks.Expected to always return the following:
JsonValue.from("computer")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_type
final JsonValue _type()
Expected to always return the following:
JsonValue.from("computer_20250124")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
allowedCallers
final Optional<List<BetaToolComputerUse20250124.AllowedCaller>> allowedCallers()
-
cacheControl
final Optional<BetaCacheControlEphemeral> cacheControl()
Create a cache control breakpoint at this content block.
-
deferLoading
final Optional<Boolean> deferLoading()
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
-
displayNumber
final Optional<Long> displayNumber()
The X11 display number (e.g. 0, 1) for the display.
-
inputExamples
final Optional<List<BetaToolComputerUse20250124.InputExample>> inputExamples()
-
strict
final Optional<Boolean> strict()
When true, guarantees schema validation on tool names and inputs
-
_displayHeightPx
final JsonField<Long> _displayHeightPx()
Returns the raw JSON value of displayHeightPx.
Unlike displayHeightPx, this method doesn't throw if the JSON field has an unexpected type.
-
_displayWidthPx
final JsonField<Long> _displayWidthPx()
Returns the raw JSON value of displayWidthPx.
Unlike displayWidthPx, this method doesn't throw if the JSON field has an unexpected type.
-
_allowedCallers
final JsonField<List<BetaToolComputerUse20250124.AllowedCaller>> _allowedCallers()
Returns the raw JSON value of allowedCallers.
Unlike allowedCallers, this method doesn't throw if the JSON field has an unexpected type.
-
_cacheControl
final JsonField<BetaCacheControlEphemeral> _cacheControl()
Returns the raw JSON value of cacheControl.
Unlike cacheControl, this method doesn't throw if the JSON field has an unexpected type.
-
_deferLoading
final JsonField<Boolean> _deferLoading()
Returns the raw JSON value of deferLoading.
Unlike deferLoading, this method doesn't throw if the JSON field has an unexpected type.
-
_displayNumber
final JsonField<Long> _displayNumber()
Returns the raw JSON value of displayNumber.
Unlike displayNumber, this method doesn't throw if the JSON field has an unexpected type.
-
_inputExamples
final JsonField<List<BetaToolComputerUse20250124.InputExample>> _inputExamples()
Returns the raw JSON value of inputExamples.
Unlike inputExamples, this method doesn't throw if the JSON field has an unexpected type.
-
_strict
final JsonField<Boolean> _strict()
Returns the raw JSON value of strict.
Unlike strict, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final BetaToolComputerUse20250124.Builder toBuilder()
-
validate
final BetaToolComputerUse20250124 validate()
-
builder
final static BetaToolComputerUse20250124.Builder builder()
Returns a mutable builder for constructing an instance of BetaToolComputerUse20250124.
The following fields are required:
.displayHeightPx() .displayWidthPx()
-
-
-
-