Interface GeocodeResultItem.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<GeocodeResultItem.Builder,GeocodeResultItem>,SdkBuilder<GeocodeResultItem.Builder,GeocodeResultItem>,SdkPojo
- Enclosing class:
- GeocodeResultItem
public static interface GeocodeResultItem.Builder extends SdkPojo, CopyableBuilder<GeocodeResultItem.Builder,GeocodeResultItem>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description GeocodeResultItem.BuilderaccessPoints(Collection<AccessPoint> accessPoints)Position of the access point represent by longitude and latitude.GeocodeResultItem.BuilderaccessPoints(Consumer<AccessPoint.Builder>... accessPoints)Position of the access point represent by longitude and latitude.GeocodeResultItem.BuilderaccessPoints(AccessPoint... accessPoints)Position of the access point represent by longitude and latitude.default GeocodeResultItem.Builderaddress(Consumer<Address.Builder> address)The place's address.GeocodeResultItem.Builderaddress(Address address)The place's address.GeocodeResultItem.BuilderaddressNumberCorrected(Boolean addressNumberCorrected)Boolean indicating if the address provided has been corrected.GeocodeResultItem.Buildercategories(Collection<Category> categories)Categories of results that results must belong to.GeocodeResultItem.Buildercategories(Consumer<Category.Builder>... categories)Categories of results that results must belong to.GeocodeResultItem.Buildercategories(Category... categories)Categories of results that results must belong to.GeocodeResultItem.Builderdistance(Long distance)The distance in meters from the QueryPosition.GeocodeResultItem.BuilderfoodTypes(Collection<FoodType> foodTypes)List of food types offered by this result.GeocodeResultItem.BuilderfoodTypes(Consumer<FoodType.Builder>... foodTypes)List of food types offered by this result.GeocodeResultItem.BuilderfoodTypes(FoodType... foodTypes)List of food types offered by this result.GeocodeResultItem.BuildermapView(Double... mapView)The bounding box enclosing the geometric shape (area or line) that an individual result covers.GeocodeResultItem.BuildermapView(Collection<Double> mapView)The bounding box enclosing the geometric shape (area or line) that an individual result covers.default GeocodeResultItem.BuildermatchScores(Consumer<MatchScoreDetails.Builder> matchScores)Indicates how well the entire input matches the returned.GeocodeResultItem.BuildermatchScores(MatchScoreDetails matchScores)Indicates how well the entire input matches the returned.GeocodeResultItem.BuilderplaceId(String placeId)ThePlaceIdof the place you wish to receive the information for.GeocodeResultItem.BuilderplaceType(String placeType)APlaceTypeis a category that the result place must belong to.GeocodeResultItem.BuilderplaceType(PlaceType placeType)APlaceTypeis a category that the result place must belong to.GeocodeResultItem.BuilderpoliticalView(String politicalView)The alpha-2 or alpha-3 character code for the political view of a country.GeocodeResultItem.Builderposition(Double... position)The position in longitude and latitude.GeocodeResultItem.Builderposition(Collection<Double> position)The position in longitude and latitude.GeocodeResultItem.BuilderpostalCodeDetails(Collection<PostalCodeDetails> postalCodeDetails)Contains details about the postal code of the place/result.GeocodeResultItem.BuilderpostalCodeDetails(Consumer<PostalCodeDetails.Builder>... postalCodeDetails)Contains details about the postal code of the place/result.GeocodeResultItem.BuilderpostalCodeDetails(PostalCodeDetails... postalCodeDetails)Contains details about the postal code of the place/result.default GeocodeResultItem.BuildertimeZone(Consumer<TimeZone.Builder> timeZone)The time zone in which the place is located.GeocodeResultItem.BuildertimeZone(TimeZone timeZone)The time zone in which the place is located.GeocodeResultItem.Buildertitle(String title)The localized display name of this result item based on request parameterlanguage.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
placeId
GeocodeResultItem.Builder placeId(String placeId)
The
PlaceIdof the place you wish to receive the information for.- Parameters:
placeId- ThePlaceIdof the place you wish to receive the information for.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
placeType
GeocodeResultItem.Builder placeType(String placeType)
A
PlaceTypeis a category that the result place must belong to.
-
placeType
GeocodeResultItem.Builder placeType(PlaceType placeType)
A
PlaceTypeis a category that the result place must belong to.
-
title
GeocodeResultItem.Builder title(String title)
The localized display name of this result item based on request parameter
language.- Parameters:
title- The localized display name of this result item based on request parameterlanguage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
address
GeocodeResultItem.Builder address(Address address)
The place's address.
- Parameters:
address- The place's address.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
address
default GeocodeResultItem.Builder address(Consumer<Address.Builder> address)
The place's address.
This is a convenience method that creates an instance of theAddress.Builderavoiding the need to create one manually viaAddress.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toaddress(Address).- Parameters:
address- a consumer that will call methods onAddress.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
address(Address)
-
addressNumberCorrected
GeocodeResultItem.Builder addressNumberCorrected(Boolean addressNumberCorrected)
Boolean indicating if the address provided has been corrected.
- Parameters:
addressNumberCorrected- Boolean indicating if the address provided has been corrected.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
postalCodeDetails
GeocodeResultItem.Builder postalCodeDetails(Collection<PostalCodeDetails> postalCodeDetails)
Contains details about the postal code of the place/result.
- Parameters:
postalCodeDetails- Contains details about the postal code of the place/result.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
postalCodeDetails
GeocodeResultItem.Builder postalCodeDetails(PostalCodeDetails... postalCodeDetails)
Contains details about the postal code of the place/result.
- Parameters:
postalCodeDetails- Contains details about the postal code of the place/result.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
postalCodeDetails
GeocodeResultItem.Builder postalCodeDetails(Consumer<PostalCodeDetails.Builder>... postalCodeDetails)
Contains details about the postal code of the place/result.
This is a convenience method that creates an instance of thePostalCodeDetails.Builderavoiding the need to create one manually viaPostalCodeDetails.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#postalCodeDetails(List.) - Parameters:
postalCodeDetails- a consumer that will call methods onPostalCodeDetails.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#postalCodeDetails(java.util.Collection)
-
position
GeocodeResultItem.Builder position(Collection<Double> position)
The position in longitude and latitude.
- Parameters:
position- The position in longitude and latitude.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
position
GeocodeResultItem.Builder position(Double... position)
The position in longitude and latitude.
- Parameters:
position- The position in longitude and latitude.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
distance
GeocodeResultItem.Builder distance(Long distance)
The distance in meters from the QueryPosition.
- Parameters:
distance- The distance in meters from the QueryPosition.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mapView
GeocodeResultItem.Builder mapView(Collection<Double> mapView)
The bounding box enclosing the geometric shape (area or line) that an individual result covers.
The bounding box formed is defined as a set 4 coordinates:
[{westward lng}, {southern lat}, {eastward lng}, {northern lat}]- Parameters:
mapView- The bounding box enclosing the geometric shape (area or line) that an individual result covers.The bounding box formed is defined as a set 4 coordinates:
[{westward lng}, {southern lat}, {eastward lng}, {northern lat}]- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mapView
GeocodeResultItem.Builder mapView(Double... mapView)
The bounding box enclosing the geometric shape (area or line) that an individual result covers.
The bounding box formed is defined as a set 4 coordinates:
[{westward lng}, {southern lat}, {eastward lng}, {northern lat}]- Parameters:
mapView- The bounding box enclosing the geometric shape (area or line) that an individual result covers.The bounding box formed is defined as a set 4 coordinates:
[{westward lng}, {southern lat}, {eastward lng}, {northern lat}]- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
categories
GeocodeResultItem.Builder categories(Collection<Category> categories)
Categories of results that results must belong to.
- Parameters:
categories- Categories of results that results must belong to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
categories
GeocodeResultItem.Builder categories(Category... categories)
Categories of results that results must belong to.
- Parameters:
categories- Categories of results that results must belong to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
categories
GeocodeResultItem.Builder categories(Consumer<Category.Builder>... categories)
Categories of results that results must belong to.
This is a convenience method that creates an instance of theCategory.Builderavoiding the need to create one manually viaCategory.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#categories(List.) - Parameters:
categories- a consumer that will call methods onCategory.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#categories(java.util.Collection)
-
foodTypes
GeocodeResultItem.Builder foodTypes(Collection<FoodType> foodTypes)
List of food types offered by this result.
- Parameters:
foodTypes- List of food types offered by this result.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
foodTypes
GeocodeResultItem.Builder foodTypes(FoodType... foodTypes)
List of food types offered by this result.
- Parameters:
foodTypes- List of food types offered by this result.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
foodTypes
GeocodeResultItem.Builder foodTypes(Consumer<FoodType.Builder>... foodTypes)
List of food types offered by this result.
This is a convenience method that creates an instance of theFoodType.Builderavoiding the need to create one manually viaFoodType.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#foodTypes(List.) - Parameters:
foodTypes- a consumer that will call methods onFoodType.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#foodTypes(java.util.Collection)
-
accessPoints
GeocodeResultItem.Builder accessPoints(Collection<AccessPoint> accessPoints)
Position of the access point represent by longitude and latitude.
- Parameters:
accessPoints- Position of the access point represent by longitude and latitude.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
accessPoints
GeocodeResultItem.Builder accessPoints(AccessPoint... accessPoints)
Position of the access point represent by longitude and latitude.
- Parameters:
accessPoints- Position of the access point represent by longitude and latitude.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
accessPoints
GeocodeResultItem.Builder accessPoints(Consumer<AccessPoint.Builder>... accessPoints)
Position of the access point represent by longitude and latitude.
This is a convenience method that creates an instance of theAccessPoint.Builderavoiding the need to create one manually viaAccessPoint.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#accessPoints(List.) - Parameters:
accessPoints- a consumer that will call methods onAccessPoint.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#accessPoints(java.util.Collection)
-
timeZone
GeocodeResultItem.Builder timeZone(TimeZone timeZone)
The time zone in which the place is located.
- Parameters:
timeZone- The time zone in which the place is located.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timeZone
default GeocodeResultItem.Builder timeZone(Consumer<TimeZone.Builder> timeZone)
The time zone in which the place is located.
This is a convenience method that creates an instance of theTimeZone.Builderavoiding the need to create one manually viaTimeZone.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totimeZone(TimeZone).- Parameters:
timeZone- a consumer that will call methods onTimeZone.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
timeZone(TimeZone)
-
politicalView
GeocodeResultItem.Builder politicalView(String politicalView)
The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.
- Parameters:
politicalView- The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
matchScores
GeocodeResultItem.Builder matchScores(MatchScoreDetails matchScores)
Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.
- Parameters:
matchScores- Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
matchScores
default GeocodeResultItem.Builder matchScores(Consumer<MatchScoreDetails.Builder> matchScores)
Indicates how well the entire input matches the returned. It is equal to 1 if all input tokens are recognized and matched.
This is a convenience method that creates an instance of theMatchScoreDetails.Builderavoiding the need to create one manually viaMatchScoreDetails.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tomatchScores(MatchScoreDetails).- Parameters:
matchScores- a consumer that will call methods onMatchScoreDetails.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
matchScores(MatchScoreDetails)
-
-