software.amazon.awssdk.services.kendra.model

Class EntityConfiguration

java.lang.Object

software.amazon.awssdk.services.kendra.model.EntityConfiguration

All Implemented Interfaces:

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

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

Provides the configuration information for users or groups in your IAM Identity Center identity source to grant access your Amazon Kendra experience.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EntityConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static EntityConfiguration.Builder	builder()
String	entityId() The identifier of a user or group in your IAM Identity Center identity source.
EntityType	entityType() Specifies whether you are configuring a User or a Group.
String	entityTypeAsString() Specifies whether you are configuring a User or a 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 EntityConfiguration.Builder>	serializableBuilderClass()
EntityConfiguration.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()

Specifies whether you are configuring a User or a 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:

Specifies whether you are configuring a User or a Group.

See Also:

EntityType

entityTypeAsString

public final String entityTypeAsString()

Specifies whether you are configuring a User or a 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:

Specifies whether you are configuring a User or a Group.

See Also:

EntityType

toBuilder

public EntityConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EntityConfiguration.Builder,EntityConfiguration>

builder

public static EntityConfiguration.Builder builder()

serializableBuilderClass

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