Interface SearchNearbyResultItem.Builder

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

  • Method Details

    • placeId

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

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

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

      SearchNearbyResultItem.Builder title(String title)

      The item's title.

      Parameters:
      title - The item's title.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • address

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

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

    • position

      SearchNearbyResultItem.Builder position(Collection<Double> position)

      The position in World Geodetic System (WGS 84) format: [longitude, latitude].

      Parameters:
      position - The position in World Geodetic System (WGS 84) format: [longitude, latitude].
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • position

      SearchNearbyResultItem.Builder position(Double... position)

      The position in World Geodetic System (WGS 84) format: [longitude, latitude].

      Parameters:
      position - The position in World Geodetic System (WGS 84) format: [longitude, latitude].
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • distance

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

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

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

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

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

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

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

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

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

    • businessChains

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

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

    • businessChains

      SearchNearbyResultItem.Builder businessChains(Consumer<BusinessChain.Builder>... businessChains)

      The Business Chains associated with the place.

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

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

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

    • contacts

      SearchNearbyResultItem.Builder contacts(Contacts contacts)

      List of potential contact methods for the result/place.

      Parameters:
      contacts - List of potential contact methods for the result/place.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contacts

      default SearchNearbyResultItem.Builder contacts(Consumer<Contacts.Builder> contacts)

      List of potential contact methods for the result/place.

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

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

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

    • openingHours

      SearchNearbyResultItem.Builder openingHours(Collection<OpeningHours> openingHours)

      List of opening hours objects.

      Parameters:
      openingHours - List of opening hours objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • openingHours

      SearchNearbyResultItem.Builder openingHours(OpeningHours... openingHours)

      List of opening hours objects.

      Parameters:
      openingHours - List of opening hours objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • openingHours

      SearchNearbyResultItem.Builder openingHours(Consumer<OpeningHours.Builder>... openingHours)

      List of opening hours objects.

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

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

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

    • accessPoints

      SearchNearbyResultItem.Builder accessPoints(Collection<AccessPoint> accessPoints)

      Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].

      Parameters:
      accessPoints - Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessPoints

      SearchNearbyResultItem.Builder accessPoints(AccessPoint... accessPoints)

      Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].

      Parameters:
      accessPoints - Position of the access point in World Geodetic System (WGS 84) format: [longitude, latitude].
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessPoints

      SearchNearbyResultItem.Builder accessPoints(Consumer<AccessPoint.Builder>... accessPoints)

      Position of the access point in World Geodetic System (WGS 84) format: [longitude, 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:

    • accessRestrictions

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

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

      SearchNearbyResultItem.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<AccessRestriction>).

      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:

    • timeZone

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

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

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

    • phonemes

      default SearchNearbyResultItem.Builder phonemes(Consumer<PhonemeDetails.Builder> phonemes)

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

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

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

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

    • placeAttributesWithStrings

      SearchNearbyResultItem.Builder placeAttributesWithStrings(Collection<String> placeAttributes)

      A list of place attributes for the result, such as whether the business offers drive-through service.

      Parameters:
      placeAttributes - A list of place attributes for the result, such as whether the business offers drive-through service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • placeAttributesWithStrings

      SearchNearbyResultItem.Builder placeAttributesWithStrings(String... placeAttributes)

      A list of place attributes for the result, such as whether the business offers drive-through service.

      Parameters:
      placeAttributes - A list of place attributes for the result, such as whether the business offers drive-through service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • placeAttributes

      SearchNearbyResultItem.Builder placeAttributes(Collection<PlaceAttribute> placeAttributes)

      A list of place attributes for the result, such as whether the business offers drive-through service.

      Parameters:
      placeAttributes - A list of place attributes for the result, such as whether the business offers drive-through service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • placeAttributes

      SearchNearbyResultItem.Builder placeAttributes(PlaceAttribute... placeAttributes)

      A list of place attributes for the result, such as whether the business offers drive-through service.

      Parameters:
      placeAttributes - A list of place attributes for the result, such as whether the business offers drive-through service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • crossReferences

      SearchNearbyResultItem.Builder crossReferences(Collection<CrossReference> crossReferences)

      The list of supplier references available for this place. Requires the CrossReferences additional feature to be enabled.

      Parameters:
      crossReferences - The list of supplier references available for this place. Requires the CrossReferences additional feature to be enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • crossReferences

      SearchNearbyResultItem.Builder crossReferences(CrossReference... crossReferences)

      The list of supplier references available for this place. Requires the CrossReferences additional feature to be enabled.

      Parameters:
      crossReferences - The list of supplier references available for this place. Requires the CrossReferences additional feature to be enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • crossReferences

      SearchNearbyResultItem.Builder crossReferences(Consumer<CrossReference.Builder>... crossReferences)

      The list of supplier references available for this place. Requires the CrossReferences additional feature to be enabled.

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

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

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