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

Class PersonasSummary

java.lang.Object

software.amazon.awssdk.services.kendra.model.PersonasSummary

All Implemented Interfaces:

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

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

Summary information for users or groups in your IAM Identity Center identity source. This applies to users and groups with specific permissions that define their level of 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	PersonasSummary.Builder

Method Summary

Modifier and Type	Method	Description
static PersonasSummary.Builder	builder()
Instant	createdAt()	The Unix timestamp when the summary information was created.
String	entityId()	The identifier of a user or group in your IAM Identity Center identity source.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Persona	persona()	The persona that defines the specific permissions of the user or group in your IAM Identity Center identity source.
String	personaAsString()	The persona that defines the specific permissions of the user or group in your IAM Identity Center identity source.
List<SdkField<?>>	sdkFields()
static Class<? extends PersonasSummary.Builder>	serializableBuilderClass()
PersonasSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	updatedAt()	The Unix timestamp when the summary information was last updated.

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.

persona

public final Persona persona()

The persona that defines the specific permissions of the user or group in your IAM Identity Center identity source. The available personas or access roles are Owner and Viewer. For more information on these personas, see Providing access to your search page.

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

Returns:

The persona that defines the specific permissions of the user or group in your IAM Identity Center identity source. The available personas or access roles are Owner and Viewer. For more information on these personas, see Providing access to your search page.

See Also:

Persona

personaAsString

public final String personaAsString()

The persona that defines the specific permissions of the user or group in your IAM Identity Center identity source. The available personas or access roles are Owner and Viewer. For more information on these personas, see Providing access to your search page.

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

Returns:

The persona that defines the specific permissions of the user or group in your IAM Identity Center identity source. The available personas or access roles are Owner and Viewer. For more information on these personas, see Providing access to your search page.

See Also:

Persona

createdAt

public final Instant createdAt()

The Unix timestamp when the summary information was created.

Returns:

The Unix timestamp when the summary information was created.

updatedAt

public final Instant updatedAt()

The Unix timestamp when the summary information was last updated.

Returns:

The Unix timestamp when the summary information was last updated.

toBuilder

public PersonasSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PersonasSummary.Builder,PersonasSummary>

builder

public static PersonasSummary.Builder builder()

serializableBuilderClass

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