com.google.maps.places.v1.SearchNearbyRequestOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-maps-places-v1 Show documentation
Show all versions of proto-google-maps-places-v1 Show documentation
Proto library for google-maps-places
/*
* Copyright 2023 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/maps/places/v1/places_service.proto
package com.google.maps.places.v1;
public interface SearchNearbyRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.maps.places.v1.SearchNearbyRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Place details will be displayed with the preferred language if available.
* If the language code is unspecified or unrecognized, place details of any
* language may be returned, with a preference for English if such details
* exist.
*
* Current list of supported languages:
* https://developers.google.com/maps/faq#languagesupport.
*
*
* string language_code = 1;
*
* @return The languageCode.
*/
java.lang.String getLanguageCode();
/**
*
*
*
* Place details will be displayed with the preferred language if available.
* If the language code is unspecified or unrecognized, place details of any
* language may be returned, with a preference for English if such details
* exist.
*
* Current list of supported languages:
* https://developers.google.com/maps/faq#languagesupport.
*
*
* string language_code = 1;
*
* @return The bytes for languageCode.
*/
com.google.protobuf.ByteString getLanguageCodeBytes();
/**
*
*
*
* The Unicode country/region code (CLDR) of the location where the
* request is coming from. This parameter is used to display the place
* details, like region-specific place name, if available. The parameter can
* affect results based on applicable law.
*
* For more information, see
* http://www.unicode.org/reports/tr35/#unicode_region_subtag.
*
*
* Note that 3-digit region codes are not currently supported.
*
*
* string region_code = 2;
*
* @return The regionCode.
*/
java.lang.String getRegionCode();
/**
*
*
*
* The Unicode country/region code (CLDR) of the location where the
* request is coming from. This parameter is used to display the place
* details, like region-specific place name, if available. The parameter can
* affect results based on applicable law.
*
* For more information, see
* http://www.unicode.org/reports/tr35/#unicode_region_subtag.
*
*
* Note that 3-digit region codes are not currently supported.
*
*
* string region_code = 2;
*
* @return The bytes for regionCode.
*/
com.google.protobuf.ByteString getRegionCodeBytes();
/**
*
*
*
* Included Place type (eg, "restaurant" or "gas_station") from
* https://developers.google.com/places/supported_types.
*
* If there are any conflicting types, i.e. a type appears in both
* included_types and excluded_types, an INVALID_ARGUMENT error is
* returned.
*
* If a Place type is specified with multiple type restrictions, only places
* that satisfy all of the restrictions are returned. For example, if we
* have {included_types = ["restaurant"], excluded_primary_types =
* ["restaurant"]}, the returned places are POIs that provide "restaurant"
* related services but do not operate primarily as "restaurants".
*
*
* repeated string included_types = 3;
*
* @return A list containing the includedTypes.
*/
java.util.List getIncludedTypesList();
/**
*
*
*
* Included Place type (eg, "restaurant" or "gas_station") from
* https://developers.google.com/places/supported_types.
*
* If there are any conflicting types, i.e. a type appears in both
* included_types and excluded_types, an INVALID_ARGUMENT error is
* returned.
*
* If a Place type is specified with multiple type restrictions, only places
* that satisfy all of the restrictions are returned. For example, if we
* have {included_types = ["restaurant"], excluded_primary_types =
* ["restaurant"]}, the returned places are POIs that provide "restaurant"
* related services but do not operate primarily as "restaurants".
*
*
* repeated string included_types = 3;
*
* @return The count of includedTypes.
*/
int getIncludedTypesCount();
/**
*
*
*
* Included Place type (eg, "restaurant" or "gas_station") from
* https://developers.google.com/places/supported_types.
*
* If there are any conflicting types, i.e. a type appears in both
* included_types and excluded_types, an INVALID_ARGUMENT error is
* returned.
*
* If a Place type is specified with multiple type restrictions, only places
* that satisfy all of the restrictions are returned. For example, if we
* have {included_types = ["restaurant"], excluded_primary_types =
* ["restaurant"]}, the returned places are POIs that provide "restaurant"
* related services but do not operate primarily as "restaurants".
*
*
* repeated string included_types = 3;
*
* @param index The index of the element to return.
* @return The includedTypes at the given index.
*/
java.lang.String getIncludedTypes(int index);
/**
*
*
*
* Included Place type (eg, "restaurant" or "gas_station") from
* https://developers.google.com/places/supported_types.
*
* If there are any conflicting types, i.e. a type appears in both
* included_types and excluded_types, an INVALID_ARGUMENT error is
* returned.
*
* If a Place type is specified with multiple type restrictions, only places
* that satisfy all of the restrictions are returned. For example, if we
* have {included_types = ["restaurant"], excluded_primary_types =
* ["restaurant"]}, the returned places are POIs that provide "restaurant"
* related services but do not operate primarily as "restaurants".
*
*
* repeated string included_types = 3;
*
* @param index The index of the value to return.
* @return The bytes of the includedTypes at the given index.
*/
com.google.protobuf.ByteString getIncludedTypesBytes(int index);
/**
*
*
*
* Excluded Place type (eg, "restaurant" or "gas_station") from
* https://developers.google.com/places/supported_types.
*
* If the client provides both included_types (e.g. restaurant) and
* excluded_types (e.g. cafe), then the response should include places that
* are restaurant but not cafe. The response includes places that match at
* least one of the included_types and none of the excluded_types.
*
* If there are any conflicting types, i.e. a type appears in both
* included_types and excluded_types, an INVALID_ARGUMENT error is returned.
*
* If a Place type is specified with multiple type restrictions, only places
* that satisfy all of the restrictions are returned. For example, if we
* have {included_types = ["restaurant"], excluded_primary_types =
* ["restaurant"]}, the returned places are POIs that provide "restaurant"
* related services but do not operate primarily as "restaurants".
*
*
* repeated string excluded_types = 4;
*
* @return A list containing the excludedTypes.
*/
java.util.List getExcludedTypesList();
/**
*
*
*
* Excluded Place type (eg, "restaurant" or "gas_station") from
* https://developers.google.com/places/supported_types.
*
* If the client provides both included_types (e.g. restaurant) and
* excluded_types (e.g. cafe), then the response should include places that
* are restaurant but not cafe. The response includes places that match at
* least one of the included_types and none of the excluded_types.
*
* If there are any conflicting types, i.e. a type appears in both
* included_types and excluded_types, an INVALID_ARGUMENT error is returned.
*
* If a Place type is specified with multiple type restrictions, only places
* that satisfy all of the restrictions are returned. For example, if we
* have {included_types = ["restaurant"], excluded_primary_types =
* ["restaurant"]}, the returned places are POIs that provide "restaurant"
* related services but do not operate primarily as "restaurants".
*
*
* repeated string excluded_types = 4;
*
* @return The count of excludedTypes.
*/
int getExcludedTypesCount();
/**
*
*
*
* Excluded Place type (eg, "restaurant" or "gas_station") from
* https://developers.google.com/places/supported_types.
*
* If the client provides both included_types (e.g. restaurant) and
* excluded_types (e.g. cafe), then the response should include places that
* are restaurant but not cafe. The response includes places that match at
* least one of the included_types and none of the excluded_types.
*
* If there are any conflicting types, i.e. a type appears in both
* included_types and excluded_types, an INVALID_ARGUMENT error is returned.
*
* If a Place type is specified with multiple type restrictions, only places
* that satisfy all of the restrictions are returned. For example, if we
* have {included_types = ["restaurant"], excluded_primary_types =
* ["restaurant"]}, the returned places are POIs that provide "restaurant"
* related services but do not operate primarily as "restaurants".
*
*
* repeated string excluded_types = 4;
*
* @param index The index of the element to return.
* @return The excludedTypes at the given index.
*/
java.lang.String getExcludedTypes(int index);
/**
*
*
*
* Excluded Place type (eg, "restaurant" or "gas_station") from
* https://developers.google.com/places/supported_types.
*
* If the client provides both included_types (e.g. restaurant) and
* excluded_types (e.g. cafe), then the response should include places that
* are restaurant but not cafe. The response includes places that match at
* least one of the included_types and none of the excluded_types.
*
* If there are any conflicting types, i.e. a type appears in both
* included_types and excluded_types, an INVALID_ARGUMENT error is returned.
*
* If a Place type is specified with multiple type restrictions, only places
* that satisfy all of the restrictions are returned. For example, if we
* have {included_types = ["restaurant"], excluded_primary_types =
* ["restaurant"]}, the returned places are POIs that provide "restaurant"
* related services but do not operate primarily as "restaurants".
*
*
* repeated string excluded_types = 4;
*
* @param index The index of the value to return.
* @return The bytes of the excludedTypes at the given index.
*/
com.google.protobuf.ByteString getExcludedTypesBytes(int index);
/**
*
*
*
* Included primary Place type (e.g. "restaurant" or "gas_station") from
* https://developers.google.com/places/supported_types.
*
* If there are any conflicting primary types, i.e. a type appears in both
* included_primary_types and excluded_primary_types, an INVALID_ARGUMENT
* error is returned.
*
* If a Place type is specified with multiple type restrictions, only places
* that satisfy all of the restrictions are returned. For example, if we
* have {included_types = ["restaurant"], excluded_primary_types =
* ["restaurant"]}, the returned places are POIs that provide "restaurant"
* related services but do not operate primarily as "restaurants".
*
*
* repeated string included_primary_types = 5;
*
* @return A list containing the includedPrimaryTypes.
*/
java.util.List getIncludedPrimaryTypesList();
/**
*
*
*
* Included primary Place type (e.g. "restaurant" or "gas_station") from
* https://developers.google.com/places/supported_types.
*
* If there are any conflicting primary types, i.e. a type appears in both
* included_primary_types and excluded_primary_types, an INVALID_ARGUMENT
* error is returned.
*
* If a Place type is specified with multiple type restrictions, only places
* that satisfy all of the restrictions are returned. For example, if we
* have {included_types = ["restaurant"], excluded_primary_types =
* ["restaurant"]}, the returned places are POIs that provide "restaurant"
* related services but do not operate primarily as "restaurants".
*
*
* repeated string included_primary_types = 5;
*
* @return The count of includedPrimaryTypes.
*/
int getIncludedPrimaryTypesCount();
/**
*
*
*
* Included primary Place type (e.g. "restaurant" or "gas_station") from
* https://developers.google.com/places/supported_types.
*
* If there are any conflicting primary types, i.e. a type appears in both
* included_primary_types and excluded_primary_types, an INVALID_ARGUMENT
* error is returned.
*
* If a Place type is specified with multiple type restrictions, only places
* that satisfy all of the restrictions are returned. For example, if we
* have {included_types = ["restaurant"], excluded_primary_types =
* ["restaurant"]}, the returned places are POIs that provide "restaurant"
* related services but do not operate primarily as "restaurants".
*
*
* repeated string included_primary_types = 5;
*
* @param index The index of the element to return.
* @return The includedPrimaryTypes at the given index.
*/
java.lang.String getIncludedPrimaryTypes(int index);
/**
*
*
*
* Included primary Place type (e.g. "restaurant" or "gas_station") from
* https://developers.google.com/places/supported_types.
*
* If there are any conflicting primary types, i.e. a type appears in both
* included_primary_types and excluded_primary_types, an INVALID_ARGUMENT
* error is returned.
*
* If a Place type is specified with multiple type restrictions, only places
* that satisfy all of the restrictions are returned. For example, if we
* have {included_types = ["restaurant"], excluded_primary_types =
* ["restaurant"]}, the returned places are POIs that provide "restaurant"
* related services but do not operate primarily as "restaurants".
*
*
* repeated string included_primary_types = 5;
*
* @param index The index of the value to return.
* @return The bytes of the includedPrimaryTypes at the given index.
*/
com.google.protobuf.ByteString getIncludedPrimaryTypesBytes(int index);
/**
*
*
*
* Excluded primary Place type (e.g. "restaurant" or "gas_station") from
* https://developers.google.com/places/supported_types.
*
* If there are any conflicting primary types, i.e. a type appears in both
* included_primary_types and excluded_primary_types, an INVALID_ARGUMENT
* error is returned.
*
* If a Place type is specified with multiple type restrictions, only places
* that satisfy all of the restrictions are returned. For example, if we
* have {included_types = ["restaurant"], excluded_primary_types =
* ["restaurant"]}, the returned places are POIs that provide "restaurant"
* related services but do not operate primarily as "restaurants".
*
*
* repeated string excluded_primary_types = 6;
*
* @return A list containing the excludedPrimaryTypes.
*/
java.util.List getExcludedPrimaryTypesList();
/**
*
*
*
* Excluded primary Place type (e.g. "restaurant" or "gas_station") from
* https://developers.google.com/places/supported_types.
*
* If there are any conflicting primary types, i.e. a type appears in both
* included_primary_types and excluded_primary_types, an INVALID_ARGUMENT
* error is returned.
*
* If a Place type is specified with multiple type restrictions, only places
* that satisfy all of the restrictions are returned. For example, if we
* have {included_types = ["restaurant"], excluded_primary_types =
* ["restaurant"]}, the returned places are POIs that provide "restaurant"
* related services but do not operate primarily as "restaurants".
*
*
* repeated string excluded_primary_types = 6;
*
* @return The count of excludedPrimaryTypes.
*/
int getExcludedPrimaryTypesCount();
/**
*
*
*
* Excluded primary Place type (e.g. "restaurant" or "gas_station") from
* https://developers.google.com/places/supported_types.
*
* If there are any conflicting primary types, i.e. a type appears in both
* included_primary_types and excluded_primary_types, an INVALID_ARGUMENT
* error is returned.
*
* If a Place type is specified with multiple type restrictions, only places
* that satisfy all of the restrictions are returned. For example, if we
* have {included_types = ["restaurant"], excluded_primary_types =
* ["restaurant"]}, the returned places are POIs that provide "restaurant"
* related services but do not operate primarily as "restaurants".
*
*
* repeated string excluded_primary_types = 6;
*
* @param index The index of the element to return.
* @return The excludedPrimaryTypes at the given index.
*/
java.lang.String getExcludedPrimaryTypes(int index);
/**
*
*
*
* Excluded primary Place type (e.g. "restaurant" or "gas_station") from
* https://developers.google.com/places/supported_types.
*
* If there are any conflicting primary types, i.e. a type appears in both
* included_primary_types and excluded_primary_types, an INVALID_ARGUMENT
* error is returned.
*
* If a Place type is specified with multiple type restrictions, only places
* that satisfy all of the restrictions are returned. For example, if we
* have {included_types = ["restaurant"], excluded_primary_types =
* ["restaurant"]}, the returned places are POIs that provide "restaurant"
* related services but do not operate primarily as "restaurants".
*
*
* repeated string excluded_primary_types = 6;
*
* @param index The index of the value to return.
* @return The bytes of the excludedPrimaryTypes at the given index.
*/
com.google.protobuf.ByteString getExcludedPrimaryTypesBytes(int index);
/**
*
*
*
* Maximum number of results to return. It must be between 1 and 20,
* inclusively. If the number is unset, it falls back to the upper limit. If
* the number is set to negative or exceeds the upper limit, an
* INVALID_ARGUMENT error is returned.
*
*
* int32 max_result_count = 7;
*
* @return The maxResultCount.
*/
int getMaxResultCount();
/**
*
*
*
* Required. The region to search.
*
*
*
* .google.maps.places.v1.SearchNearbyRequest.LocationRestriction location_restriction = 8 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the locationRestriction field is set.
*/
boolean hasLocationRestriction();
/**
*
*
*
* Required. The region to search.
*
*
*
* .google.maps.places.v1.SearchNearbyRequest.LocationRestriction location_restriction = 8 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The locationRestriction.
*/
com.google.maps.places.v1.SearchNearbyRequest.LocationRestriction getLocationRestriction();
/**
*
*
*
* Required. The region to search.
*
*
*
* .google.maps.places.v1.SearchNearbyRequest.LocationRestriction location_restriction = 8 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.maps.places.v1.SearchNearbyRequest.LocationRestrictionOrBuilder
getLocationRestrictionOrBuilder();
/**
*
*
*
* How results will be ranked in the response.
*
*
* .google.maps.places.v1.SearchNearbyRequest.RankPreference rank_preference = 9;
*
* @return The enum numeric value on the wire for rankPreference.
*/
int getRankPreferenceValue();
/**
*
*
*
* How results will be ranked in the response.
*
*
* .google.maps.places.v1.SearchNearbyRequest.RankPreference rank_preference = 9;
*
* @return The rankPreference.
*/
com.google.maps.places.v1.SearchNearbyRequest.RankPreference getRankPreference();
}