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

Class FaqSummary

java.lang.Object

software.amazon.awssdk.services.kendra.model.FaqSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FaqSummary.Builder,FaqSummary>

@Generated("software.amazon.awssdk:codegen")
public final class FaqSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FaqSummary.Builder,FaqSummary>

Summary information for frequently asked questions and answers included in an index.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FaqSummary.Builder

Method Summary

Modifier and Type	Method	Description
static FaqSummary.Builder	builder()
Instant	createdAt()	The Unix timestamp when the FAQ was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FaqFileFormat	fileFormat()	The file type used to create the FAQ.
String	fileFormatAsString()	The file type used to create the FAQ.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The identifier of the FAQ.
String	languageCode()	The code for a language.
String	name()	The name that you assigned the FAQ when you created or updated the FAQ.
List<SdkField<?>>	sdkFields()
static Class<? extends FaqSummary.Builder>	serializableBuilderClass()
FaqStatus	status()	The current status of the FAQ.
String	statusAsString()	The current status of the FAQ.
FaqSummary.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 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.

name

public final String name()

The name that you assigned the FAQ when you created or updated the FAQ.

Returns:

The name that you assigned the FAQ when you created or updated the FAQ.

status

public final FaqStatus status()

The current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.

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 current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.

See Also:

FaqStatus

statusAsString

public final String statusAsString()

The current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.

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 current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.

See Also:

FaqStatus

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.

fileFormat

public final FaqFileFormat fileFormat()

The file type used to create 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 type used to create the FAQ.

See Also:

FaqFileFormat

fileFormatAsString

public final String fileFormatAsString()

The file type used to create 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 type used to create the FAQ.

See Also:

FaqFileFormat

languageCode

public final String languageCode()

The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. 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 as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

toBuilder

public FaqSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FaqSummary.Builder,FaqSummary>

builder

public static FaqSummary.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo