Package software.amazon.awssdk.services.iotthingsgraph.model

Class SearchEntitiesResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iotthingsgraph.model.IoTThingsGraphResponse

software.amazon.awssdk.services.iotthingsgraph.model.SearchEntitiesResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchEntitiesResponse.Builder,SearchEntitiesResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchEntitiesResponse.Builder

Method Summary

Modifier and Type	Method	Description
static SearchEntitiesResponse.Builder	builder()
List<EntityDescription>	descriptions()	An array of descriptions for each entity returned in the search result.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDescriptions()	For responses, this returns true if the service returned a value for the Descriptions property.
int	hashCode()
String	nextToken()	The string to specify as nextToken when you request the next page of results.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchEntitiesResponse.Builder>	serializableBuilderClass()
SearchEntitiesResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.iotthingsgraph.model.IoTThingsGraphResponse

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

hasDescriptions

public final boolean hasDescriptions()

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

descriptions

public final List<EntityDescription> descriptions()

An array of descriptions for each entity returned in the search result.

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

Returns:

An array of descriptions for each entity returned in the search result.

nextToken

public final String nextToken()

The string to specify as nextToken when you request the next page of results.

Returns:

The string to specify as nextToken when you request the next page of results.

toBuilder

public SearchEntitiesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchEntitiesResponse.Builder,SearchEntitiesResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static SearchEntitiesResponse.Builder builder()

serializableBuilderClass

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