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("software.amazon.awssdk:codegen") public final class DescribeFaqResponse extends KendraResponse implements ToCopyableBuilder<DescribeFaqResponse.Builder,DescribeFaqResponse>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<DescribeFaqResponse.Builder,DescribeFaqResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.