com.amazonaws.services.iot.model

Class DescribeIndexResult

java.lang.Object

com.amazonaws.services.iot.model.DescribeIndexResult

All Implemented Interfaces:

Serializable

public class DescribeIndexResult
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeIndexResult()

Method Summary

Modifier and Type	Method and Description
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(IndexStatus indexStatus) The index status.
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; useful for testing and debugging.
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 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeIndexResult

public DescribeIndexResult()

Method Detail

getIndexName

public String getIndexName()

The index name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Returns:

The index name.

setIndexName

public void setIndexName(String indexName)

The index name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Parameters:

indexName -

The index name.

withIndexName

public DescribeIndexResult withIndexName(String indexName)

The index name.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Parameters:

indexName -

The index name.

Returns:

A reference to this updated object so that method calls can be chained together.

getIndexStatus

public String getIndexStatus()

The index status.

Constraints:
Allowed Values: ACTIVE, BUILDING, REBUILDING

Returns:

The index status.

See Also:

IndexStatus

setIndexStatus

public void setIndexStatus(String indexStatus)

The index status.

Constraints:
Allowed Values: ACTIVE, BUILDING, REBUILDING

Parameters:

indexStatus -

The index status.

See Also:

IndexStatus

withIndexStatus

public DescribeIndexResult withIndexStatus(String indexStatus)

The index status.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ACTIVE, BUILDING, REBUILDING

Parameters:

indexStatus -

The index status.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

IndexStatus

setIndexStatus

public void setIndexStatus(IndexStatus indexStatus)

The index status.

Constraints:
Allowed Values: ACTIVE, BUILDING, REBUILDING

Parameters:

indexStatus -

The index status.

See Also:

IndexStatus

withIndexStatus

public DescribeIndexResult withIndexStatus(IndexStatus indexStatus)

The index status.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ACTIVE, BUILDING, REBUILDING

Parameters:

indexStatus -

The index status.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

IndexStatus

getSchema

public String getSchema()

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

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

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

Returns:

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

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

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

setSchema

public void setSchema(String schema)

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

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

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

Parameters:

schema -

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

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

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

withSchema

public DescribeIndexResult withSchema(String schema)

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

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

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

schema -

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

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

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object