DescribeIndexResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.kendra.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:: AWS API Documentation, 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)`
`CapacityUnitsConfiguration`	`getCapacityUnits()` For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application.
`Date`	`getCreatedAt()` The Unix timestamp when the index was created.
`String`	`getDescription()` The description for the index.
`List<DocumentMetadataConfiguration>`	`getDocumentMetadataConfigurations()` Configuration information for document metadata or fields.
`String`	`getEdition()` The Amazon Kendra edition used for the index.
`String`	`getErrorMessage()` When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a message that explains why.
`String`	`getId()` The identifier of the index.
`IndexStatistics`	`getIndexStatistics()` Provides information about the number of FAQ questions and answers and the number of text documents indexed.
`String`	`getName()` The name of the index.
`String`	`getRoleArn()` The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs.
`ServerSideEncryptionConfiguration`	`getServerSideEncryptionConfiguration()` The identifier of the KMS customer master key (CMK) that is used to encrypt your data.
`String`	`getStatus()` The current status of the index.
`Date`	`getUpdatedAt()` The Unix timestamp when the index was last updated.
`String`	`getUserContextPolicy()` The user context policy for the Amazon Kendra index.
`UserGroupResolutionConfiguration`	`getUserGroupResolutionConfiguration()` Whether you have enabled IAM Identity Center identity source for your users and groups.
`List<UserTokenConfiguration>`	`getUserTokenConfigurations()` The user token configuration for the Amazon Kendra index.
`int`	`hashCode()`
`void`	`setCapacityUnits(CapacityUnitsConfiguration capacityUnits)` For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application.
`void`	`setCreatedAt(Date createdAt)` The Unix timestamp when the index was created.
`void`	`setDescription(String description)` The description for the index.
`void`	`setDocumentMetadataConfigurations(Collection<DocumentMetadataConfiguration> documentMetadataConfigurations)` Configuration information for document metadata or fields.
`void`	`setEdition(String edition)` The Amazon Kendra edition used for the index.
`void`	`setErrorMessage(String errorMessage)` When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a message that explains why.
`void`	`setId(String id)` The identifier of the index.
`void`	`setIndexStatistics(IndexStatistics indexStatistics)` Provides information about the number of FAQ questions and answers and the number of text documents indexed.
`void`	`setName(String name)` The name of the index.
`void`	`setRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs.
`void`	`setServerSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration)` The identifier of the KMS customer master key (CMK) that is used to encrypt your data.
`void`	`setStatus(String status)` The current status of the index.
`void`	`setUpdatedAt(Date updatedAt)` The Unix timestamp when the index was last updated.
`void`	`setUserContextPolicy(String userContextPolicy)` The user context policy for the Amazon Kendra index.
`void`	`setUserGroupResolutionConfiguration(UserGroupResolutionConfiguration userGroupResolutionConfiguration)` Whether you have enabled IAM Identity Center identity source for your users and groups.
`void`	`setUserTokenConfigurations(Collection<UserTokenConfiguration> userTokenConfigurations)` The user token configuration for the Amazon Kendra index.
`String`	`toString()` Returns a string representation of this object.
`DescribeIndexResult`	`withCapacityUnits(CapacityUnitsConfiguration capacityUnits)` For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application.
`DescribeIndexResult`	`withCreatedAt(Date createdAt)` The Unix timestamp when the index was created.
`DescribeIndexResult`	`withDescription(String description)` The description for the index.
`DescribeIndexResult`	`withDocumentMetadataConfigurations(Collection<DocumentMetadataConfiguration> documentMetadataConfigurations)` Configuration information for document metadata or fields.
`DescribeIndexResult`	`withDocumentMetadataConfigurations(DocumentMetadataConfiguration... documentMetadataConfigurations)` Configuration information for document metadata or fields.
`DescribeIndexResult`	`withEdition(IndexEdition edition)` The Amazon Kendra edition used for the index.
`DescribeIndexResult`	`withEdition(String edition)` The Amazon Kendra edition used for the index.
`DescribeIndexResult`	`withErrorMessage(String errorMessage)` When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a message that explains why.
`DescribeIndexResult`	`withId(String id)` The identifier of the index.
`DescribeIndexResult`	`withIndexStatistics(IndexStatistics indexStatistics)` Provides information about the number of FAQ questions and answers and the number of text documents indexed.
`DescribeIndexResult`	`withName(String name)` The name of the index.
`DescribeIndexResult`	`withRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs.
`DescribeIndexResult`	`withServerSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration)` The identifier of the KMS customer master key (CMK) that is used to encrypt your data.
`DescribeIndexResult`	`withStatus(IndexStatus status)` The current status of the index.
`DescribeIndexResult`	`withStatus(String status)` The current status of the index.
`DescribeIndexResult`	`withUpdatedAt(Date updatedAt)` The Unix timestamp when the index was last updated.
`DescribeIndexResult`	`withUserContextPolicy(String userContextPolicy)` The user context policy for the Amazon Kendra index.
`DescribeIndexResult`	`withUserContextPolicy(UserContextPolicy userContextPolicy)` The user context policy for the Amazon Kendra index.
`DescribeIndexResult`	`withUserGroupResolutionConfiguration(UserGroupResolutionConfiguration userGroupResolutionConfiguration)` Whether you have enabled IAM Identity Center identity source for your users and groups.
`DescribeIndexResult`	`withUserTokenConfigurations(Collection<UserTokenConfiguration> userTokenConfigurations)` The user token configuration for the Amazon Kendra index.
`DescribeIndexResult`	`withUserTokenConfigurations(UserTokenConfiguration... userTokenConfigurations)` The user token configuration for the Amazon Kendra index.

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
  - setName
```
public void setName(String name)
```
    The name of the index.
    
    Parameters:
    
    name - The name of the index.
  - getName
```
public String getName()
```
    The name of the index.
    
    Returns:
    
    The name of the index.
  - withName
```
public DescribeIndexResult withName(String name)
```
    The name of the index.
    
    Parameters:
    
    name - The name of the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    The identifier of the index.
    
    Parameters:
    
    id - The identifier of the index.
  - getId
```
public String getId()
```
    The identifier of the index.
    
    Returns:
    
    The identifier of the index.
  - withId
```
public DescribeIndexResult withId(String id)
```
    The identifier of the index.
    
    Parameters:
    
    id - The identifier of the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEdition
```
public void setEdition(String edition)
```
    The Amazon Kendra edition used for the index. You decide the edition when you create the index.
    
    Parameters:
    
    edition - The Amazon Kendra edition used for the index. You decide the edition when you create the index.
    
    See Also:
    
    IndexEdition
  - getEdition
```
public String getEdition()
```
    The Amazon Kendra edition used for the index. You decide the edition when you create the index.
    
    Returns:
    
    The Amazon Kendra edition used for the index. You decide the edition when you create the index.
    
    See Also:
    
    IndexEdition
  - withEdition
```
public DescribeIndexResult withEdition(String edition)
```
    The Amazon Kendra edition used for the index. You decide the edition when you create the index.
    
    Parameters:
    
    edition - The Amazon Kendra edition used for the index. You decide the edition when you create the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexEdition
  - withEdition
```
public DescribeIndexResult withEdition(IndexEdition edition)
```
    The Amazon Kendra edition used for the index. You decide the edition when you create the index.
    
    Parameters:
    
    edition - The Amazon Kendra edition used for the index. You decide the edition when you create the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexEdition
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs.
  - getRoleArn
```
public String getRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs.
  - withRoleArn
```
public DescribeIndexResult withRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon CloudWatch logs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServerSideEncryptionConfiguration
```
public void setServerSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration)
```
    The identifier of the KMS customer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
    
    Parameters:
    
    serverSideEncryptionConfiguration - The identifier of the KMS customer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
  - getServerSideEncryptionConfiguration
```
public ServerSideEncryptionConfiguration getServerSideEncryptionConfiguration()
```
    The identifier of the KMS customer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
    
    Returns:
    
    The identifier of the KMS customer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
  - withServerSideEncryptionConfiguration
```
public DescribeIndexResult withServerSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration)
```
    The identifier of the KMS customer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
    
    Parameters:
    
    serverSideEncryptionConfiguration - The identifier of the KMS customer master key (CMK) that is used to encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
    
    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 DescribeIndexResult 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 DescribeIndexResult 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
  - setDescription
```
public void setDescription(String description)
```
    The description for the index.
    
    Parameters:
    
    description - The description for the index.
  - getDescription
```
public String getDescription()
```
    The description for the index.
    
    Returns:
    
    The description for the index.
  - withDescription
```
public DescribeIndexResult withDescription(String description)
```
    The description for the index.
    
    Parameters:
    
    description - The description 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 DescribeIndexResult 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 DescribeIndexResult 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.
  - getDocumentMetadataConfigurations
```
public List<DocumentMetadataConfiguration> getDocumentMetadataConfigurations()
```
    Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.
    
    Returns:
    
    Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.
  - setDocumentMetadataConfigurations
```
public void setDocumentMetadataConfigurations(Collection<DocumentMetadataConfiguration> documentMetadataConfigurations)
```
    Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.
    
    Parameters:
    
    documentMetadataConfigurations - Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.
  - withDocumentMetadataConfigurations
```
public DescribeIndexResult withDocumentMetadataConfigurations(DocumentMetadataConfiguration... documentMetadataConfigurations)
```
    Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.
    
    NOTE: This method appends the values to the existing list (if any). Use setDocumentMetadataConfigurations(java.util.Collection) or withDocumentMetadataConfigurations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    documentMetadataConfigurations - Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDocumentMetadataConfigurations
```
public DescribeIndexResult withDocumentMetadataConfigurations(Collection<DocumentMetadataConfiguration> documentMetadataConfigurations)
```
    Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.
    
    Parameters:
    
    documentMetadataConfigurations - Configuration information for document metadata or fields. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.
    
    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 FAQ questions and answers and the number of text documents indexed.
    
    Parameters:
    
    indexStatistics - Provides information about the number of FAQ questions and answers and the number of text documents indexed.
  - getIndexStatistics
```
public IndexStatistics getIndexStatistics()
```
    Provides information about the number of FAQ questions and answers and the number of text documents indexed.
    
    Returns:
    
    Provides information about the number of FAQ questions and answers and the number of text documents indexed.
  - withIndexStatistics
```
public DescribeIndexResult withIndexStatistics(IndexStatistics indexStatistics)
```
    Provides information about the number of FAQ questions and answers and the number of text documents indexed.
    
    Parameters:
    
    indexStatistics - Provides information about the number of FAQ questions and answers and the number of text documents indexed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorMessage
```
public void setErrorMessage(String errorMessage)
```
    When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
    
    Parameters:
    
    errorMessage - When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
  - getErrorMessage
```
public String getErrorMessage()
```
    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.
  - withErrorMessage
```
public DescribeIndexResult withErrorMessage(String errorMessage)
```
    When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.
    
    Parameters:
    
    errorMessage - 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.
  - setCapacityUnits
```
public void setCapacityUnits(CapacityUnitsConfiguration capacityUnits)
```
    For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.
    
    Parameters:
    
    capacityUnits - For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.
  - getCapacityUnits
```
public CapacityUnitsConfiguration getCapacityUnits()
```
    For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.
    
    Returns:
    
    For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.
  - withCapacityUnits
```
public DescribeIndexResult withCapacityUnits(CapacityUnitsConfiguration capacityUnits)
```
    For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.
    
    Parameters:
    
    capacityUnits - For Enterprise Edition indexes, you can choose to use additional capacity to meet the needs of your application. This contains the capacity units used for the index. A query or document storage capacity of zero indicates that the index is using the default capacity. For more information on the default capacity for an index and adjusting this, see Adjusting capacity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUserTokenConfigurations
```
public List<UserTokenConfiguration> getUserTokenConfigurations()
```
    The user token configuration for the Amazon Kendra index.
    
    Returns:
    
    The user token configuration for the Amazon Kendra index.
  - setUserTokenConfigurations
```
public void setUserTokenConfigurations(Collection<UserTokenConfiguration> userTokenConfigurations)
```
    The user token configuration for the Amazon Kendra index.
    
    Parameters:
    
    userTokenConfigurations - The user token configuration for the Amazon Kendra index.
  - withUserTokenConfigurations
```
public DescribeIndexResult withUserTokenConfigurations(UserTokenConfiguration... userTokenConfigurations)
```
    The user token configuration for the Amazon Kendra index.
    
    NOTE: This method appends the values to the existing list (if any). Use setUserTokenConfigurations(java.util.Collection) or withUserTokenConfigurations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    userTokenConfigurations - The user token configuration for the Amazon Kendra index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUserTokenConfigurations
```
public DescribeIndexResult withUserTokenConfigurations(Collection<UserTokenConfiguration> userTokenConfigurations)
```
    The user token configuration for the Amazon Kendra index.
    
    Parameters:
    
    userTokenConfigurations - The user token configuration for the Amazon Kendra index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserContextPolicy
```
public void setUserContextPolicy(String userContextPolicy)
```
    The user context policy for the Amazon Kendra index.
    
    Parameters:
    
    userContextPolicy - The user context policy for the Amazon Kendra index.
    
    See Also:
    
    UserContextPolicy
  - getUserContextPolicy
```
public String getUserContextPolicy()
```
    The user context policy for the Amazon Kendra index.
    
    Returns:
    
    The user context policy for the Amazon Kendra index.
    
    See Also:
    
    UserContextPolicy
  - withUserContextPolicy
```
public DescribeIndexResult withUserContextPolicy(String userContextPolicy)
```
    The user context policy for the Amazon Kendra index.
    
    Parameters:
    
    userContextPolicy - The user context policy for the Amazon Kendra index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserContextPolicy
  - withUserContextPolicy
```
public DescribeIndexResult withUserContextPolicy(UserContextPolicy userContextPolicy)
```
    The user context policy for the Amazon Kendra index.
    
    Parameters:
    
    userContextPolicy - The user context policy for the Amazon Kendra index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserContextPolicy
  - setUserGroupResolutionConfiguration
```
public void setUserGroupResolutionConfiguration(UserGroupResolutionConfiguration userGroupResolutionConfiguration)
```
    Whether you have enabled IAM Identity Center identity source for your users and groups. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
    
    Parameters:
    
    userGroupResolutionConfiguration - Whether you have enabled IAM Identity Center identity source for your users and groups. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
  - getUserGroupResolutionConfiguration
```
public UserGroupResolutionConfiguration getUserGroupResolutionConfiguration()
```
    Whether you have enabled IAM Identity Center identity source for your users and groups. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
    
    Returns:
    
    Whether you have enabled IAM Identity Center identity source for your users and groups. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
  - withUserGroupResolutionConfiguration
```
public DescribeIndexResult withUserGroupResolutionConfiguration(UserGroupResolutionConfiguration userGroupResolutionConfiguration)
```
    Whether you have enabled IAM Identity Center identity source for your users and groups. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
    
    Parameters:
    
    userGroupResolutionConfiguration - Whether you have enabled IAM Identity Center identity source for your users and groups. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
    
    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.780

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

setName

getName

withName

setId

getId

withId

setEdition

getEdition

withEdition

withEdition

setRoleArn

getRoleArn

withRoleArn

setServerSideEncryptionConfiguration

getServerSideEncryptionConfiguration

withServerSideEncryptionConfiguration

setStatus

getStatus

withStatus

withStatus

setDescription

getDescription

withDescription

setCreatedAt

getCreatedAt

withCreatedAt

setUpdatedAt

getUpdatedAt

withUpdatedAt

getDocumentMetadataConfigurations

setDocumentMetadataConfigurations

withDocumentMetadataConfigurations

withDocumentMetadataConfigurations

setIndexStatistics

getIndexStatistics

withIndexStatistics

setErrorMessage

getErrorMessage

withErrorMessage

setCapacityUnits

getCapacityUnits

withCapacityUnits

getUserTokenConfigurations

setUserTokenConfigurations

withUserTokenConfigurations

withUserTokenConfigurations

setUserContextPolicy

getUserContextPolicy

withUserContextPolicy

withUserContextPolicy

setUserGroupResolutionConfiguration

getUserGroupResolutionConfiguration

withUserGroupResolutionConfiguration

toString

equals

hashCode

clone