Interface AddressComponentMatchScores.Builder

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

  • Method Details

    • country

      AddressComponentMatchScores.Builder country(Double country)

      The alpha-2 or alpha-3 character code for the country that the results will be present in.

      Parameters:
      country - The alpha-2 or alpha-3 character code for the country that the results will be present in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • region

      AddressComponentMatchScores.Builder region(Double region)

      The region or state results should be to be present in.

      Example: North Rhine-Westphalia.

      Parameters:
      region - The region or state results should be to be present in.

      Example: North Rhine-Westphalia.

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

    • subRegion

      AddressComponentMatchScores.Builder subRegion(Double subRegion)

      The sub-region or county for which results should be present in.

      Parameters:
      subRegion - The sub-region or county for which results should be present in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locality

      AddressComponentMatchScores.Builder locality(Double locality)

      The city or locality results should be present in.

      Example: Vancouver.

      Parameters:
      locality - The city or locality results should be present in.

      Example: Vancouver.

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

    • district

      AddressComponentMatchScores.Builder district(Double district)

      The district or division of a city the results should be present in.

      Parameters:
      district - The district or division of a city the results should be present in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subDistrict

      AddressComponentMatchScores.Builder subDistrict(Double subDistrict)

      A subdivision of a district.

      Example: Minden-Lübbecke

      Parameters:
      subDistrict - A subdivision of a district.

      Example: Minden-Lübbecke

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

    • postalCode

      AddressComponentMatchScores.Builder postalCode(Double postalCode)

      An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should possess.

      Parameters:
      postalCode - An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should possess.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • block

      AddressComponentMatchScores.Builder block(Double block)

      Name of the block.

      Example: Sunny Mansion 203 block: 2 Chome

      Parameters:
      block - Name of the block.

      Example: Sunny Mansion 203 block: 2 Chome

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

    • subBlock

      AddressComponentMatchScores.Builder subBlock(Double subBlock)

      Name of sub-block.

      Example: Sunny Mansion 203 sub-block: 4

      Parameters:
      subBlock - Name of sub-block.

      Example: Sunny Mansion 203 sub-block: 4

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

    • intersection

      AddressComponentMatchScores.Builder intersection(Collection<Double> intersection)

      Name of the streets in the intersection.

      Example: ["Friedrichstraße","Unter den Linden"]

      Parameters:
      intersection - Name of the streets in the intersection.

      Example: ["Friedrichstraße","Unter den Linden"]

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

    • intersection

      AddressComponentMatchScores.Builder intersection(Double... intersection)

      Name of the streets in the intersection.

      Example: ["Friedrichstraße","Unter den Linden"]

      Parameters:
      intersection - Name of the streets in the intersection.

      Example: ["Friedrichstraße","Unter den Linden"]

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

    • addressNumber

      AddressComponentMatchScores.Builder addressNumber(Double addressNumber)

      The house number or address results should have.

      Parameters:
      addressNumber - The house number or address results should have.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • building

      AddressComponentMatchScores.Builder building(Double building)

      The name of the building at the address.

      Parameters:
      building - The name of the building at the address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryAddressComponents

      AddressComponentMatchScores.Builder secondaryAddressComponents(Collection<SecondaryAddressComponentMatchScore> secondaryAddressComponents)

      Match scores for the secondary address components in the result.

      Parameters:
      secondaryAddressComponents - Match scores for the secondary address components in the result.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryAddressComponents

      AddressComponentMatchScores.Builder secondaryAddressComponents(SecondaryAddressComponentMatchScore... secondaryAddressComponents)

      Match scores for the secondary address components in the result.

      Parameters:
      secondaryAddressComponents - Match scores for the secondary address components in the result.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryAddressComponents

      AddressComponentMatchScores.Builder secondaryAddressComponents(Consumer<SecondaryAddressComponentMatchScore.Builder>... secondaryAddressComponents)

      Match scores for the secondary address components in the result.

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

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

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