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

Interface SearchNearbyFilter.Builder

    • Method Detail

      • boundingBox

        SearchNearbyFilter.Builder boundingBox​(Collection<Double> boundingBox)

        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:
        boundingBox - 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.

      • boundingBox

        SearchNearbyFilter.Builder boundingBox​(Double... boundingBox)

        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:
        boundingBox - 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.

      • includeCountries

        SearchNearbyFilter.Builder includeCountries​(Collection<String> includeCountries)

        A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.

        Parameters:
        includeCountries - A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • includeCountries

        SearchNearbyFilter.Builder includeCountries​(String... includeCountries)

        A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.

        Parameters:
        includeCountries - A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • includeCategories

        SearchNearbyFilter.Builder includeCategories​(Collection<String> includeCategories)

        Categories of results that results must belong too.

        Parameters:
        includeCategories - Categories of results that results must belong too.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • includeCategories

        SearchNearbyFilter.Builder includeCategories​(String... includeCategories)

        Categories of results that results must belong too.

        Parameters:
        includeCategories - Categories of results that results must belong too.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • excludeCategories

        SearchNearbyFilter.Builder excludeCategories​(Collection<String> excludeCategories)

        Categories of results that results are excluded from.

        Parameters:
        excludeCategories - Categories of results that results are excluded from.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • excludeCategories

        SearchNearbyFilter.Builder excludeCategories​(String... excludeCategories)

        Categories of results that results are excluded from.

        Parameters:
        excludeCategories - Categories of results that results are excluded from.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • includeBusinessChains

        SearchNearbyFilter.Builder includeBusinessChains​(Collection<String> includeBusinessChains)

        The Business Chains associated with the place.

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

      • includeBusinessChains

        SearchNearbyFilter.Builder includeBusinessChains​(String... includeBusinessChains)

        The Business Chains associated with the place.

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

      • excludeBusinessChains

        SearchNearbyFilter.Builder excludeBusinessChains​(Collection<String> excludeBusinessChains)

        The Business Chains associated with the place.

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

      • excludeBusinessChains

        SearchNearbyFilter.Builder excludeBusinessChains​(String... excludeBusinessChains)

        The Business Chains associated with the place.

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

      • includeFoodTypes

        SearchNearbyFilter.Builder includeFoodTypes​(Collection<String> includeFoodTypes)

        Food types that results are included from.

        Parameters:
        includeFoodTypes - Food types that results are included from.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • includeFoodTypes

        SearchNearbyFilter.Builder includeFoodTypes​(String... includeFoodTypes)

        Food types that results are included from.

        Parameters:
        includeFoodTypes - Food types that results are included from.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • excludeFoodTypes

        SearchNearbyFilter.Builder excludeFoodTypes​(Collection<String> excludeFoodTypes)

        Food types that results are excluded from.

        Parameters:
        excludeFoodTypes - Food types that results are excluded from.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • excludeFoodTypes

        SearchNearbyFilter.Builder excludeFoodTypes​(String... excludeFoodTypes)

        Food types that results are excluded from.

        Parameters:
        excludeFoodTypes - Food types that results are excluded from.
        Returns:
        Returns a reference to this object so that method calls can be chained together.