Interface GetPlaceResponse.Builder

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

  • Method Details

    • placeId

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

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

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

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

    • pricingBucket

      GetPlaceResponse.Builder pricingBucket(String pricingBucket)

      The pricing bucket for which the query is charged at.

      For more information on pricing, please visit Amazon Location Service Pricing.

      Parameters:
      pricingBucket - The pricing bucket for which the query is charged at.

      For more information on pricing, please visit Amazon Location Service Pricing.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • address

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

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

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

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

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

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

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

    • mapView

      GetPlaceResponse.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 of four 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 of four 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

      GetPlaceResponse.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 of four 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 of four 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

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

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

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

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

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

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

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

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

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

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

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

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

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

      GetPlaceResponse.Builder accessPoints(Collection<AccessPoint> accessPoints)

      Position of the access point in (lng,lat).

      Parameters:
      accessPoints - Position of the access point in (lng,lat).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessPoints

      GetPlaceResponse.Builder accessPoints(AccessPoint... accessPoints)

      Position of the access point in (lng,lat).

      Parameters:
      accessPoints - Position of the access point in (lng,lat).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessPoints

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

      Position of the access point in (lng,lat).

      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

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

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

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

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

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

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

    • mainAddress

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

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

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

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