Interface DescribeFaqResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<DescribeFaqResponse.Builder,
,DescribeFaqResponse> KendraResponse.Builder
,SdkBuilder<DescribeFaqResponse.Builder,
,DescribeFaqResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeFaqResponse
-
Method Summary
Modifier and TypeMethodDescriptionThe Unix timestamp when the FAQ was created.description
(String description) The description of the FAQ that you provided when it was created.errorMessage
(String errorMessage) If theStatus
field isFAILED
, theErrorMessage
field contains the reason why the FAQ failed.fileFormat
(String fileFormat) The file format used by the input files for the FAQ.fileFormat
(FaqFileFormat fileFormat) The file format used by the input files for the FAQ.The identifier of the FAQ.The identifier of the index for the FAQ.languageCode
(String languageCode) The code for a language.The name that you gave the FAQ when it was created.The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.default DescribeFaqResponse.Builder
s3Path
(Consumer<S3Path.Builder> s3Path) Sets the value of the S3Path property for this object.Sets the value of the S3Path property for this object.The status of the FAQ.The status of the FAQ.The Unix timestamp when the FAQ was last updated.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
s3Path
Sets the value of the S3Path property for this object.- Parameters:
s3Path
- The new value for the S3Path property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3Path
Sets the value of the S3Path property for this object. This is a convenience method that creates an instance of theS3Path.Builder
avoiding the need to create one manually viaS3Path.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tos3Path(S3Path)
.- Parameters:
s3Path
- a consumer that will call methods onS3Path.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 isACTIVE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 isACTIVE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
errorMessage
If the
Status
field isFAILED
, theErrorMessage
field contains the reason why the FAQ failed.- Parameters:
errorMessage
- If theStatus
field isFAILED
, theErrorMessage
field contains the reason why the FAQ failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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:
-
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:
-
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.
-