Struct google_api_proto::google::maps::regionlookup::v1alpha::RegionSearchValue

pub struct RegionSearchValue {
    pub place_type: i32,
    pub language_code: String,
    pub region_code: String,
    pub location: Option<Location>,
}

Region Search Values.

Desired search values of a single region.

Location must be specified by one of the following: address, latlng or place_id. If none is specified, an INVALID_ARGUMENT error is returned. region_code must also be provided when address is specified.

The fields address, latlng and place_id specify a location contained inside the region to match. For example if address is “1600 Amphitheatre Pkwy, Mountain View, CA 94043” the API returns the following matched_place_id results when the following place_types are specified:

place_type: matched_place_id results: postal_code Place ID for “94043” administrative_area_level_1 Place ID for The State of California administrative_area_level_2 Place ID for Santa Clara County etc.

More Examples:

If latlng is “latitude: 37.4220656 longitude: -122.0862784” and place_type is “locality”, the result contains the Place ID (of type “locality”) for that location (the Place ID of Mountain View, CA, in this case).

If place_id is “ChIJj61dQgK6j4AR4GeTYWZsKWw” (Place ID for Google office in Mountain view, CA) and place_type is “locality”, the result contains the Place ID (of type “locality”) for that location (the Place ID of Mountain View, CA, in this case).

If no match is found, matched_place_id is not set.

Candidates Place IDs are returned when a search finds multiple Place IDs for the location specified. For example if the API is searching for region Place IDs of type neighboorhood for a location that is contained within multiple neighboords. The Place Ids will be returned as candidates in the candidate_place_ids field.

Next available tag: 10

Fields

place_type: i32

Required. The type of the place to match.

language_code: String

The BCP-47 language code, such as “en-US” or “sr-Latn”, corresponding to the language in which the place name and address is requested. If none is requested, then it defaults to English.

region_code: String

Two-letter ISO-3166 country/region code for the location you’re trying to match. region_code is required when address is specified.

location: Option<Location>

The location must be specified by one of the following:

Implementations

impl RegionSearchValue

pub fn place_type(&self) -> PlaceType

Returns the enum value of place_type, or the default if the field is set to an invalid enum value.

pub fn set_place_type(&mut self, value: PlaceType)

Sets place_type to the provided enum value.

Trait Implementations

impl Clone for RegionSearchValue

fn clone(&self) -> RegionSearchValue

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RegionSearchValue

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RegionSearchValue

fn default() -> Self

Returns the “default value” for a type.

impl Message for RegionSearchValue

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for RegionSearchValue

fn eq(&self, other: &RegionSearchValue) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RegionSearchValue