Package software.amazon.awssdk.services.geoplaces.model

Interface SuggestPlaceResult.Builder

    • Method Detail

      • placeId

        SuggestPlaceResult.Builder placeId​(String placeId)

        The PlaceId of the place you wish to receive the information for.

        Parameters:
        placeId - The PlaceId of 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

        SuggestPlaceResult.Builder placeType​(String placeType)

        A PlaceType is a category that the result place must belong to.

        Parameters:
        placeType - A PlaceType is a category that the result place must belong to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PlaceType, PlaceType

      • placeType

        SuggestPlaceResult.Builder placeType​(PlaceType placeType)

        A PlaceType is a category that the result place must belong to.

        Parameters:
        placeType - A PlaceType is a category that the result place must belong to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PlaceType, PlaceType

      • address

        SuggestPlaceResult.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.

      • position

        SuggestPlaceResult.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

        SuggestPlaceResult.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

        SuggestPlaceResult.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

        SuggestPlaceResult.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

        SuggestPlaceResult.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

        SuggestPlaceResult.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

        SuggestPlaceResult.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.

      • foodTypes

        SuggestPlaceResult.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

        SuggestPlaceResult.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.

      • businessChains

        SuggestPlaceResult.Builder businessChains​(Collection<BusinessChain> businessChains)

        The Business Chains associated with the place.

        Parameters:
        businessChains - The Business Chains associated with the place.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • businessChains

        SuggestPlaceResult.Builder businessChains​(BusinessChain... businessChains)

        The Business Chains associated with the place.

        Parameters:
        businessChains - The Business Chains associated with the place.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • accessPoints

        SuggestPlaceResult.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

        SuggestPlaceResult.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.

      • accessRestrictions

        SuggestPlaceResult.Builder accessRestrictions​(Collection<AccessRestriction> accessRestrictions)

        Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.

        Parameters:
        accessRestrictions - Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • accessRestrictions

        SuggestPlaceResult.Builder accessRestrictions​(AccessRestriction... accessRestrictions)

        Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.

        Parameters:
        accessRestrictions - Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • accessRestrictions

        SuggestPlaceResult.Builder accessRestrictions​(Consumer<AccessRestriction.Builder>... accessRestrictions)

        Indicates known access restrictions on a vehicle access point. The index correlates to an access point and indicates if access through this point has some form of restriction.

        This is a convenience method that creates an instance of the AccessRestriction.Builder avoiding the need to create one manually via AccessRestriction.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #accessRestrictions(List).

        Parameters:
        accessRestrictions - a consumer that will call methods on AccessRestriction.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #accessRestrictions(java.util.Collection)

      • timeZone

        SuggestPlaceResult.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.

      • politicalView

        SuggestPlaceResult.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.

      • phonemes

        SuggestPlaceResult.Builder phonemes​(PhonemeDetails phonemes)

        How the various components of the result's address are pronounced in various languages.

        Parameters:
        phonemes - How the various components of the result's address are pronounced in various languages.
        Returns:
        Returns a reference to this object so that method calls can be chained together.