Package software.amazon.awssdk.services.kendra.model

Interface DescribeFaqResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeFaqResponse.Builder,DescribeFaqResponse>, KendraResponse.Builder, SdkBuilder<DescribeFaqResponse.Builder,DescribeFaqResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeFaqResponse

public static interface DescribeFaqResponse.Builder
extends KendraResponse.Builder, SdkPojo, CopyableBuilder<DescribeFaqResponse.Builder,DescribeFaqResponse>

Method Summary

Modifier and Type	Method	Description
DescribeFaqResponse.Builder	createdAt(Instant createdAt)	The Unix timestamp when the FAQ was created.
DescribeFaqResponse.Builder	description(String description)	The description of the FAQ that you provided when it was created.
DescribeFaqResponse.Builder	errorMessage(String errorMessage)	If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.
DescribeFaqResponse.Builder	fileFormat(String fileFormat)	The file format used by the input files for the FAQ.
DescribeFaqResponse.Builder	fileFormat(FaqFileFormat fileFormat)	The file format used by the input files for the FAQ.
DescribeFaqResponse.Builder	id(String id)	The identifier of the FAQ.
DescribeFaqResponse.Builder	indexId(String indexId)	The identifier of the index for the FAQ.
DescribeFaqResponse.Builder	languageCode(String languageCode)	The code for a language.
DescribeFaqResponse.Builder	name(String name)	The name that you gave the FAQ when it was created.
DescribeFaqResponse.Builder	roleArn(String roleArn)	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.
DescribeFaqResponse.Builder	s3Path(S3Path s3Path)	Sets the value of the S3Path property for this object.
DescribeFaqResponse.Builder	status(String status)	The status of the FAQ.
DescribeFaqResponse.Builder	status(FaqStatus status)	The status of the FAQ.
DescribeFaqResponse.Builder	updatedAt(Instant updatedAt)	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 Detail

id

DescribeFaqResponse.Builder id(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.

indexId

DescribeFaqResponse.Builder indexId(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.

name

DescribeFaqResponse.Builder name(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.

description

DescribeFaqResponse.Builder description(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.

createdAt

DescribeFaqResponse.Builder createdAt(Instant 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

DescribeFaqResponse.Builder updatedAt(Instant 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

DescribeFaqResponse.Builder s3Path(S3Path 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

default DescribeFaqResponse.Builder s3Path(Consumer<S3Path.Builder> s3Path)

Sets the value of the S3Path property for this object. This is a convenience method that creates an instance of the S3Path.Builder avoiding the need to create one manually via S3Path.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3Path(S3Path).

Parameters:

s3Path - a consumer that will call methods on S3Path.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

s3Path(S3Path)

status

DescribeFaqResponse.Builder status(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, FaqStatus

status

DescribeFaqResponse.Builder status(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, FaqStatus

roleArn

DescribeFaqResponse.Builder roleArn(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.

errorMessage

DescribeFaqResponse.Builder errorMessage(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.

fileFormat

DescribeFaqResponse.Builder fileFormat(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, FaqFileFormat

fileFormat

DescribeFaqResponse.Builder fileFormat(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, FaqFileFormat

languageCode

DescribeFaqResponse.Builder languageCode(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.