Package com.azure.maps.search.models

Class SearchSummary

java.lang.Object
com.azure.maps.search.models.SearchSummary
public final class SearchSummary extends Object
Summary object for a Search API response.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SearchSummary()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Integer
    getFuzzyLevel()
    Get the fuzzyLevel property: The maximum fuzzy level required to provide Results.
    com.azure.core.models.GeoPosition
    getGeoBias()
    Get the geoBias property: Indication when the internal search engine has applied a geospatial bias to improve the ranking of results.
    Integer
    getNumResults()
    Get the numResults property: Number of results in the response.
    String
    getQuery()
    Get the query property: The query parameter that was used to produce these search results.
    Integer
    getQueryTime()
    Get the queryTime property: Time spent resolving the query, in milliseconds.
    QueryType
    getQueryType()
    Get the queryType property: The type of query being returned: NEARBY or NON_NEAR.
    Integer
    getSkip()
    Get the skip property: The starting offset of the returned Results within the full Result set.
    Integer
    getTop()
    Get the top property: Maximum number of responses that will be returned.
    Integer
    getTotalResults()
    Get the totalResults property: The total number of Results found.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • SearchSummary

      public SearchSummary()

  • Method Details

    • getQuery

      public String getQuery()
      Get the query property: The query parameter that was used to produce these search results.
      Returns:
      the query value.

    • getQueryType

      public QueryType getQueryType()
      Get the queryType property: The type of query being returned: NEARBY or NON_NEAR.
      Returns:
      the queryType value.

    • getQueryTime

      public Integer getQueryTime()
      Get the queryTime property: Time spent resolving the query, in milliseconds.
      Returns:
      the queryTime value.

    • getNumResults

      public Integer getNumResults()
      Get the numResults property: Number of results in the response.
      Returns:
      the numResults value.

    • getTop

      public Integer getTop()
      Get the top property: Maximum number of responses that will be returned.
      Returns:
      the top value.

    • getSkip

      public Integer getSkip()
      Get the skip property: The starting offset of the returned Results within the full Result set.
      Returns:
      the skip value.

    • getTotalResults

      public Integer getTotalResults()
      Get the totalResults property: The total number of Results found.
      Returns:
      the totalResults value.

    • getFuzzyLevel

      public Integer getFuzzyLevel()
      Get the fuzzyLevel property: The maximum fuzzy level required to provide Results.
      Returns:
      the fuzzyLevel value.

    • getGeoBias

      public com.azure.core.models.GeoPosition getGeoBias()
      Get the geoBias property: Indication when the internal search engine has applied a geospatial bias to improve the ranking of results. In some methods, this can be affected by setting the lat and lon parameters where available. In other cases it is purely internal.
      Returns:
      the geoBias value.