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

Class DescribeExperienceResponse

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.DescribeExperienceResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeExperienceResponse.Builder,DescribeExperienceResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeExperienceResponse extends KendraResponse implements ToCopyableBuilder<DescribeExperienceResponse.Builder,DescribeExperienceResponse>

  • Method Details

    • id

      public final String id()

      Shows the identifier of your Amazon Kendra experience.

      Returns:
      Shows the identifier of your Amazon Kendra experience.

    • indexId

      public final String indexId()

      Shows the identifier of the index for your Amazon Kendra experience.

      Returns:
      Shows the identifier of the index for your Amazon Kendra experience.

    • name

      public final String name()

      Shows the name of your Amazon Kendra experience.

      Returns:
      Shows the name of your Amazon Kendra experience.

    • hasEndpoints

      public final boolean hasEndpoints()
      For responses, this returns true if the service returned a value for the Endpoints property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • endpoints

      public final List<ExperienceEndpoint> endpoints()

      Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEndpoints() method.

      Returns:
      Shows the endpoint URLs for your Amazon Kendra experiences. The URLs are unique and fully hosted by Amazon Web Services.

    • configuration

      public final ExperienceConfiguration configuration()

      Shows the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.

      Returns:
      Shows the configuration information for your Amazon Kendra experience. This includes ContentSourceConfiguration, which specifies the data source IDs and/or FAQ IDs, and UserIdentityConfiguration, which specifies the user or group information to grant access to your Amazon Kendra experience.

    • createdAt

      public final Instant createdAt()

      The Unix timestamp when your Amazon Kendra experience was created.

      Returns:
      The Unix timestamp when your Amazon Kendra experience was created.

    • updatedAt

      public final Instant updatedAt()

      The Unix timestamp when your Amazon Kendra experience was last updated.

      Returns:
      The Unix timestamp when your Amazon Kendra experience was last updated.

    • description

      public final String description()

      Shows the description for your Amazon Kendra experience.

      Returns:
      Shows the description for your Amazon Kendra experience.

    • status

      public final ExperienceStatus status()

      The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.

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

      Returns:
      The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.

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

      Returns:
      The current processing status of your Amazon Kendra experience. When the status is ACTIVE, your Amazon Kendra experience is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that this failed.
      See Also:

    • roleArn

      public final String roleArn()

      Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your user and group information.

      Returns:
      Shows the Amazon Resource Name (ARN) of a role with permission to access Query API, QuerySuggestions API, SubmitFeedback API, and IAM Identity Center that stores your user and group information.

    • errorMessage

      public final String errorMessage()

      The reason your Amazon Kendra experience could not properly process.

      Returns:
      The reason your Amazon Kendra experience could not properly process.

    • toBuilder

      public DescribeExperienceResponse.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<DescribeExperienceResponse.Builder,DescribeExperienceResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeExperienceResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeExperienceResponse.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.