Index (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.qbusiness.model.Index

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Index
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Summary information for your Amazon Q Business index.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Index()

Constructors
Constructor and Description
`Index()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Index`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreatedAt()` The Unix timestamp when the index was created.
`String`	`getDisplayName()` The name of the index.
`String`	`getIndexId()` The identifier for the index.
`String`	`getStatus()` The current status of the index.
`Date`	`getUpdatedAt()` The Unix timestamp when the index was last updated.
`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`	`setDisplayName(String displayName)` The name of the index.
`void`	`setIndexId(String indexId)` The identifier for 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.
`String`	`toString()` Returns a string representation of this object.
`Index`	`withCreatedAt(Date createdAt)` The Unix timestamp when the index was created.
`Index`	`withDisplayName(String displayName)` The name of the index.
`Index`	`withIndexId(String indexId)` The identifier for the index.
`Index`	`withStatus(IndexStatus status)` The current status of the index.
`Index`	`withStatus(String status)` The current status of the index.
`Index`	`withUpdatedAt(Date updatedAt)` The Unix timestamp when the index was last updated.

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

- Constructor Detail
  - Index
```
public Index()
```
- Method Detail
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    The name of the index.
    
    Parameters:
    
    displayName - The name of the index.
  - getDisplayName
```
public String getDisplayName()
```
    The name of the index.
    
    Returns:
    
    The name of the index.
  - withDisplayName
```
public Index withDisplayName(String displayName)
```
    The name of the index.
    
    Parameters:
    
    displayName - The name of the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexId
```
public void setIndexId(String indexId)
```
    The identifier for the index.
    
    Parameters:
    
    indexId - The identifier for the index.
  - getIndexId
```
public String getIndexId()
```
    The identifier for the index.
    
    Returns:
    
    The identifier for the index.
  - withIndexId
```
public Index withIndexId(String indexId)
```
    The identifier for the index.
    
    Parameters:
    
    indexId - The identifier for the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 Index 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.
    
    Parameters:
    
    updatedAt - The Unix timestamp when the index was last updated.
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    The Unix timestamp when the index was last updated.
    
    Returns:
    
    The Unix timestamp when the index was last updated.
  - withUpdatedAt
```
public Index withUpdatedAt(Date updatedAt)
```
    The Unix timestamp when the index was last updated.
    
    Parameters:
    
    updatedAt - The Unix timestamp when the index was last updated.
    
    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.
    
    Parameters:
    
    status - The current status of the index. When the status is ACTIVE, the index is ready.
    
    See Also:
    
    IndexStatus
  - getStatus
```
public String getStatus()
```
    The current status of the index. When the status is ACTIVE, the index is ready.
    
    Returns:
    
    The current status of the index. When the status is ACTIVE, the index is ready.
    
    See Also:
    
    IndexStatus
  - withStatus
```
public Index withStatus(String status)
```
    The current status of the index. When the status is ACTIVE, the index is ready.
    
    Parameters:
    
    status - The current status of the index. When the status is ACTIVE, the index is ready.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexStatus
  - withStatus
```
public Index withStatus(IndexStatus status)
```
    The current status of the index. When the status is ACTIVE, the index is ready.
    
    Parameters:
    
    status - The current status of the index. When the status is ACTIVE, the index is ready.
    
    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 Index 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.

AWS SDK for Java 1.x API Reference - 1.12.793

Class Index

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Index

Method Detail

setDisplayName

getDisplayName

withDisplayName

setIndexId

getIndexId

withIndexId

setCreatedAt

getCreatedAt

withCreatedAt

setUpdatedAt

getUpdatedAt

withUpdatedAt

setStatus

getStatus

withStatus

withStatus

toString

equals

hashCode

clone

marshall