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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeExperienceResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeExperienceResponse.Builder	builder()
ExperienceConfiguration	configuration() Shows the configuration information for your Amazon Kendra experience.
Instant	createdAt() The Unix timestamp when your Amazon Kendra experience was created.
String	description() Shows the description for your Amazon Kendra experience.
List<ExperienceEndpoint>	endpoints() Shows the endpoint URLs for your Amazon Kendra experiences.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	errorMessage() The reason your Amazon Kendra experience could not properly process.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEndpoints() For responses, this returns true if the service returned a value for the Endpoints property.
int	hashCode()
String	id() Shows the identifier of your Amazon Kendra experience.
String	indexId() Shows the identifier of the index for your Amazon Kendra experience.
String	name() Shows the name of your Amazon Kendra experience.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeExperienceResponse.Builder>	serializableBuilderClass()
ExperienceStatus	status() The current processing status of your Amazon Kendra experience.
String	statusAsString() The current processing status of your Amazon Kendra experience.
DescribeExperienceResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	updatedAt() The Unix timestamp when your Amazon Kendra experience 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 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()

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.

toBuilder

public DescribeExperienceResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeExperienceResponse.Builder,DescribeExperienceResponse>

Overrides:

toBuilder in class AwsResponse

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)

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo