java.lang.Object
- software.amazon.awssdk.services.geoplaces.model.SearchNearbyFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SearchNearbyFilter.Builder,SearchNearbyFilter>
```
@Generated("software.amazon.awssdk:codegen")
public final class SearchNearbyFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SearchNearbyFilter.Builder,SearchNearbyFilter>
```
SearchNearby structure which contains a set of inclusion/exclusion properties that results must posses in order to be returned as a result.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SearchNearbyFilter.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<Double>`	`boundingBox()`	The bounding box enclosing the geometric shape (area or line) that an individual result covers.
`static SearchNearbyFilter.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`excludeBusinessChains()`	The Business Chains associated with the place.
`List<String>`	`excludeCategories()`	Categories of results that results are excluded from.
`List<String>`	`excludeFoodTypes()`	Food types that results are excluded from.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasBoundingBox()`	For responses, this returns true if the service returned a value for the BoundingBox property.
`boolean`	`hasExcludeBusinessChains()`	For responses, this returns true if the service returned a value for the ExcludeBusinessChains property.
`boolean`	`hasExcludeCategories()`	For responses, this returns true if the service returned a value for the ExcludeCategories property.
`boolean`	`hasExcludeFoodTypes()`	For responses, this returns true if the service returned a value for the ExcludeFoodTypes property.
`int`	`hashCode()`
`boolean`	`hasIncludeBusinessChains()`	For responses, this returns true if the service returned a value for the IncludeBusinessChains property.
`boolean`	`hasIncludeCategories()`	For responses, this returns true if the service returned a value for the IncludeCategories property.
`boolean`	`hasIncludeCountries()`	For responses, this returns true if the service returned a value for the IncludeCountries property.
`boolean`	`hasIncludeFoodTypes()`	For responses, this returns true if the service returned a value for the IncludeFoodTypes property.
`List<String>`	`includeBusinessChains()`	The Business Chains associated with the place.
`List<String>`	`includeCategories()`	Categories of results that results must belong too.
`List<String>`	`includeCountries()`	A list of countries that all results must be in.
`List<String>`	`includeFoodTypes()`	Food types that results are included from.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SearchNearbyFilter.Builder>`	`serializableBuilderClass()`
`SearchNearbyFilter.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasBoundingBox
```
public final boolean hasBoundingBox()
```
    For responses, this returns true if the service returned a value for the BoundingBox property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - boundingBox
```
public final List<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}]
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBoundingBox() method.
    
    Returns:
    
    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}]
  - hasIncludeCountries
```
public final boolean hasIncludeCountries()
```
    For responses, this returns true if the service returned a value for the IncludeCountries property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - includeCountries
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIncludeCountries() method.
    
    Returns:
    
    A list of countries that all results must be in. Countries are represented by either their alpha-2 or alpha-3 character codes.
  - hasIncludeCategories
```
public final boolean hasIncludeCategories()
```
    For responses, this returns true if the service returned a value for the IncludeCategories property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - includeCategories
```
public final List<String> includeCategories()
```
    Categories of results that results must belong too.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIncludeCategories() method.
    
    Returns:
    
    Categories of results that results must belong too.
  - hasExcludeCategories
```
public final boolean hasExcludeCategories()
```
    For responses, this returns true if the service returned a value for the ExcludeCategories property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - excludeCategories
```
public final List<String> excludeCategories()
```
    Categories of results that results are excluded from.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExcludeCategories() method.
    
    Returns:
    
    Categories of results that results are excluded from.
  - hasIncludeBusinessChains
```
public final boolean hasIncludeBusinessChains()
```
    For responses, this returns true if the service returned a value for the IncludeBusinessChains property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - includeBusinessChains
```
public final List<String> includeBusinessChains()
```
    The Business Chains associated with the place.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIncludeBusinessChains() method.
    
    Returns:
    
    The Business Chains associated with the place.
  - hasExcludeBusinessChains
```
public final boolean hasExcludeBusinessChains()
```
    For responses, this returns true if the service returned a value for the ExcludeBusinessChains property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - excludeBusinessChains
```
public final List<String> excludeBusinessChains()
```
    The Business Chains associated with the place.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExcludeBusinessChains() method.
    
    Returns:
    
    The Business Chains associated with the place.
  - hasIncludeFoodTypes
```
public final boolean hasIncludeFoodTypes()
```
    For responses, this returns true if the service returned a value for the IncludeFoodTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - includeFoodTypes
```
public final List<String> includeFoodTypes()
```
    Food types that results are included from.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIncludeFoodTypes() method.
    
    Returns:
    
    Food types that results are included from.
  - hasExcludeFoodTypes
```
public final boolean hasExcludeFoodTypes()
```
    For responses, this returns true if the service returned a value for the ExcludeFoodTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - excludeFoodTypes
```
public final List<String> excludeFoodTypes()
```
    Food types that results are excluded from.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExcludeFoodTypes() method.
    
    Returns:
    
    Food types that results are excluded from.
  - toBuilder
```
public SearchNearbyFilter.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SearchNearbyFilter.Builder,SearchNearbyFilter>
  - builder
```
public static SearchNearbyFilter.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SearchNearbyFilter.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class SearchNearbyFilter

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasBoundingBox

boundingBox

hasIncludeCountries

includeCountries

hasIncludeCategories

includeCategories

hasExcludeCategories

excludeCategories

hasIncludeBusinessChains

includeBusinessChains

hasExcludeBusinessChains

excludeBusinessChains

hasIncludeFoodTypes

includeFoodTypes

hasExcludeFoodTypes

excludeFoodTypes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField