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

Class ExperienceEntitiesSummary

java.lang.Object

software.amazon.awssdk.services.kendra.model.ExperienceEntitiesSummary

All Implemented Interfaces:

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

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

Summary information for users or groups in your IAM Identity Center identity source with granted access to 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	ExperienceEntitiesSummary.Builder

Method Summary

Modifier and Type	Method	Description
static ExperienceEntitiesSummary.Builder	builder()
EntityDisplayData	displayData()	Information about the user entity.
String	entityId()	The identifier of a user or group in your IAM Identity Center identity source.
EntityType	entityType()	Shows the type as User or Group.
String	entityTypeAsString()	Shows the type as User or Group.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ExperienceEntitiesSummary.Builder>	serializableBuilderClass()
ExperienceEntitiesSummary.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

entityId

public final String entityId()

The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

Returns:

The identifier of a user or group in your IAM Identity Center identity source. For example, a user ID could be an email.

entityType

public final EntityType entityType()

Shows the type as User or Group.

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

Returns:

Shows the type as User or Group.

See Also:

EntityType

entityTypeAsString

public final String entityTypeAsString()

Shows the type as User or Group.

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

Returns:

Shows the type as User or Group.

See Also:

EntityType

displayData

public final EntityDisplayData displayData()

Information about the user entity.

Returns:

Information about the user entity.

toBuilder

public ExperienceEntitiesSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExperienceEntitiesSummary.Builder,ExperienceEntitiesSummary>

builder

public static ExperienceEntitiesSummary.Builder builder()

serializableBuilderClass

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