Package software.amazon.awssdk.services.iot.model

Class SearchIndexResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iot.model.IotResponse

software.amazon.awssdk.services.iot.model.SearchIndexResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchIndexResponse.Builder,SearchIndexResponse>

@Generated("software.amazon.awssdk:codegen")
public final class SearchIndexResponse
extends IotResponse
implements ToCopyableBuilder<SearchIndexResponse.Builder,SearchIndexResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchIndexResponse.Builder

Method Summary

Modifier and Type	Method	Description
static SearchIndexResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasThingGroups()	For responses, this returns true if the service returned a value for the ThingGroups property.
boolean	hasThings()	For responses, this returns true if the service returned a value for the Things property.
String	nextToken()	The token used to get the next set of results, or null if there are no additional results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SearchIndexResponse.Builder>	serializableBuilderClass()
List<ThingGroupDocument>	thingGroups()	The thing groups that match the search query.
List<ThingDocument>	things()	The things that match the search query.
SearchIndexResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.iot.model.IotResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

nextToken

public final String nextToken()

The token used to get the next set of results, or null if there are no additional results.

Returns:

The token used to get the next set of results, or null if there are no additional results.

hasThings

public final boolean hasThings()

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

things

public final List<ThingDocument> things()

The things that match the search query.

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

Returns:

The things that match the search query.

hasThingGroups

public final boolean hasThingGroups()

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

thingGroups

public final List<ThingGroupDocument> thingGroups()

The thing groups that match the search query.

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

Returns:

The thing groups that match the search query.

toBuilder

public SearchIndexResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchIndexResponse.Builder,SearchIndexResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static SearchIndexResponse.Builder builder()

serializableBuilderClass

public static Class<? extends SearchIndexResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

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