Class WebSearchTool.UserLocation
-
- All Implemented Interfaces:
public final class WebSearchTool.UserLocation
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
WebSearchTool.UserLocation.Builder
A builder for UserLocation.
-
Method Summary
Modifier and Type Method Description final JsonValue
_type()
The type of location approximation. final Optional<String>
city()
Free text input for the city of the user, e.g. final Optional<String>
country()
The two-letter ISO country code of the user, e.g. final Optional<String>
region()
Free text input for the region of the user, e.g. final Optional<String>
timezone()
The IANA timezone of the user, e.g. final JsonField<String>
_city()
Returns the raw JSON value of city. final JsonField<String>
_country()
Returns the raw JSON value of country. final JsonField<String>
_region()
Returns the raw JSON value of region. final JsonField<String>
_timezone()
Returns the raw JSON value of timezone. final Map<String, JsonValue>
_additionalProperties()
final WebSearchTool.UserLocation.Builder
toBuilder()
final WebSearchTool.UserLocation
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static WebSearchTool.UserLocation.Builder
builder()
Returns a mutable builder for constructing an instance of UserLocation. -
-
Method Detail
-
_type
final JsonValue _type()
The type of location approximation. Always
approximate
.Expected to always return the following:
JsonValue.from("approximate")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
country
final Optional<String> country()
The two-letter ISO country code of the user, e.g.
US
.
-
timezone
final Optional<String> timezone()
The IANA timezone of the user, e.g.
America/Los_Angeles
.
-
_city
final JsonField<String> _city()
Returns the raw JSON value of city.
Unlike city, this method doesn't throw if the JSON field has an unexpected type.
-
_country
final JsonField<String> _country()
Returns the raw JSON value of country.
Unlike country, this method doesn't throw if the JSON field has an unexpected type.
-
_region
final JsonField<String> _region()
Returns the raw JSON value of region.
Unlike region, this method doesn't throw if the JSON field has an unexpected type.
-
_timezone
final JsonField<String> _timezone()
Returns the raw JSON value of timezone.
Unlike timezone, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final WebSearchTool.UserLocation.Builder toBuilder()
-
validate
final WebSearchTool.UserLocation validate()
-
builder
final static WebSearchTool.UserLocation.Builder builder()
Returns a mutable builder for constructing an instance of UserLocation.
-
-
-
-