GetIndexResult (AWS Java SDK for QBusiness 1.12.629 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.qbusiness.model.GetIndexResult

All Implemented Interfaces:: Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetIndexResult()

Constructors
Constructor and Description
`GetIndexResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetIndexResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getApplicationId()` The identifier of the Amazon Q application associated with the index.
`IndexCapacityConfiguration`	`getCapacityConfiguration()` The storage capacity units chosen for your Amazon Q index.
`Date`	`getCreatedAt()` The Unix timestamp when the Amazon Q index was created.
`String`	`getDescription()` The description for the Amazon Q index.
`String`	`getDisplayName()` The name of the Amazon Q index.
`List<DocumentAttributeConfiguration>`	`getDocumentAttributeConfigurations()` Configuration information for document attributes or metadata.
`ErrorDetail`	`getError()` When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a message that explains why.
`String`	`getIndexArn()` The Amazon Resource Name (ARN) of the Amazon Q index.
`String`	`getIndexId()` The identifier of the Amazon Q index.
`IndexStatistics`	`getIndexStatistics()` Provides information about the number of documents indexed.
`String`	`getStatus()` The current status of the index.
`Date`	`getUpdatedAt()` The Unix timestamp when the Amazon Q index was last updated.
`int`	`hashCode()`
`void`	`setApplicationId(String applicationId)` The identifier of the Amazon Q application associated with the index.
`void`	`setCapacityConfiguration(IndexCapacityConfiguration capacityConfiguration)` The storage capacity units chosen for your Amazon Q index.
`void`	`setCreatedAt(Date createdAt)` The Unix timestamp when the Amazon Q index was created.
`void`	`setDescription(String description)` The description for the Amazon Q index.
`void`	`setDisplayName(String displayName)` The name of the Amazon Q index.
`void`	`setDocumentAttributeConfigurations(Collection<DocumentAttributeConfiguration> documentAttributeConfigurations)` Configuration information for document attributes or metadata.
`void`	`setError(ErrorDetail error)` When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a message that explains why.
`void`	`setIndexArn(String indexArn)` The Amazon Resource Name (ARN) of the Amazon Q index.
`void`	`setIndexId(String indexId)` The identifier of the Amazon Q index.
`void`	`setIndexStatistics(IndexStatistics indexStatistics)` Provides information about the number of documents indexed.
`void`	`setStatus(String status)` The current status of the index.
`void`	`setUpdatedAt(Date updatedAt)` The Unix timestamp when the Amazon Q index was last updated.
`String`	`toString()` Returns a string representation of this object.
`GetIndexResult`	`withApplicationId(String applicationId)` The identifier of the Amazon Q application associated with the index.
`GetIndexResult`	`withCapacityConfiguration(IndexCapacityConfiguration capacityConfiguration)` The storage capacity units chosen for your Amazon Q index.
`GetIndexResult`	`withCreatedAt(Date createdAt)` The Unix timestamp when the Amazon Q index was created.
`GetIndexResult`	`withDescription(String description)` The description for the Amazon Q index.
`GetIndexResult`	`withDisplayName(String displayName)` The name of the Amazon Q index.
`GetIndexResult`	`withDocumentAttributeConfigurations(Collection<DocumentAttributeConfiguration> documentAttributeConfigurations)` Configuration information for document attributes or metadata.
`GetIndexResult`	`withDocumentAttributeConfigurations(DocumentAttributeConfiguration... documentAttributeConfigurations)` Configuration information for document attributes or metadata.
`GetIndexResult`	`withError(ErrorDetail error)` When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a message that explains why.
`GetIndexResult`	`withIndexArn(String indexArn)` The Amazon Resource Name (ARN) of the Amazon Q index.
`GetIndexResult`	`withIndexId(String indexId)` The identifier of the Amazon Q index.
`GetIndexResult`	`withIndexStatistics(IndexStatistics indexStatistics)` Provides information about the number of documents indexed.
`GetIndexResult`	`withStatus(IndexStatus status)` The current status of the index.
`GetIndexResult`	`withStatus(String status)` The current status of the index.
`GetIndexResult`	`withUpdatedAt(Date updatedAt)` The Unix timestamp when the Amazon Q index was last updated.

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

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

- Constructor Detail
  - GetIndexResult
```
public GetIndexResult()
```
- Method Detail
  - setApplicationId
```
public void setApplicationId(String applicationId)
```
    The identifier of the Amazon Q application associated with the index.
    
    Parameters:
    
    applicationId - The identifier of the Amazon Q application associated with the index.
  - getApplicationId
```
public String getApplicationId()
```
    The identifier of the Amazon Q application associated with the index.
    
    Returns:
    
    The identifier of the Amazon Q application associated with the index.
  - withApplicationId
```
public GetIndexResult withApplicationId(String applicationId)
```
    The identifier of the Amazon Q application associated with the index.
    
    Parameters:
    
    applicationId - The identifier of the Amazon Q application associated with the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCapacityConfiguration
```
public void setCapacityConfiguration(IndexCapacityConfiguration capacityConfiguration)
```
    The storage capacity units chosen for your Amazon Q index.
    
    Parameters:
    
    capacityConfiguration - The storage capacity units chosen for your Amazon Q index.
  - getCapacityConfiguration
```
public IndexCapacityConfiguration getCapacityConfiguration()
```
    The storage capacity units chosen for your Amazon Q index.
    
    Returns:
    
    The storage capacity units chosen for your Amazon Q index.
  - withCapacityConfiguration
```
public GetIndexResult withCapacityConfiguration(IndexCapacityConfiguration capacityConfiguration)
```
    The storage capacity units chosen for your Amazon Q index.
    
    Parameters:
    
    capacityConfiguration - The storage capacity units chosen for your Amazon Q 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 Amazon Q index was created.
    
    Parameters:
    
    createdAt - The Unix timestamp when the Amazon Q index was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The Unix timestamp when the Amazon Q index was created.
    
    Returns:
    
    The Unix timestamp when the Amazon Q index was created.
  - withCreatedAt
```
public GetIndexResult withCreatedAt(Date createdAt)
```
    The Unix timestamp when the Amazon Q index was created.
    
    Parameters:
    
    createdAt - The Unix timestamp when the Amazon Q index was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description for the Amazon Q index.
    
    Parameters:
    
    description - The description for the Amazon Q index.
  - getDescription
```
public String getDescription()
```
    The description for the Amazon Q index.
    
    Returns:
    
    The description for the Amazon Q index.
  - withDescription
```
public GetIndexResult withDescription(String description)
```
    The description for the Amazon Q index.
    
    Parameters:
    
    description - The description for the Amazon Q index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    The name of the Amazon Q index.
    
    Parameters:
    
    displayName - The name of the Amazon Q index.
  - getDisplayName
```
public String getDisplayName()
```
    The name of the Amazon Q index.
    
    Returns:
    
    The name of the Amazon Q index.
  - withDisplayName
```
public GetIndexResult withDisplayName(String displayName)
```
    The name of the Amazon Q index.
    
    Parameters:
    
    displayName - The name of the Amazon Q index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDocumentAttributeConfigurations
```
public List<DocumentAttributeConfiguration> getDocumentAttributeConfigurations()
```
    Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
    
    Returns:
    
    Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
  - setDocumentAttributeConfigurations
```
public void setDocumentAttributeConfigurations(Collection<DocumentAttributeConfiguration> documentAttributeConfigurations)
```
    Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
    
    Parameters:
    
    documentAttributeConfigurations - Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
  - withDocumentAttributeConfigurations
```
public GetIndexResult withDocumentAttributeConfigurations(DocumentAttributeConfiguration... documentAttributeConfigurations)
```
    Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
    
    NOTE: This method appends the values to the existing list (if any). Use setDocumentAttributeConfigurations(java.util.Collection) or withDocumentAttributeConfigurations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    documentAttributeConfigurations - Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDocumentAttributeConfigurations
```
public GetIndexResult withDocumentAttributeConfigurations(Collection<DocumentAttributeConfiguration> documentAttributeConfigurations)
```
    Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
    
    Parameters:
    
    documentAttributeConfigurations - Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setError
```
public void setError(ErrorDetail error)
```
    When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
    
    Parameters:
    
    error - When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
  - getError
```
public ErrorDetail getError()
```
    When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
    
    Returns:
    
    When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
  - withError
```
public GetIndexResult withError(ErrorDetail error)
```
    When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
    
    Parameters:
    
    error - When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexArn
```
public void setIndexArn(String indexArn)
```
    The Amazon Resource Name (ARN) of the Amazon Q index.
    
    Parameters:
    
    indexArn - The Amazon Resource Name (ARN) of the Amazon Q index.
  - getIndexArn
```
public String getIndexArn()
```
    The Amazon Resource Name (ARN) of the Amazon Q index.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Amazon Q index.
  - withIndexArn
```
public GetIndexResult withIndexArn(String indexArn)
```
    The Amazon Resource Name (ARN) of the Amazon Q index.
    
    Parameters:
    
    indexArn - The Amazon Resource Name (ARN) of the Amazon Q index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexId
```
public void setIndexId(String indexId)
```
    The identifier of the Amazon Q index.
    
    Parameters:
    
    indexId - The identifier of the Amazon Q index.
  - getIndexId
```
public String getIndexId()
```
    The identifier of the Amazon Q index.
    
    Returns:
    
    The identifier of the Amazon Q index.
  - withIndexId
```
public GetIndexResult withIndexId(String indexId)
```
    The identifier of the Amazon Q index.
    
    Parameters:
    
    indexId - The identifier of the Amazon Q index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexStatistics
```
public void setIndexStatistics(IndexStatistics indexStatistics)
```
    Provides information about the number of documents indexed.
    
    Parameters:
    
    indexStatistics - Provides information about the number of documents indexed.
  - getIndexStatistics
```
public IndexStatistics getIndexStatistics()
```
    Provides information about the number of documents indexed.
    
    Returns:
    
    Provides information about the number of documents indexed.
  - withIndexStatistics
```
public GetIndexResult withIndexStatistics(IndexStatistics indexStatistics)
```
    Provides information about the number of documents indexed.
    
    Parameters:
    
    indexStatistics - Provides information about the number of documents indexed.
    
    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 value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
    
    Parameters:
    
    status - The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
    
    See Also:
    
    IndexStatus
  - getStatus
```
public String getStatus()
```
    The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
    
    Returns:
    
    The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
    
    See Also:
    
    IndexStatus
  - withStatus
```
public GetIndexResult withStatus(String status)
```
    The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
    
    Parameters:
    
    status - The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexStatus
  - withStatus
```
public GetIndexResult withStatus(IndexStatus status)
```
    The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
    
    Parameters:
    
    status - The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexStatus
  - setUpdatedAt
```
public void setUpdatedAt(Date updatedAt)
```
    The Unix timestamp when the Amazon Q index was last updated.
    
    Parameters:
    
    updatedAt - The Unix timestamp when the Amazon Q index was last updated.
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    The Unix timestamp when the Amazon Q index was last updated.
    
    Returns:
    
    The Unix timestamp when the Amazon Q index was last updated.
  - withUpdatedAt
```
public GetIndexResult withUpdatedAt(Date updatedAt)
```
    The Unix timestamp when the Amazon Q index was last updated.
    
    Parameters:
    
    updatedAt - The Unix timestamp when the Amazon Q index was last updated.
    
    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 GetIndexResult clone()
```
    Overrides:
    
    clone in class Object

Class GetIndexResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetIndexResult

Method Detail

setApplicationId

getApplicationId

withApplicationId

setCapacityConfiguration

getCapacityConfiguration

withCapacityConfiguration

setCreatedAt

getCreatedAt

withCreatedAt

setDescription

getDescription

withDescription

setDisplayName

getDisplayName

withDisplayName

getDocumentAttributeConfigurations

setDocumentAttributeConfigurations

withDocumentAttributeConfigurations

withDocumentAttributeConfigurations

setError

getError

withError

setIndexArn

getIndexArn

withIndexArn

setIndexId

getIndexId

withIndexId

setIndexStatistics

getIndexStatistics

withIndexStatistics

setStatus

getStatus

withStatus

withStatus

setUpdatedAt

getUpdatedAt

withUpdatedAt

toString

equals

hashCode

clone