DescribeIndexResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.iot.model.DescribeIndexResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeIndexResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeIndexResult()

Constructors
Constructor and Description
`DescribeIndexResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeIndexResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getIndexName()` The index name.
`String`	`getIndexStatus()` The index status.
`String`	`getSchema()` Contains a value that specifies the type of indexing performed.
`int`	`hashCode()`
`void`	`setIndexName(String indexName)` The index name.
`void`	`setIndexStatus(String indexStatus)` The index status.
`void`	`setSchema(String schema)` Contains a value that specifies the type of indexing performed.
`String`	`toString()` Returns a string representation of this object.
`DescribeIndexResult`	`withIndexName(String indexName)` The index name.
`DescribeIndexResult`	`withIndexStatus(IndexStatus indexStatus)` The index status.
`DescribeIndexResult`	`withIndexStatus(String indexStatus)` The index status.
`DescribeIndexResult`	`withSchema(String schema)` Contains a value that specifies the type of indexing performed.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeIndexResult
```
public DescribeIndexResult()
```
- Method Detail
  - setIndexName
```
public void setIndexName(String indexName)
```
    The index name.
    
    Parameters:
    
    indexName - The index name.
  - getIndexName
```
public String getIndexName()
```
    The index name.
    
    Returns:
    
    The index name.
  - withIndexName
```
public DescribeIndexResult withIndexName(String indexName)
```
    The index name.
    
    Parameters:
    
    indexName - The index name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexStatus
```
public void setIndexStatus(String indexStatus)
```
    The index status.
    
    Parameters:
    
    indexStatus - The index status.
    
    See Also:
    
    IndexStatus
  - getIndexStatus
```
public String getIndexStatus()
```
    The index status.
    
    Returns:
    
    The index status.
    
    See Also:
    
    IndexStatus
  - withIndexStatus
```
public DescribeIndexResult withIndexStatus(String indexStatus)
```
    The index status.
    
    Parameters:
    
    indexStatus - The index status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexStatus
  - withIndexStatus
```
public DescribeIndexResult withIndexStatus(IndexStatus indexStatus)
```
    The index status.
    
    Parameters:
    
    indexStatus - The index status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexStatus
  - setSchema
```
public void setSchema(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.
    Parameters:
    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.
  - getSchema
```
public String getSchema()
```
    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.
  - withSchema
```
public DescribeIndexResult withSchema(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeIndexResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.792

Class DescribeIndexResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeIndexResult

Method Detail

setIndexName

getIndexName

withIndexName

setIndexStatus

getIndexStatus

withIndexStatus

withIndexStatus

setSchema

getSchema

withSchema

toString

equals

hashCode

clone