IndexingFilter (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iot.model.IndexingFilter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IndexingFilter
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides additional selections for named shadows and geolocation data.

To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in namedShadowNames filter.

To add geolocation data to your fleet indexing configuration:
- If you store geolocation data in a class/unnamed shadow, set thingIndexingMode to be REGISTRY_AND_SHADOW and specify your geolocation data in geoLocations filter.
- If you store geolocation data in a named shadow, set namedShadowIndexingMode to be ON, add the shadow name in namedShadowNames filter, and specify your geolocation data in geoLocations filter. For more information, see Managing fleet indexing.
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

IndexingFilter()

Constructors
Constructor and Description
`IndexingFilter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IndexingFilter`	`clone()`
`boolean`	`equals(Object obj)`
`List<GeoLocationTarget>`	`getGeoLocations()` The list of geolocation targets that you select to index.
`List<String>`	`getNamedShadowNames()` The shadow names that you select to index.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setGeoLocations(Collection<GeoLocationTarget> geoLocations)` The list of geolocation targets that you select to index.
`void`	`setNamedShadowNames(Collection<String> namedShadowNames)` The shadow names that you select to index.
`String`	`toString()` Returns a string representation of this object.
`IndexingFilter`	`withGeoLocations(Collection<GeoLocationTarget> geoLocations)` The list of geolocation targets that you select to index.
`IndexingFilter`	`withGeoLocations(GeoLocationTarget... geoLocations)` The list of geolocation targets that you select to index.
`IndexingFilter`	`withNamedShadowNames(Collection<String> namedShadowNames)` The shadow names that you select to index.
`IndexingFilter`	`withNamedShadowNames(String... namedShadowNames)` The shadow names that you select to index.

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

- Constructor Detail
  - IndexingFilter
```
public IndexingFilter()
```
- Method Detail
  - getNamedShadowNames
```
public List<String> getNamedShadowNames()
```
    The shadow names that you select to index. The default maximum number of shadow names for indexing is 10. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.
    
    Returns:
    
    The shadow names that you select to index. The default maximum number of shadow names for indexing is 10. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.
  - setNamedShadowNames
```
public void setNamedShadowNames(Collection<String> namedShadowNames)
```
    The shadow names that you select to index. The default maximum number of shadow names for indexing is 10. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.
    
    Parameters:
    
    namedShadowNames - The shadow names that you select to index. The default maximum number of shadow names for indexing is 10. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.
  - withNamedShadowNames
```
public IndexingFilter withNamedShadowNames(String... namedShadowNames)
```
    The shadow names that you select to index. The default maximum number of shadow names for indexing is 10. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.
    
    NOTE: This method appends the values to the existing list (if any). Use setNamedShadowNames(java.util.Collection) or withNamedShadowNames(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    namedShadowNames - The shadow names that you select to index. The default maximum number of shadow names for indexing is 10. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withNamedShadowNames
```
public IndexingFilter withNamedShadowNames(Collection<String> namedShadowNames)
```
    The shadow names that you select to index. The default maximum number of shadow names for indexing is 10. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.
    
    Parameters:
    
    namedShadowNames - The shadow names that you select to index. The default maximum number of shadow names for indexing is 10. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getGeoLocations
```
public List<GeoLocationTarget> getGeoLocations()
```
    The list of geolocation targets that you select to index. The default maximum number of geolocation targets for indexing is 1. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.
    
    Returns:
    
    The list of geolocation targets that you select to index. The default maximum number of geolocation targets for indexing is 1. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.
  - setGeoLocations
```
public void setGeoLocations(Collection<GeoLocationTarget> geoLocations)
```
    The list of geolocation targets that you select to index. The default maximum number of geolocation targets for indexing is 1. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.
    
    Parameters:
    
    geoLocations - The list of geolocation targets that you select to index. The default maximum number of geolocation targets for indexing is 1. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.
  - withGeoLocations
```
public IndexingFilter withGeoLocations(GeoLocationTarget... geoLocations)
```
    The list of geolocation targets that you select to index. The default maximum number of geolocation targets for indexing is 1. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.
    
    NOTE: This method appends the values to the existing list (if any). Use setGeoLocations(java.util.Collection) or withGeoLocations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    geoLocations - The list of geolocation targets that you select to index. The default maximum number of geolocation targets for indexing is 1. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withGeoLocations
```
public IndexingFilter withGeoLocations(Collection<GeoLocationTarget> geoLocations)
```
    The list of geolocation targets that you select to index. The default maximum number of geolocation targets for indexing is 1. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.
    
    Parameters:
    
    geoLocations - The list of geolocation targets that you select to index. The default maximum number of geolocation targets for indexing is 1. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public IndexingFilter clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class IndexingFilter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IndexingFilter

Method Detail

getNamedShadowNames

setNamedShadowNames

withNamedShadowNames

withNamedShadowNames

getGeoLocations

setGeoLocations

withGeoLocations

withGeoLocations

toString

equals

hashCode

clone

marshall