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

Class DescribeIndexResponse

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.DescribeIndexResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeIndexResponse.Builder,DescribeIndexResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeIndexResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeIndexResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	indexName()	The index name.
IndexStatus	indexStatus()	The index status.
String	indexStatusAsString()	The index status.
String	schema()	Contains a value that specifies the type of indexing performed.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeIndexResponse.Builder>	serializableBuilderClass()
DescribeIndexResponse.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

indexName

public final String indexName()

The index name.

Returns:

The index name.

indexStatus

public final IndexStatus indexStatus()

The index status.

If the service returns an enum value that is not available in the current SDK version, indexStatus will return IndexStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexStatusAsString().

Returns:

The index status.

See Also:

IndexStatus

indexStatusAsString

public final String indexStatusAsString()

The index status.

If the service returns an enum value that is not available in the current SDK version, indexStatus will return IndexStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexStatusAsString().

Returns:

The index status.

See Also:

IndexStatus

schema

public final String schema()

Contains a value that specifies the type of indexing performed. Valid values are:

• REGISTRY – Your thing index contains only registry data.

• REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.

• REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.

• REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.

• MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.

Returns:

Contains a value that specifies the type of indexing performed. Valid values are:

• REGISTRY – Your thing index contains only registry data.

• REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.

• REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.

• REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.

• MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.

toBuilder

public DescribeIndexResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeIndexResponse.Builder,DescribeIndexResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeIndexResponse.Builder builder()

serializableBuilderClass

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