DescribeExperienceResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.kendra.model.DescribeExperienceResult

All Implemented Interfaces:: Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeExperienceResult()

Constructors
Constructor and Description
`DescribeExperienceResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeExperienceResult`	`clone()`
`boolean`	`equals(Object obj)`
`ExperienceConfiguration`	`getConfiguration()` Shows the configuration information for your Amazon Kendra experience.
`Date`	`getCreatedAt()` Shows the date-time your Amazon Kendra experience was created.
`String`	`getDescription()` Shows the description for your Amazon Kendra experience.
`List<ExperienceEndpoint>`	`getEndpoints()` Shows the endpoint URLs for your Amazon Kendra experiences.
`String`	`getErrorMessage()` The reason your Amazon Kendra experience could not properly process.
`String`	`getId()` Shows the identifier of your Amazon Kendra experience.
`String`	`getIndexId()` Shows the identifier of the index for your Amazon Kendra experience.
`String`	`getName()` Shows the name of your Amazon Kendra experience.
`String`	`getRoleArn()` Shows the Amazon Resource Name (ARN) of a role with permission to access `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and Amazon Web Services SSO that stores your user and group information.
`String`	`getStatus()` The current processing status of your Amazon Kendra experience.
`Date`	`getUpdatedAt()` Shows the date-time your Amazon Kendra experience was last updated.
`int`	`hashCode()`
`void`	`setConfiguration(ExperienceConfiguration configuration)` Shows the configuration information for your Amazon Kendra experience.
`void`	`setCreatedAt(Date createdAt)` Shows the date-time your Amazon Kendra experience was created.
`void`	`setDescription(String description)` Shows the description for your Amazon Kendra experience.
`void`	`setEndpoints(Collection<ExperienceEndpoint> endpoints)` Shows the endpoint URLs for your Amazon Kendra experiences.
`void`	`setErrorMessage(String errorMessage)` The reason your Amazon Kendra experience could not properly process.
`void`	`setId(String id)` Shows the identifier of your Amazon Kendra experience.
`void`	`setIndexId(String indexId)` Shows the identifier of the index for your Amazon Kendra experience.
`void`	`setName(String name)` Shows the name of your Amazon Kendra experience.
`void`	`setRoleArn(String roleArn)` Shows the Amazon Resource Name (ARN) of a role with permission to access `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and Amazon Web Services SSO that stores your user and group information.
`void`	`setStatus(String status)` The current processing status of your Amazon Kendra experience.
`void`	`setUpdatedAt(Date updatedAt)` Shows the date-time your Amazon Kendra experience was last updated.
`String`	`toString()` Returns a string representation of this object.
`DescribeExperienceResult`	`withConfiguration(ExperienceConfiguration configuration)` Shows the configuration information for your Amazon Kendra experience.
`DescribeExperienceResult`	`withCreatedAt(Date createdAt)` Shows the date-time your Amazon Kendra experience was created.
`DescribeExperienceResult`	`withDescription(String description)` Shows the description for your Amazon Kendra experience.
`DescribeExperienceResult`	`withEndpoints(Collection<ExperienceEndpoint> endpoints)` Shows the endpoint URLs for your Amazon Kendra experiences.
`DescribeExperienceResult`	`withEndpoints(ExperienceEndpoint... endpoints)` Shows the endpoint URLs for your Amazon Kendra experiences.
`DescribeExperienceResult`	`withErrorMessage(String errorMessage)` The reason your Amazon Kendra experience could not properly process.
`DescribeExperienceResult`	`withId(String id)` Shows the identifier of your Amazon Kendra experience.
`DescribeExperienceResult`	`withIndexId(String indexId)` Shows the identifier of the index for your Amazon Kendra experience.
`DescribeExperienceResult`	`withName(String name)` Shows the name of your Amazon Kendra experience.
`DescribeExperienceResult`	`withRoleArn(String roleArn)` Shows the Amazon Resource Name (ARN) of a role with permission to access `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and Amazon Web Services SSO that stores your user and group information.
`DescribeExperienceResult`	`withStatus(ExperienceStatus status)` The current processing status of your Amazon Kendra experience.
`DescribeExperienceResult`	`withStatus(String status)` The current processing status of your Amazon Kendra experience.
`DescribeExperienceResult`	`withUpdatedAt(Date updatedAt)` Shows the date-time your Amazon Kendra experience was last updated.

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
  - DescribeExperienceResult
```
public DescribeExperienceResult()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    Shows the identifier of your Amazon Kendra experience.
    
    Parameters:
    
    id - Shows the identifier of your Amazon Kendra experience.
  - getId
```
public String getId()
```
    Shows the identifier of your Amazon Kendra experience.
    
    Returns:
    
    Shows the identifier of your Amazon Kendra experience.
  - withId
```
public DescribeExperienceResult withId(String id)
```
    Shows the identifier of your Amazon Kendra experience.
    
    Parameters:
    
    id - Shows the identifier of your Amazon Kendra experience.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexId
```
public void setIndexId(String indexId)
```
    Shows the identifier of the index for your Amazon Kendra experience.
    
    Parameters:
    
    indexId - Shows the identifier of the index for your Amazon Kendra experience.
  - getIndexId
```
public String getIndexId()
```
    Shows the identifier of the index for your Amazon Kendra experience.
    
    Returns:
    
    Shows the identifier of the index for your Amazon Kendra experience.
  - withIndexId
```
public DescribeExperienceResult withIndexId(String indexId)
```
    Shows the identifier of the index for your Amazon Kendra experience.
    
    Parameters:
    
    indexId - Shows the identifier of the index for your Amazon Kendra experience.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    Shows the name of your Amazon Kendra experience.
    
    Parameters:
    
    name - Shows the name of your Amazon Kendra experience.
  - getName
```
public String getName()
```
    Shows the name of your Amazon Kendra experience.
    
    Returns:
    
    Shows the name of your Amazon Kendra experience.
  - withName
```
public DescribeExperienceResult withName(String name)
```
    Shows the name of your Amazon Kendra experience.
    
    Parameters:
    
    name - Shows the name of your Amazon Kendra experience.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEndpoints
```
public List<ExperienceEndpoint> getEndpoints()
```
    Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.
    
    Returns:
    
    Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.
  - setEndpoints
```
public void setEndpoints(Collection<ExperienceEndpoint> endpoints)
```
    Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.
    
    Parameters:
    
    endpoints - Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.
  - withEndpoints
```
public DescribeExperienceResult withEndpoints(ExperienceEndpoint... endpoints)
```
    Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.
    
    NOTE: This method appends the values to the existing list (if any). Use setEndpoints(java.util.Collection) or withEndpoints(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    endpoints - Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEndpoints
```
public DescribeExperienceResult withEndpoints(Collection<ExperienceEndpoint> endpoints)
```
    Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.
    
    Parameters:
    
    endpoints - Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConfiguration
```
public void setConfiguration(ExperienceConfiguration configuration)
```
    Shows the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.
    
    Parameters:
    
    configuration - Shows the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.
  - getConfiguration
```
public ExperienceConfiguration getConfiguration()
```
    Shows the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.
    
    Returns:
    
    Shows the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.
  - withConfiguration
```
public DescribeExperienceResult withConfiguration(ExperienceConfiguration configuration)
```
    Shows the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.
    
    Parameters:
    
    configuration - Shows the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    Shows the date-time your Amazon Kendra experience was created.
    
    Parameters:
    
    createdAt - Shows the date-time your Amazon Kendra experience was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    Shows the date-time your Amazon Kendra experience was created.
    
    Returns:
    
    Shows the date-time your Amazon Kendra experience was created.
  - withCreatedAt
```
public DescribeExperienceResult withCreatedAt(Date createdAt)
```
    Shows the date-time your Amazon Kendra experience was created.
    
    Parameters:
    
    createdAt - Shows the date-time your Amazon Kendra experience was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpdatedAt
```
public void setUpdatedAt(Date updatedAt)
```
    Shows the date-time your Amazon Kendra experience was last updated.
    
    Parameters:
    
    updatedAt - Shows the date-time your Amazon Kendra experience was last updated.
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    Shows the date-time your Amazon Kendra experience was last updated.
    
    Returns:
    
    Shows the date-time your Amazon Kendra experience was last updated.
  - withUpdatedAt
```
public DescribeExperienceResult withUpdatedAt(Date updatedAt)
```
    Shows the date-time your Amazon Kendra experience was last updated.
    
    Parameters:
    
    updatedAt - Shows the date-time your Amazon Kendra experience was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    Shows the description for your Amazon Kendra experience.
    
    Parameters:
    
    description - Shows the description for your Amazon Kendra experience.
  - getDescription
```
public String getDescription()
```
    Shows the description for your Amazon Kendra experience.
    
    Returns:
    
    Shows the description for your Amazon Kendra experience.
  - withDescription
```
public DescribeExperienceResult withDescription(String description)
```
    Shows the description for your Amazon Kendra experience.
    
    Parameters:
    
    description - Shows the description for your Amazon Kendra experience.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.
    
    Parameters:
    
    status - The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.
    
    See Also:
    
    ExperienceStatus
  - getStatus
```
public String getStatus()
```
    The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.
    
    Returns:
    
    The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.
    
    See Also:
    
    ExperienceStatus
  - withStatus
```
public DescribeExperienceResult withStatus(String status)
```
    The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.
    
    Parameters:
    
    status - The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExperienceStatus
  - withStatus
```
public DescribeExperienceResult withStatus(ExperienceStatus status)
```
    The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.
    
    Parameters:
    
    status - The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExperienceStatus
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your user and group information.
    
    Parameters:
    
    roleArn - Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your user and group information.
  - getRoleArn
```
public String getRoleArn()
```
    Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your user and group information.
    
    Returns:
    
    Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your user and group information.
  - withRoleArn
```
public DescribeExperienceResult withRoleArn(String roleArn)
```
    Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your user and group information.
    
    Parameters:
    
    roleArn - Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and Amazon Web Services SSO that stores your user and group information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorMessage
```
public void setErrorMessage(String errorMessage)
```
    The reason your Amazon Kendra experience could not properly process.
    
    Parameters:
    
    errorMessage - The reason your Amazon Kendra experience could not properly process.
  - getErrorMessage
```
public String getErrorMessage()
```
    The reason your Amazon Kendra experience could not properly process.
    
    Returns:
    
    The reason your Amazon Kendra experience could not properly process.
  - withErrorMessage
```
public DescribeExperienceResult withErrorMessage(String errorMessage)
```
    The reason your Amazon Kendra experience could not properly process.
    
    Parameters:
    
    errorMessage - The reason your Amazon Kendra experience could not properly process.
    
    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 DescribeExperienceResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DescribeExperienceResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeExperienceResult

Method Detail

setId

getId

withId

setIndexId

getIndexId

withIndexId

setName

getName

withName

getEndpoints

setEndpoints

withEndpoints

withEndpoints

setConfiguration

getConfiguration

withConfiguration

setCreatedAt

getCreatedAt

withCreatedAt

setUpdatedAt

getUpdatedAt

withUpdatedAt

setDescription

getDescription

withDescription

setStatus

getStatus

withStatus

withStatus

setRoleArn

getRoleArn

withRoleArn

setErrorMessage

getErrorMessage

withErrorMessage

toString

equals

hashCode

clone