Interface GeocodeResultItem.Builder

All Superinterfaces:
Buildable, CopyableBuilder<GeocodeResultItem.Builder,GeocodeResultItem>, SdkBuilder<GeocodeResultItem.Builder,GeocodeResultItem>, SdkPojo
Enclosing class:
GeocodeResultItem
@Mutable @NotThreadSafe public static interface GeocodeResultItem.Builder extends SdkPojo, CopyableBuilder<GeocodeResultItem.Builder,GeocodeResultItem>

  • Method Details

    • placeId

      GeocodeResultItem.Builder placeId(String placeId)

      The PlaceId of the place result.

      Parameters:
      placeId - The PlaceId of the place result.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • placeType

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

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

    • 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 parameter language.
      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 the Address.Builder avoiding the need to create one manually via Address.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to address(Address).

      Parameters:
      address - a consumer that will call methods on Address.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 the PostalCodeDetails.Builder avoiding the need to create one manually via PostalCodeDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to postalCodeDetails(List<PostalCodeDetails>).

      Parameters:
      postalCodeDetails - a consumer that will call methods on PostalCodeDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 the Category.Builder avoiding the need to create one manually via Category.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to categories(List<Category>).

      Parameters:
      categories - a consumer that will call methods on Category.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 the FoodType.Builder avoiding the need to create one manually via FoodType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to foodTypes(List<FoodType>).

      Parameters:
      foodTypes - a consumer that will call methods on FoodType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • accessPoints

      GeocodeResultItem.Builder accessPoints(Collection<AccessPoint> accessPoints)

      Position of the access point represented by longitude and latitude.

      Parameters:
      accessPoints - Position of the access point represented 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 represented by longitude and latitude.

      Parameters:
      accessPoints - Position of the access point represented 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 represented by longitude and latitude.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to accessPoints(List<AccessPoint>).

      Parameters:
      accessPoints - a consumer that will call methods on AccessPoint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 the TimeZone.Builder avoiding the need to create one manually via TimeZone.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timeZone(TimeZone).

      Parameters:
      timeZone - a consumer that will call methods on TimeZone.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 the MatchScoreDetails.Builder avoiding the need to create one manually via MatchScoreDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to matchScores(MatchScoreDetails).

      Parameters:
      matchScores - a consumer that will call methods on MatchScoreDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • parsedQuery

      GeocodeResultItem.Builder parsedQuery(GeocodeParsedQuery parsedQuery)

      Free-form text query.

      Parameters:
      parsedQuery - Free-form text query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parsedQuery

      default GeocodeResultItem.Builder parsedQuery(Consumer<GeocodeParsedQuery.Builder> parsedQuery)

      Free-form text query.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parsedQuery(GeocodeParsedQuery).

      Parameters:
      parsedQuery - a consumer that will call methods on GeocodeParsedQuery.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • intersections

      GeocodeResultItem.Builder intersections(Collection<Intersection> intersections)

      All Intersections that are near the provided address.

      Parameters:
      intersections - All Intersections that are near the provided address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • intersections

      GeocodeResultItem.Builder intersections(Intersection... intersections)

      All Intersections that are near the provided address.

      Parameters:
      intersections - All Intersections that are near the provided address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • intersections

      GeocodeResultItem.Builder intersections(Consumer<Intersection.Builder>... intersections)

      All Intersections that are near the provided address.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to intersections(List<Intersection>).

      Parameters:
      intersections - a consumer that will call methods on Intersection.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mainAddress

      GeocodeResultItem.Builder mainAddress(RelatedPlace mainAddress)

      The main address corresponding to a place of type Secondary Address.

      Parameters:
      mainAddress - The main address corresponding to a place of type Secondary Address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mainAddress

      default GeocodeResultItem.Builder mainAddress(Consumer<RelatedPlace.Builder> mainAddress)

      The main address corresponding to a place of type Secondary Address.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to mainAddress(RelatedPlace).

      Parameters:
      mainAddress - a consumer that will call methods on RelatedPlace.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • secondaryAddresses

      GeocodeResultItem.Builder secondaryAddresses(Collection<RelatedPlace> secondaryAddresses)

      All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information.

      Parameters:
      secondaryAddresses - All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryAddresses

      GeocodeResultItem.Builder secondaryAddresses(RelatedPlace... secondaryAddresses)

      All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information.

      Parameters:
      secondaryAddresses - All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryAddresses

      GeocodeResultItem.Builder secondaryAddresses(Consumer<RelatedPlace.Builder>... secondaryAddresses)

      All secondary addresses that are associated with a main address. A secondary address is one that includes secondary designators, such as a Suite or Unit Number, Building, or Floor information.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to secondaryAddresses(List<RelatedPlace>).

      Parameters:
      secondaryAddresses - a consumer that will call methods on RelatedPlace.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: