DescribeFaqResult (AWS SDK for Java

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

All Implemented Interfaces:: Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeFaqResult()

Constructors
Constructor and Description
`DescribeFaqResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeFaqResult`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreatedAt()` The Unix timestamp when the FAQ was created.
`String`	`getDescription()` The description of the FAQ that you provided when it was created.
`String`	`getErrorMessage()` If the `Status` field is `FAILED`, the `ErrorMessage` field contains the reason why the FAQ failed.
`String`	`getFileFormat()` The file format used by the input files for the FAQ.
`String`	`getId()` The identifier of the FAQ.
`String`	`getIndexId()` The identifier of the index for the FAQ.
`String`	`getLanguageCode()` The code for a language.
`String`	`getName()` The name that you gave the FAQ when it was created.
`String`	`getRoleArn()` The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.
`S3Path`	`getS3Path()`
`String`	`getStatus()` The status of the FAQ.
`Date`	`getUpdatedAt()` The Unix timestamp when the FAQ was last updated.
`int`	`hashCode()`
`void`	`setCreatedAt(Date createdAt)` The Unix timestamp when the FAQ was created.
`void`	`setDescription(String description)` The description of the FAQ that you provided when it was created.
`void`	`setErrorMessage(String errorMessage)` If the `Status` field is `FAILED`, the `ErrorMessage` field contains the reason why the FAQ failed.
`void`	`setFileFormat(String fileFormat)` The file format used by the input files for the FAQ.
`void`	`setId(String id)` The identifier of the FAQ.
`void`	`setIndexId(String indexId)` The identifier of the index for the FAQ.
`void`	`setLanguageCode(String languageCode)` The code for a language.
`void`	`setName(String name)` The name that you gave the FAQ when it was created.
`void`	`setRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.
`void`	`setS3Path(S3Path s3Path)`
`void`	`setStatus(String status)` The status of the FAQ.
`void`	`setUpdatedAt(Date updatedAt)` The Unix timestamp when the FAQ was last updated.
`String`	`toString()` Returns a string representation of this object.
`DescribeFaqResult`	`withCreatedAt(Date createdAt)` The Unix timestamp when the FAQ was created.
`DescribeFaqResult`	`withDescription(String description)` The description of the FAQ that you provided when it was created.
`DescribeFaqResult`	`withErrorMessage(String errorMessage)` If the `Status` field is `FAILED`, the `ErrorMessage` field contains the reason why the FAQ failed.
`DescribeFaqResult`	`withFileFormat(FaqFileFormat fileFormat)` The file format used by the input files for the FAQ.
`DescribeFaqResult`	`withFileFormat(String fileFormat)` The file format used by the input files for the FAQ.
`DescribeFaqResult`	`withId(String id)` The identifier of the FAQ.
`DescribeFaqResult`	`withIndexId(String indexId)` The identifier of the index for the FAQ.
`DescribeFaqResult`	`withLanguageCode(String languageCode)` The code for a language.
`DescribeFaqResult`	`withName(String name)` The name that you gave the FAQ when it was created.
`DescribeFaqResult`	`withRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.
`DescribeFaqResult`	`withS3Path(S3Path s3Path)`
`DescribeFaqResult`	`withStatus(FaqStatus status)` The status of the FAQ.
`DescribeFaqResult`	`withStatus(String status)` The status of the FAQ.
`DescribeFaqResult`	`withUpdatedAt(Date updatedAt)` The Unix timestamp when the FAQ 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
  - DescribeFaqResult
```
public DescribeFaqResult()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The identifier of the FAQ.
    
    Parameters:
    
    id - The identifier of the FAQ.
  - getId
```
public String getId()
```
    The identifier of the FAQ.
    
    Returns:
    
    The identifier of the FAQ.
  - withId
```
public DescribeFaqResult withId(String id)
```
    The identifier of the FAQ.
    
    Parameters:
    
    id - The identifier of the FAQ.
    
    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 index for the FAQ.
    
    Parameters:
    
    indexId - The identifier of the index for the FAQ.
  - getIndexId
```
public String getIndexId()
```
    The identifier of the index for the FAQ.
    
    Returns:
    
    The identifier of the index for the FAQ.
  - withIndexId
```
public DescribeFaqResult withIndexId(String indexId)
```
    The identifier of the index for the FAQ.
    
    Parameters:
    
    indexId - The identifier of the index for the FAQ.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name that you gave the FAQ when it was created.
    
    Parameters:
    
    name - The name that you gave the FAQ when it was created.
  - getName
```
public String getName()
```
    The name that you gave the FAQ when it was created.
    
    Returns:
    
    The name that you gave the FAQ when it was created.
  - withName
```
public DescribeFaqResult withName(String name)
```
    The name that you gave the FAQ when it was created.
    
    Parameters:
    
    name - The name that you gave the FAQ when it 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 of the FAQ that you provided when it was created.
    
    Parameters:
    
    description - The description of the FAQ that you provided when it was created.
  - getDescription
```
public String getDescription()
```
    The description of the FAQ that you provided when it was created.
    
    Returns:
    
    The description of the FAQ that you provided when it was created.
  - withDescription
```
public DescribeFaqResult withDescription(String description)
```
    The description of the FAQ that you provided when it was created.
    
    Parameters:
    
    description - The description of the FAQ that you provided when it was created.
    
    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 FAQ was created.
    
    Parameters:
    
    createdAt - The Unix timestamp when the FAQ was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The Unix timestamp when the FAQ was created.
    
    Returns:
    
    The Unix timestamp when the FAQ was created.
  - withCreatedAt
```
public DescribeFaqResult withCreatedAt(Date createdAt)
```
    The Unix timestamp when the FAQ was created.
    
    Parameters:
    
    createdAt - The Unix timestamp when the FAQ 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 FAQ was last updated.
    
    Parameters:
    
    updatedAt - The Unix timestamp when the FAQ was last updated.
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    The Unix timestamp when the FAQ was last updated.
    
    Returns:
    
    The Unix timestamp when the FAQ was last updated.
  - withUpdatedAt
```
public DescribeFaqResult withUpdatedAt(Date updatedAt)
```
    The Unix timestamp when the FAQ was last updated.
    
    Parameters:
    
    updatedAt - The Unix timestamp when the FAQ was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3Path
```
public void setS3Path(S3Path s3Path)
```
    Parameters:
    
    s3Path -
  - getS3Path
```
public S3Path getS3Path()
```
    Returns:
  - withS3Path
```
public DescribeFaqResult withS3Path(S3Path s3Path)
```
    Parameters:
    
    s3Path -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the FAQ. It is ready to use when the status is ACTIVE.
    
    Parameters:
    
    status - The status of the FAQ. It is ready to use when the status is ACTIVE.
    
    See Also:
    
    FaqStatus
  - getStatus
```
public String getStatus()
```
    The status of the FAQ. It is ready to use when the status is ACTIVE.
    
    Returns:
    
    The status of the FAQ. It is ready to use when the status is ACTIVE.
    
    See Also:
    
    FaqStatus
  - withStatus
```
public DescribeFaqResult withStatus(String status)
```
    The status of the FAQ. It is ready to use when the status is ACTIVE.
    
    Parameters:
    
    status - The status of the FAQ. It is ready to use when the status is ACTIVE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FaqStatus
  - withStatus
```
public DescribeFaqResult withStatus(FaqStatus status)
```
    The status of the FAQ. It is ready to use when the status is ACTIVE.
    
    Parameters:
    
    status - The status of the FAQ. It is ready to use when the status is ACTIVE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FaqStatus
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.
  - getRoleArn
```
public String getRoleArn()
```
    The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.
  - withRoleArn
```
public DescribeFaqResult withRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorMessage
```
public void setErrorMessage(String errorMessage)
```
    If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.
    
    Parameters:
    
    errorMessage - If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.
  - getErrorMessage
```
public String getErrorMessage()
```
    If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.
    
    Returns:
    
    If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.
  - withErrorMessage
```
public DescribeFaqResult withErrorMessage(String errorMessage)
```
    If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.
    
    Parameters:
    
    errorMessage - If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFileFormat
```
public void setFileFormat(String fileFormat)
```
    The file format used by the input files for the FAQ.
    
    Parameters:
    
    fileFormat - The file format used by the input files for the FAQ.
    
    See Also:
    
    FaqFileFormat
  - getFileFormat
```
public String getFileFormat()
```
    The file format used by the input files for the FAQ.
    
    Returns:
    
    The file format used by the input files for the FAQ.
    
    See Also:
    
    FaqFileFormat
  - withFileFormat
```
public DescribeFaqResult withFileFormat(String fileFormat)
```
    The file format used by the input files for the FAQ.
    
    Parameters:
    
    fileFormat - The file format used by the input files for the FAQ.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FaqFileFormat
  - withFileFormat
```
public DescribeFaqResult withFileFormat(FaqFileFormat fileFormat)
```
    The file format used by the input files for the FAQ.
    
    Parameters:
    
    fileFormat - The file format used by the input files for the FAQ.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FaqFileFormat
  - setLanguageCode
```
public void setLanguageCode(String languageCode)
```
    The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
    
    Parameters:
    
    languageCode - The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
  - getLanguageCode
```
public String getLanguageCode()
```
    The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
    
    Returns:
    
    The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
  - withLanguageCode
```
public DescribeFaqResult withLanguageCode(String languageCode)
```
    The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
    
    Parameters:
    
    languageCode - The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
    
    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 DescribeFaqResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.780

Class DescribeFaqResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeFaqResult

Method Detail

setId

getId

withId

setIndexId

getIndexId

withIndexId

setName

getName

withName

setDescription

getDescription

withDescription

setCreatedAt

getCreatedAt

withCreatedAt

setUpdatedAt

getUpdatedAt

withUpdatedAt

setS3Path

getS3Path

withS3Path

setStatus

getStatus

withStatus

withStatus

setRoleArn

getRoleArn

withRoleArn

setErrorMessage

getErrorMessage

withErrorMessage

setFileFormat

getFileFormat

withFileFormat

withFileFormat

setLanguageCode

getLanguageCode

withLanguageCode

toString

equals

hashCode

clone