All Implemented Interfaces:


public final class WebSearchTool20260209.Builder

A builder for WebSearchTool20260209.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final WebSearchTool20260209.Builder`	`name(JsonValue name)`	Sets the field to an arbitrary JSON value.
`final WebSearchTool20260209.Builder`	`type(JsonValue type)`	Sets the field to an arbitrary JSON value.
`final WebSearchTool20260209.Builder`	`allowedCallers(List<WebSearchTool20260209.AllowedCaller> allowedCallers)`
`final WebSearchTool20260209.Builder`	`allowedCallers(JsonField<List<WebSearchTool20260209.AllowedCaller>> allowedCallers)`	Sets Builder.allowedCallers to an arbitrary JSON value.
`final WebSearchTool20260209.Builder`	`addAllowedCaller(WebSearchTool20260209.AllowedCaller allowedCaller)`	Adds a single AllowedCaller to allowedCallers.
`final WebSearchTool20260209.Builder`	`allowedDomains(List<String> allowedDomains)`	If provided, only these domains will be included in results.
`final WebSearchTool20260209.Builder`	`allowedDomains(Optional<List<String>> allowedDomains)`	Alias for calling Builder.allowedDomains with `allowedDomains.orElse(null)`.
`final WebSearchTool20260209.Builder`	`allowedDomains(JsonField<List<String>> allowedDomains)`	Sets Builder.allowedDomains to an arbitrary JSON value.
`final WebSearchTool20260209.Builder`	`addAllowedDomain(String allowedDomain)`	Adds a single String to allowedDomains.
`final WebSearchTool20260209.Builder`	`blockedDomains(List<String> blockedDomains)`	If provided, these domains will never appear in results.
`final WebSearchTool20260209.Builder`	`blockedDomains(Optional<List<String>> blockedDomains)`	Alias for calling Builder.blockedDomains with `blockedDomains.orElse(null)`.
`final WebSearchTool20260209.Builder`	`blockedDomains(JsonField<List<String>> blockedDomains)`	Sets Builder.blockedDomains to an arbitrary JSON value.
`final WebSearchTool20260209.Builder`	`addBlockedDomain(String blockedDomain)`	Adds a single String to blockedDomains.
`final WebSearchTool20260209.Builder`	`cacheControl(CacheControlEphemeral cacheControl)`	Create a cache control breakpoint at this content block.
`final WebSearchTool20260209.Builder`	`cacheControl(Optional<CacheControlEphemeral> cacheControl)`	Alias for calling Builder.cacheControl with `cacheControl.orElse(null)`.
`final WebSearchTool20260209.Builder`	`cacheControl(JsonField<CacheControlEphemeral> cacheControl)`	Sets Builder.cacheControl to an arbitrary JSON value.
`final WebSearchTool20260209.Builder`	`deferLoading(Boolean deferLoading)`	If true, tool will not be included in initial system prompt.
`final WebSearchTool20260209.Builder`	`deferLoading(JsonField<Boolean> deferLoading)`	Sets Builder.deferLoading to an arbitrary JSON value.
`final WebSearchTool20260209.Builder`	`maxUses(Long maxUses)`	Maximum number of times the tool can be used in the API request.
`final WebSearchTool20260209.Builder`	`maxUses(Long maxUses)`	Alias for Builder.maxUses.
`final WebSearchTool20260209.Builder`	`maxUses(Optional<Long> maxUses)`	Alias for calling Builder.maxUses with `maxUses.orElse(null)`.
`final WebSearchTool20260209.Builder`	`maxUses(JsonField<Long> maxUses)`	Sets Builder.maxUses to an arbitrary JSON value.
`final WebSearchTool20260209.Builder`	`strict(Boolean strict)`	When true, guarantees schema validation on tool names and inputs
`final WebSearchTool20260209.Builder`	`strict(JsonField<Boolean> strict)`	Sets Builder.strict to an arbitrary JSON value.
`final WebSearchTool20260209.Builder`	`userLocation(UserLocation userLocation)`	Parameters for the user's location.
`final WebSearchTool20260209.Builder`	`userLocation(Optional<UserLocation> userLocation)`	Alias for calling Builder.userLocation with `userLocation.orElse(null)`.
`final WebSearchTool20260209.Builder`	`userLocation(JsonField<UserLocation> userLocation)`	Sets Builder.userLocation to an arbitrary JSON value.
`final WebSearchTool20260209.Builder`	`additionalProperties(Map<String, JsonValue> additionalProperties)`
`final WebSearchTool20260209.Builder`	`putAdditionalProperty(String key, JsonValue value)`
`final WebSearchTool20260209.Builder`	`putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)`
`final WebSearchTool20260209.Builder`	`removeAdditionalProperty(String key)`
`final WebSearchTool20260209.Builder`	`removeAllAdditionalProperties(Set<String> keys)`
`final WebSearchTool20260209`	`build()`	Returns an immutable instance of WebSearchTool20260209.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - name
```
 final WebSearchTool20260209.Builder name(JsonValue name)
```
    Sets the field to an arbitrary JSON value.
    It is usually unnecessary to call this method because the field defaults to the following:
    JsonValue.from("web_search")
    This method is primarily for setting the field to an undocumented or not yet supported value.
  - type
```
 final WebSearchTool20260209.Builder type(JsonValue type)
```
    Sets the field to an arbitrary JSON value.
    It is usually unnecessary to call this method because the field defaults to the following:
    JsonValue.from("web_search_20260209")
    This method is primarily for setting the field to an undocumented or not yet supported value.
  - allowedCallers
```
 final WebSearchTool20260209.Builder allowedCallers(List<WebSearchTool20260209.AllowedCaller> allowedCallers)
```
  - allowedCallers
```
 final WebSearchTool20260209.Builder allowedCallers(JsonField<List<WebSearchTool20260209.AllowedCaller>> allowedCallers)
```
    Sets Builder.allowedCallers to an arbitrary JSON value.
    You should usually call Builder.allowedCallers with a well-typed List<AllowedCaller> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - addAllowedCaller
```
 final WebSearchTool20260209.Builder addAllowedCaller(WebSearchTool20260209.AllowedCaller allowedCaller)
```
    Adds a single AllowedCaller to allowedCallers.
  - allowedDomains
```
 final WebSearchTool20260209.Builder allowedDomains(List<String> allowedDomains)
```
    If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
  - allowedDomains
```
 final WebSearchTool20260209.Builder allowedDomains(Optional<List<String>> allowedDomains)
```
    Alias for calling Builder.allowedDomains with allowedDomains.orElse(null).
  - allowedDomains
```
 final WebSearchTool20260209.Builder allowedDomains(JsonField<List<String>> allowedDomains)
```
    Sets Builder.allowedDomains to an arbitrary JSON value.
    You should usually call Builder.allowedDomains with a well-typed List<String> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - addAllowedDomain
```
 final WebSearchTool20260209.Builder addAllowedDomain(String allowedDomain)
```
    Adds a single String to allowedDomains.
  - blockedDomains
```
 final WebSearchTool20260209.Builder blockedDomains(List<String> blockedDomains)
```
    If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
  - blockedDomains
```
 final WebSearchTool20260209.Builder blockedDomains(Optional<List<String>> blockedDomains)
```
    Alias for calling Builder.blockedDomains with blockedDomains.orElse(null).
  - blockedDomains
```
 final WebSearchTool20260209.Builder blockedDomains(JsonField<List<String>> blockedDomains)
```
    Sets Builder.blockedDomains to an arbitrary JSON value.
    You should usually call Builder.blockedDomains with a well-typed List<String> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - addBlockedDomain
```
 final WebSearchTool20260209.Builder addBlockedDomain(String blockedDomain)
```
    Adds a single String to blockedDomains.
  - cacheControl
```
 final WebSearchTool20260209.Builder cacheControl(CacheControlEphemeral cacheControl)
```
    Create a cache control breakpoint at this content block.
  - cacheControl
```
 final WebSearchTool20260209.Builder cacheControl(Optional<CacheControlEphemeral> cacheControl)
```
    Alias for calling Builder.cacheControl with cacheControl.orElse(null).
  - cacheControl
```
 final WebSearchTool20260209.Builder cacheControl(JsonField<CacheControlEphemeral> cacheControl)
```
    Sets Builder.cacheControl to an arbitrary JSON value.
    You should usually call Builder.cacheControl with a well-typed CacheControlEphemeral value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - deferLoading
```
 final WebSearchTool20260209.Builder deferLoading(Boolean deferLoading)
```
    If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
  - deferLoading
```
 final WebSearchTool20260209.Builder deferLoading(JsonField<Boolean> deferLoading)
```
    Sets Builder.deferLoading to an arbitrary JSON value.
    You should usually call Builder.deferLoading with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - maxUses
```
 final WebSearchTool20260209.Builder maxUses(Long maxUses)
```
    Maximum number of times the tool can be used in the API request.
  - maxUses
```
 final WebSearchTool20260209.Builder maxUses(Long maxUses)
```
    Alias for Builder.maxUses.
    This unboxed primitive overload exists for backwards compatibility.
  - maxUses
```
 final WebSearchTool20260209.Builder maxUses(Optional<Long> maxUses)
```
    Alias for calling Builder.maxUses with maxUses.orElse(null).
  - maxUses
```
 final WebSearchTool20260209.Builder maxUses(JsonField<Long> maxUses)
```
    Sets Builder.maxUses to an arbitrary JSON value.
    You should usually call Builder.maxUses with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - strict
```
 final WebSearchTool20260209.Builder strict(Boolean strict)
```
    When true, guarantees schema validation on tool names and inputs
  - strict
```
 final WebSearchTool20260209.Builder strict(JsonField<Boolean> strict)
```
    Sets Builder.strict to an arbitrary JSON value.
    You should usually call Builder.strict with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - userLocation
```
 final WebSearchTool20260209.Builder userLocation(UserLocation userLocation)
```
    Parameters for the user's location. Used to provide more relevant search results.
  - userLocation
```
 final WebSearchTool20260209.Builder userLocation(Optional<UserLocation> userLocation)
```
    Alias for calling Builder.userLocation with userLocation.orElse(null).
  - userLocation
```
 final WebSearchTool20260209.Builder userLocation(JsonField<UserLocation> userLocation)
```
    Sets Builder.userLocation to an arbitrary JSON value.
    You should usually call Builder.userLocation with a well-typed UserLocation value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
  - additionalProperties
```
 final WebSearchTool20260209.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
```
  - putAdditionalProperty
```
 final WebSearchTool20260209.Builder putAdditionalProperty(String key, JsonValue value)
```
  - putAllAdditionalProperties
```
 final WebSearchTool20260209.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
```
  - removeAdditionalProperty
```
 final WebSearchTool20260209.Builder removeAdditionalProperty(String key)
```
  - removeAllAdditionalProperties
```
 final WebSearchTool20260209.Builder removeAllAdditionalProperties(Set<String> keys)
```
  - build
```
 final WebSearchTool20260209 build()
```
    Returns an immutable instance of WebSearchTool20260209.
    Further updates to this Builder will not mutate the returned instance.

Class WebSearchTool20260209.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

name

type

allowedCallers

allowedCallers

addAllowedCaller

allowedDomains

allowedDomains

allowedDomains

addAllowedDomain

blockedDomains

blockedDomains

blockedDomains

addBlockedDomain

cacheControl

cacheControl

cacheControl

deferLoading

deferLoading

maxUses

maxUses

maxUses

maxUses

strict

strict

userLocation

userLocation

userLocation

additionalProperties

putAdditionalProperty

putAllAdditionalProperties

removeAdditionalProperty

removeAllAdditionalProperties

build