IndexConfigurationSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kendra.model.IndexConfigurationSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IndexConfigurationSummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A summary of information on the configuration of an index.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

IndexConfigurationSummary()

Constructors
Constructor and Description
`IndexConfigurationSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IndexConfigurationSummary`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreatedAt()` The Unix timestamp when the index was created.
`String`	`getEdition()` Indicates whether the index is a enterprise edition index or a developer edition index.
`String`	`getId()` A unique identifier for the index.
`String`	`getName()` The identifier of the index.
`String`	`getStatus()` The current status of the index.
`Date`	`getUpdatedAt()` The Unix timestamp when the index was last updated by the `UpdateIndex` API.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreatedAt(Date createdAt)` The Unix timestamp when the index was created.
`void`	`setEdition(String edition)` Indicates whether the index is a enterprise edition index or a developer edition index.
`void`	`setId(String id)` A unique identifier for the index.
`void`	`setName(String name)` The identifier of the index.
`void`	`setStatus(String status)` The current status of the index.
`void`	`setUpdatedAt(Date updatedAt)` The Unix timestamp when the index was last updated by the `UpdateIndex` API.
`String`	`toString()` Returns a string representation of this object.
`IndexConfigurationSummary`	`withCreatedAt(Date createdAt)` The Unix timestamp when the index was created.
`IndexConfigurationSummary`	`withEdition(IndexEdition edition)` Indicates whether the index is a enterprise edition index or a developer edition index.
`IndexConfigurationSummary`	`withEdition(String edition)` Indicates whether the index is a enterprise edition index or a developer edition index.
`IndexConfigurationSummary`	`withId(String id)` A unique identifier for the index.
`IndexConfigurationSummary`	`withName(String name)` The identifier of the index.
`IndexConfigurationSummary`	`withStatus(IndexStatus status)` The current status of the index.
`IndexConfigurationSummary`	`withStatus(String status)` The current status of the index.
`IndexConfigurationSummary`	`withUpdatedAt(Date updatedAt)` The Unix timestamp when the index was last updated by the `UpdateIndex` API.

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

- Constructor Detail
  - IndexConfigurationSummary
```
public IndexConfigurationSummary()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The identifier of the index.
    
    Parameters:
    
    name - The identifier of the index.
  - getName
```
public String getName()
```
    The identifier of the index.
    
    Returns:
    
    The identifier of the index.
  - withName
```
public IndexConfigurationSummary withName(String name)
```
    The identifier of the index.
    
    Parameters:
    
    name - The identifier of the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    A unique identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.
    
    Parameters:
    
    id - A unique identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.
  - getId
```
public String getId()
```
    A unique identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.
    
    Returns:
    
    A unique identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.
  - withId
```
public IndexConfigurationSummary withId(String id)
```
    A unique identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.
    
    Parameters:
    
    id - A unique identifier for the index. Use this to identify the index when you are using APIs such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEdition
```
public void setEdition(String edition)
```
    Indicates whether the index is a enterprise edition index or a developer edition index.
    
    Parameters:
    
    edition - Indicates whether the index is a enterprise edition index or a developer edition index.
    
    See Also:
    
    IndexEdition
  - getEdition
```
public String getEdition()
```
    Indicates whether the index is a enterprise edition index or a developer edition index.
    
    Returns:
    
    Indicates whether the index is a enterprise edition index or a developer edition index.
    
    See Also:
    
    IndexEdition
  - withEdition
```
public IndexConfigurationSummary withEdition(String edition)
```
    Indicates whether the index is a enterprise edition index or a developer edition index.
    
    Parameters:
    
    edition - Indicates whether the index is a enterprise edition index or a developer edition index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexEdition
  - withEdition
```
public IndexConfigurationSummary withEdition(IndexEdition edition)
```
    Indicates whether the index is a enterprise edition index or a developer edition index.
    
    Parameters:
    
    edition - Indicates whether the index is a enterprise edition index or a developer edition index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexEdition
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The Unix timestamp when the index was created.
    
    Parameters:
    
    createdAt - The Unix timestamp when the index was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The Unix timestamp when the index was created.
    
    Returns:
    
    The Unix timestamp when the index was created.
  - withCreatedAt
```
public IndexConfigurationSummary withCreatedAt(Date createdAt)
```
    The Unix timestamp when the index was created.
    
    Parameters:
    
    createdAt - The Unix timestamp when the index was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpdatedAt
```
public void setUpdatedAt(Date updatedAt)
```
    The Unix timestamp when the index was last updated by the UpdateIndex API.
    
    Parameters:
    
    updatedAt - The Unix timestamp when the index was last updated by the UpdateIndex API.
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    The Unix timestamp when the index was last updated by the UpdateIndex API.
    
    Returns:
    
    The Unix timestamp when the index was last updated by the UpdateIndex API.
  - withUpdatedAt
```
public IndexConfigurationSummary withUpdatedAt(Date updatedAt)
```
    The Unix timestamp when the index was last updated by the UpdateIndex API.
    
    Parameters:
    
    updatedAt - The Unix timestamp when the index was last updated by the UpdateIndex API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The current status of the index. When the status is ACTIVE, the index is ready to search.
    
    Parameters:
    
    status - The current status of the index. When the status is ACTIVE, the index is ready to search.
    
    See Also:
    
    IndexStatus
  - getStatus
```
public String getStatus()
```
    The current status of the index. When the status is ACTIVE, the index is ready to search.
    
    Returns:
    
    The current status of the index. When the status is ACTIVE, the index is ready to search.
    
    See Also:
    
    IndexStatus
  - withStatus
```
public IndexConfigurationSummary withStatus(String status)
```
    The current status of the index. When the status is ACTIVE, the index is ready to search.
    
    Parameters:
    
    status - The current status of the index. When the status is ACTIVE, the index is ready to search.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexStatus
  - withStatus
```
public IndexConfigurationSummary withStatus(IndexStatus status)
```
    The current status of the index. When the status is ACTIVE, the index is ready to search.
    
    Parameters:
    
    status - The current status of the index. When the status is ACTIVE, the index is ready to search.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexStatus
  - 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 IndexConfigurationSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class IndexConfigurationSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IndexConfigurationSummary

Method Detail

setName

getName

withName

setId

getId

withId

setEdition

getEdition

withEdition

withEdition

setCreatedAt

getCreatedAt

withCreatedAt

setUpdatedAt

getUpdatedAt

withUpdatedAt

setStatus

getStatus

withStatus

withStatus

toString

equals

hashCode

clone

marshall