Package com.azure.maps.search.models

Class SearchAddressOptions

java.lang.Object
com.azure.maps.search.models.BaseSearchOptions<SearchAddressOptions>
com.azure.maps.search.models.SearchAddressOptions
public final class SearchAddressOptions extends BaseSearchOptions<SearchAddressOptions>
Class holding optional parameters for Search.

  • Constructor Details

    • SearchAddressOptions

      public SearchAddressOptions(String query)
      Builds fuzzy search options with only the query string.
      Parameters:
      query - the query string used in the fuzzy search.

  • Method Details

    • getCoordinates

      public Optional<com.azure.core.models.GeoPosition> getCoordinates()
      Returns the coordinates.
      Returns:
      the coordinates.

    • getQuery

      public String getQuery()
      Returns the query string.
      Returns:
      the query string.

    • isTypeAhead

      public Boolean isTypeAhead()
      Returns whether this is a typeahead search.
      Returns:
      whether this is a typeahead search.

    • getExtendedPostalCodesFor

      public List<SearchIndexes> getExtendedPostalCodesFor()
      Returns the extended postal codes.
      Returns:
      the extended postal codes used in the search.

    • getEntityType

      public GeographicEntityType getEntityType()
      Returns the entity type.
      Returns:
      the entity type.

    • setIsTypeAhead

      public SearchAddressOptions setIsTypeAhead(Boolean isTypeAhead)
      Sets whether this is a typeahead search.
      Parameters:
      isTypeAhead - whether this is a typeahead search.
      Returns:
      a reference to this @{code SearchAddressOptions}

    • setExtendedPostalCodesFor

      public SearchAddressOptions setExtendedPostalCodesFor(List<SearchIndexes> extendedPostalCodesFor)
      Sets the extended postal codes.
      Parameters:
      extendedPostalCodesFor - the extended postal codes used in the search.
      Returns:
      a reference to this @{code SearchAddressOptions}

    • setEntityType

      public SearchAddressOptions setEntityType(GeographicEntityType entityType)
      Sets the entity type.
      Parameters:
      entityType - the entity type.
      Returns:
      a reference to this @{code SearchAddressOptions}

    • setCoordinates

      public SearchAddressOptions setCoordinates(com.azure.core.models.GeoPosition coordinates)
      Sets the coordinates.
      Parameters:
      coordinates - the coordinates.
      Returns:
      a reference to this @{code SearchAddressOptions}

    • setQuery

      public SearchAddressOptions setQuery(String query)
      Sets the query string.
      Parameters:
      query - the query string.
      Returns:
      a reference to this @{code SearchAddressOptions}