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(value="software.amazon.awssdk:codegen")
public final class DescribeIndexResponse
extends IotResponse
implements ToCopyableBuilder<DescribeIndexResponse.Builder,DescribeIndexResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeIndexResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeIndexResponse.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

indexName

public String indexName()

The index name.

Returns:

The index name.

indexStatus

public 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 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 String schema()

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

• REGISTRY – Your thing index will contain only registry data.

• REGISTRY_AND_SHADOW - Your thing index will contain registry data and shadow data.

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

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

Returns:

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

• REGISTRY – Your thing index will contain only registry data.

• REGISTRY_AND_SHADOW - Your thing index will contain registry data and shadow data.

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

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

toBuilder

public DescribeIndexResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeIndexResponse.Builder,DescribeIndexResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeIndexResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.