Interface AutocompleteAddressHighlights.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<AutocompleteAddressHighlights.Builder,,AutocompleteAddressHighlights> SdkBuilder<AutocompleteAddressHighlights.Builder,,AutocompleteAddressHighlights> SdkPojo
- Enclosing class:
AutocompleteAddressHighlights
-
Method Summary
Modifier and TypeMethodDescriptionaddressNumber(Collection<Highlight> addressNumber) The house number or address results should have.addressNumber(Consumer<Highlight.Builder>... addressNumber) The house number or address results should have.addressNumber(Highlight... addressNumber) The house number or address results should have.block(Collection<Highlight> block) Name of the block.block(Consumer<Highlight.Builder>... block) Name of the block.Name of the block.building(Collection<Highlight> building) The name of the building at the address.building(Consumer<Highlight.Builder>... building) The name of the building at the address.The name of the building at the address.country(Consumer<CountryHighlights.Builder> country) The alpha-2 or alpha-3 character code for the country that the results will be present in.country(CountryHighlights country) The alpha-2 or alpha-3 character code for the country that the results will be present in.district(Collection<Highlight> district) The district or division of a city the results should be present in.district(Consumer<Highlight.Builder>... district) The district or division of a city the results should be present in.The district or division of a city the results should be present in.intersection(Collection<? extends Collection<Highlight>> intersection) Name of the streets in the intersection.intersection(Collection<Highlight>... intersection) Name of the streets in the intersection.label(Collection<Highlight> label) Indicates the starting and ending indexes for result items where they are identified to match the input query.label(Consumer<Highlight.Builder>... label) Indicates the starting and ending indexes for result items where they are identified to match the input query.Indicates the starting and ending indexes for result items where they are identified to match the input query.locality(Collection<Highlight> locality) The city or locality results should be present in.locality(Consumer<Highlight.Builder>... locality) The city or locality results should be present in.The city or locality results should be present in.postalCode(Collection<Highlight> 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.postalCode(Consumer<Highlight.Builder>... 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.postalCode(Highlight... 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.region(Consumer<RegionHighlights.Builder> region) The region or state results should be to be present in.region(RegionHighlights region) The region or state results should be to be present in.street(Collection<Highlight> street) The name of the street results should be present in.street(Consumer<Highlight.Builder>... street) The name of the street results should be present in.The name of the street results should be present in.subBlock(Collection<Highlight> subBlock) Name of sub-block.subBlock(Consumer<Highlight.Builder>... subBlock) Name of sub-block.Name of sub-block.subDistrict(Collection<Highlight> subDistrict) Indicates the starting and ending index of the title in the text query that match the found title.subDistrict(Consumer<Highlight.Builder>... subDistrict) Indicates the starting and ending index of the title in the text query that match the found title.subDistrict(Highlight... subDistrict) Indicates the starting and ending index of the title in the text query that match the found title.subRegion(Consumer<SubRegionHighlights.Builder> subRegion) The sub-region or county for which results should be present in.subRegion(SubRegionHighlights subRegion) The sub-region or county for which results should be present in.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
label
Indicates the starting and ending indexes for result items where they are identified to match the input query. This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.
- Parameters:
label- Indicates the starting and ending indexes for result items where they are identified to match the input query. This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
label
Indicates the starting and ending indexes for result items where they are identified to match the input query. This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.
- Parameters:
label- Indicates the starting and ending indexes for result items where they are identified to match the input query. This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
label
Indicates the starting and ending indexes for result items where they are identified to match the input query. This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.
This is a convenience method that creates an instance of theHighlight.Builderavoiding the need to create one manually viaHighlight.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tolabel(List<Highlight>).- Parameters:
label- a consumer that will call methods onHighlight.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
country
The alpha-2 or alpha-3 character code for the country that the results will be present in.
This is a convenience method that creates an instance of theCountryHighlights.Builderavoiding the need to create one manually viaCountryHighlights.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocountry(CountryHighlights).- Parameters:
country- a consumer that will call methods onCountryHighlights.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
region
The region or state results should be to be present in.
Example:
This is a convenience method that creates an instance of theNorth Rhine-Westphalia.RegionHighlights.Builderavoiding the need to create one manually viaRegionHighlights.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toregion(RegionHighlights).- Parameters:
region- a consumer that will call methods onRegionHighlights.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
subRegion
default AutocompleteAddressHighlights.Builder subRegion(Consumer<SubRegionHighlights.Builder> subRegion) The sub-region or county for which results should be present in.
This is a convenience method that creates an instance of theSubRegionHighlights.Builderavoiding the need to create one manually viaSubRegionHighlights.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosubRegion(SubRegionHighlights).- Parameters:
subRegion- a consumer that will call methods onSubRegionHighlights.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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.
-
locality
The city or locality results should be present in.
Example:
This is a convenience method that creates an instance of theVancouver.Highlight.Builderavoiding the need to create one manually viaHighlight.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tolocality(List<Highlight>).- Parameters:
locality- a consumer that will call methods onHighlight.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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.
-
district
The district or division of a city the results should be present in.
This is a convenience method that creates an instance of theHighlight.Builderavoiding the need to create one manually viaHighlight.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todistrict(List<Highlight>).- Parameters:
district- a consumer that will call methods onHighlight.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
subDistrict
Indicates the starting and ending index of the title in the text query that match the found title.
- Parameters:
subDistrict- Indicates the starting and ending index of the title in the text query that match the found title.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subDistrict
Indicates the starting and ending index of the title in the text query that match the found title.
- Parameters:
subDistrict- Indicates the starting and ending index of the title in the text query that match the found title.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subDistrict
Indicates the starting and ending index of the title in the text query that match the found title.
This is a convenience method that creates an instance of theHighlight.Builderavoiding the need to create one manually viaHighlight.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosubDistrict(List<Highlight>).- Parameters:
subDistrict- a consumer that will call methods onHighlight.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
street
The name of the street results should be present in.
- Parameters:
street- The name of the street results should be present in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
street
The name of the street results should be present in.
- Parameters:
street- The name of the street results should be present in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
street
The name of the street results should be present in.
This is a convenience method that creates an instance of theHighlight.Builderavoiding the need to create one manually viaHighlight.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tostreet(List<Highlight>).- Parameters:
street- a consumer that will call methods onHighlight.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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.
-
block
Name of the block.
Example:
This is a convenience method that creates an instance of theSunny Mansion 203 block: 2 ChomeHighlight.Builderavoiding the need to create one manually viaHighlight.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toblock(List<Highlight>).- Parameters:
block- a consumer that will call methods onHighlight.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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.
-
subBlock
Name of sub-block.
Example:
This is a convenience method that creates an instance of theSunny Mansion 203 sub-block: 4Highlight.Builderavoiding the need to create one manually viaHighlight.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosubBlock(List<Highlight>).- Parameters:
subBlock- a consumer that will call methods onHighlight.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
intersection
AutocompleteAddressHighlights.Builder intersection(Collection<? extends Collection<Highlight>> intersection) Name of the streets in the intersection. For example: e.g. ["Friedrichstraße","Unter den Linden"]
- Parameters:
intersection- Name of the streets in the intersection. For example: e.g. ["Friedrichstraße","Unter den Linden"]- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
intersection
Name of the streets in the intersection. For example: e.g. ["Friedrichstraße","Unter den Linden"]
- Parameters:
intersection- Name of the streets in the intersection. For example: e.g. ["Friedrichstraße","Unter den Linden"]- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
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.
This is a convenience method that creates an instance of theHighlight.Builderavoiding the need to create one manually viaHighlight.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed topostalCode(List<Highlight>).- Parameters:
postalCode- a consumer that will call methods onHighlight.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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.
-
addressNumber
The house number or address results should have.
This is a convenience method that creates an instance of theHighlight.Builderavoiding the need to create one manually viaHighlight.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toaddressNumber(List<Highlight>).- Parameters:
addressNumber- a consumer that will call methods onHighlight.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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.
-
building
The name of the building at the address.
This is a convenience method that creates an instance of theHighlight.Builderavoiding the need to create one manually viaHighlight.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tobuilding(List<Highlight>).- Parameters:
building- a consumer that will call methods onHighlight.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-