software.amazon.awssdk.services.kendra.model

Class DescribeFaqResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.kendra.model.KendraResponse

software.amazon.awssdk.services.kendra.model.DescribeFaqResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeFaqResponse.Builder,DescribeFaqResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeFaqResponse
extends KendraResponse
implements ToCopyableBuilder<DescribeFaqResponse.Builder,DescribeFaqResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeFaqResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeFaqResponse.Builder	builder()
Instant	createdAt() The Unix timestamp when the FAQ was created.
String	description() The description of the FAQ that you provided when it was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	errorMessage() If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.
FaqFileFormat	fileFormat() The file format used by the input files for the FAQ.
String	fileFormatAsString() The file format used by the input files for the FAQ.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The identifier of the FAQ.
String	indexId() The identifier of the index for the FAQ.
String	languageCode() The code for a language.
String	name() The name that you gave the FAQ when it was created.
String	roleArn() The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.
S3Path	s3Path() Returns the value of the S3Path property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeFaqResponse.Builder>	serializableBuilderClass()
FaqStatus	status() The status of the FAQ.
String	statusAsString() The status of the FAQ.
DescribeFaqResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	updatedAt() The Unix timestamp when the FAQ was last updated.

Methods inherited from class software.amazon.awssdk.services.kendra.model.KendraResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

id

public final String id()

The identifier of the FAQ.

Returns:

The identifier of the FAQ.

indexId

public final String indexId()

The identifier of the index for the FAQ.

Returns:

The identifier of the index for the FAQ.

name

public final String name()

The name that you gave the FAQ when it was created.

Returns:

The name that you gave the FAQ when it was created.

description

public final String description()

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.

createdAt

public final Instant createdAt()

The Unix timestamp when the FAQ was created.

Returns:

The Unix timestamp when the FAQ was created.

updatedAt

public final Instant updatedAt()

The Unix timestamp when the FAQ was last updated.

Returns:

The Unix timestamp when the FAQ was last updated.

s3Path

public final S3Path s3Path()

Returns the value of the S3Path property for this object.

Returns:

The value of the S3Path property for this object.

status

public final FaqStatus status()

The status of the FAQ. It is ready to use when the status is ACTIVE.

If the service returns an enum value that is not available in the current SDK version, status will return FaqStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the FAQ. It is ready to use when the status is ACTIVE.

See Also:

FaqStatus

statusAsString

public final String statusAsString()

The status of the FAQ. It is ready to use when the status is ACTIVE.

If the service returns an enum value that is not available in the current SDK version, status will return FaqStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the FAQ. It is ready to use when the status is ACTIVE.

See Also:

FaqStatus

roleArn

public final String roleArn()

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.

errorMessage

public final String errorMessage()

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.

fileFormat

public final FaqFileFormat fileFormat()

The file format used by the input files for the FAQ.

If the service returns an enum value that is not available in the current SDK version, fileFormat will return FaqFileFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileFormatAsString().

Returns:

The file format used by the input files for the FAQ.

See Also:

FaqFileFormat

fileFormatAsString

public final String fileFormatAsString()

The file format used by the input files for the FAQ.

If the service returns an enum value that is not available in the current SDK version, fileFormat will return FaqFileFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileFormatAsString().

Returns:

The file format used by the input files for the FAQ.

See Also:

FaqFileFormat

languageCode

public final 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.

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.

toBuilder

public DescribeFaqResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeFaqResponse.Builder,DescribeFaqResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeFaqResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeFaqResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo