Class WebSearchTool.UserLocation
-
- All Implemented Interfaces:
public final class WebSearchTool.UserLocationThe approximate location of the user.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classWebSearchTool.UserLocation.BuilderA builder for UserLocation.
public final classWebSearchTool.UserLocation.TypeThe type of location approximation. Always
approximate.
-
Method Summary
Modifier and Type Method Description 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 Optional<WebSearchTool.UserLocation.Type>type()The type of location approximation. 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 JsonField<WebSearchTool.UserLocation.Type>_type()Returns the raw JSON value of type. final Map<String, JsonValue>_additionalProperties()final WebSearchTool.UserLocation.BuildertoBuilder()final WebSearchTool.UserLocationvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static WebSearchTool.UserLocation.Builderbuilder()Returns a mutable builder for constructing an instance of UserLocation. -
-
Method Detail
-
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.
-
type
final Optional<WebSearchTool.UserLocation.Type> type()
The type of location approximation. Always
approximate.
-
_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.
-
_type
final JsonField<WebSearchTool.UserLocation.Type> _type()
Returns the raw JSON value of type.
Unlike type, 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()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static WebSearchTool.UserLocation.Builder builder()
Returns a mutable builder for constructing an instance of UserLocation.
-
-
-
-