Class DescribeFaqResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeFaqResponse.Builder,
DescribeFaqResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DescribeFaqResponse.Builder
builder()
final Instant
The Unix timestamp when the FAQ was created.final String
The description of the FAQ that you provided when it was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
If theStatus
field isFAILED
, theErrorMessage
field contains the reason why the FAQ failed.final FaqFileFormat
The file format used by the input files for the FAQ.final String
The file format used by the input files for the FAQ.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final String
id()
The identifier of the FAQ.final String
indexId()
The identifier of the index for the FAQ.final String
The code for a language.final String
name()
The name that you gave the FAQ when it was created.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.final S3Path
s3Path()
Returns the value of the S3Path property for this object.static Class
<? extends DescribeFaqResponse.Builder> final FaqStatus
status()
The status of the FAQ.final String
The status of the FAQ.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Instant
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The identifier of the FAQ.
- Returns:
- The identifier of the FAQ.
-
indexId
The identifier of the index for the FAQ.
- Returns:
- The identifier of the index for the FAQ.
-
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
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
The Unix timestamp when the FAQ was created.
- Returns:
- The Unix timestamp when the FAQ was created.
-
updatedAt
The Unix timestamp when the FAQ was last updated.
- Returns:
- The Unix timestamp when the FAQ was last updated.
-
s3Path
Returns the value of the S3Path property for this object.- Returns:
- The value of the S3Path property for this object.
-
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 returnFaqStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the FAQ. It is ready to use when the status is
ACTIVE
. - See Also:
-
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 returnFaqStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the FAQ. It is ready to use when the status is
ACTIVE
. - 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.
- Returns:
- The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.
-
errorMessage
If the
Status
field isFAILED
, theErrorMessage
field contains the reason why the FAQ failed.- Returns:
- If the
Status
field isFAILED
, theErrorMessage
field contains the reason why the FAQ failed.
-
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 returnFaqFileFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfileFormatAsString()
.- Returns:
- The file format used by the input files for the FAQ.
- See Also:
-
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 returnFaqFileFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfileFormatAsString()
.- Returns:
- The file format used by the input files for the FAQ.
- 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.
- 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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeFaqResponse.Builder,
DescribeFaqResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-