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

Class DescribeExperienceResponse

    • Method Detail

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

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

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

      • 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