Interface SuggestFilter.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<SuggestFilter.Builder,SuggestFilter>,SdkBuilder<SuggestFilter.Builder,SuggestFilter>,SdkPojo
- Enclosing class:
- SuggestFilter
public static interface SuggestFilter.Builder extends SdkPojo, CopyableBuilder<SuggestFilter.Builder,SuggestFilter>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description SuggestFilter.BuilderboundingBox(Double... boundingBox)The bounding box enclosing the geometric shape (area or line) that an individual result covers.SuggestFilter.BuilderboundingBox(Collection<Double> boundingBox)The bounding box enclosing the geometric shape (area or line) that an individual result covers.default SuggestFilter.Buildercircle(Consumer<FilterCircle.Builder> circle)Sets the value of the Circle property for this object.SuggestFilter.Buildercircle(FilterCircle circle)Sets the value of the Circle property for this object.SuggestFilter.BuilderincludeCountries(String... includeCountries)A list of countries that all results must be in.SuggestFilter.BuilderincludeCountries(Collection<String> includeCountries)A list of countries that all results must be in.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
boundingBox
SuggestFilter.Builder boundingBox(Collection<Double> boundingBox)
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:
boundingBox- 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.
-
boundingBox
SuggestFilter.Builder boundingBox(Double... boundingBox)
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:
boundingBox- 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.
-
circle
SuggestFilter.Builder circle(FilterCircle circle)
Sets the value of the Circle property for this object.- Parameters:
circle- The new value for the Circle property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
circle
default SuggestFilter.Builder circle(Consumer<FilterCircle.Builder> circle)
Sets the value of the Circle property for this object. This is a convenience method that creates an instance of theFilterCircle.Builderavoiding the need to create one manually viaFilterCircle.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocircle(FilterCircle).- Parameters:
circle- a consumer that will call methods onFilterCircle.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
circle(FilterCircle)
-
includeCountries
SuggestFilter.Builder includeCountries(Collection<String> includeCountries)
A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
- Parameters:
includeCountries- A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
includeCountries
SuggestFilter.Builder includeCountries(String... includeCountries)
A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
- Parameters:
includeCountries- A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-