software.amazon.awssdk.services.iot.model

Class IndexingFilter

java.lang.Object

software.amazon.awssdk.services.iot.model.IndexingFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IndexingFilter.Builder,IndexingFilter>

@Generated(value="software.amazon.awssdk:codegen")
public final class IndexingFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IndexingFilter.Builder,IndexingFilter>

Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in filter.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IndexingFilter.Builder

Method Summary

Modifier and Type	Method and Description
static IndexingFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNamedShadowNames() For responses, this returns true if the service returned a value for the NamedShadowNames property.
List<String>	namedShadowNames() The shadow names that you select to index.
List<SdkField<?>>	sdkFields()
static Class<? extends IndexingFilter.Builder>	serializableBuilderClass()
IndexingFilter.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

hasNamedShadowNames

public final boolean hasNamedShadowNames()

For responses, this returns true if the service returned a value for the NamedShadowNames 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.

namedShadowNames

public final List<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.

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 hasNamedShadowNames() method.

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.

toBuilder

public IndexingFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IndexingFilter.Builder,IndexingFilter>

builder

public static IndexingFilter.Builder builder()

serializableBuilderClass

public static Class<? extends IndexingFilter.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