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

Class ExperiencesSummary

java.lang.Object

software.amazon.awssdk.services.kendra.model.ExperiencesSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ExperiencesSummary.Builder,ExperiencesSummary>

@Generated("software.amazon.awssdk:codegen")
public final class ExperiencesSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ExperiencesSummary.Builder,ExperiencesSummary>

Summary information for your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExperiencesSummary.Builder

Method Summary

Modifier and Type	Method	Description
static ExperiencesSummary.Builder	builder()
Instant	createdAt()	The Unix timestamp when your Amazon Kendra experience was created.
List<ExperienceEndpoint>	endpoints()	The endpoint URLs for your Amazon Kendra experiences.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<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()	The identifier of your Amazon Kendra experience.
String	name()	The name of your Amazon Kendra experience.
List<SdkField<?>>	sdkFields()
static Class<? extends ExperiencesSummary.Builder>	serializableBuilderClass()
ExperienceStatus	status()	The processing status of your Amazon Kendra experience.
String	statusAsString()	The processing status of your Amazon Kendra experience.
ExperiencesSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

name

public final String name()

The name of your Amazon Kendra experience.

Returns:

The name of your Amazon Kendra experience.

id

public final String id()

The identifier of your Amazon Kendra experience.

Returns:

The identifier of 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.

status

public final ExperienceStatus status()

The processing status of your Amazon Kendra experience.

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 processing status of your Amazon Kendra experience.

See Also:

ExperienceStatus

statusAsString

public final String statusAsString()

The processing status of your Amazon Kendra experience.

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 processing status of your Amazon Kendra experience.

See Also:

ExperienceStatus

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()

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:

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

toBuilder

public ExperiencesSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExperiencesSummary.Builder,ExperiencesSummary>

builder

public static ExperiencesSummary.Builder builder()

serializableBuilderClass

public static Class<? extends ExperiencesSummary.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo