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

Class AssociatePersonasToEntitiesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kendra.model.KendraRequest

software.amazon.awssdk.services.kendra.model.AssociatePersonasToEntitiesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AssociatePersonasToEntitiesRequest.Builder,AssociatePersonasToEntitiesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class AssociatePersonasToEntitiesRequest
extends KendraRequest
implements ToCopyableBuilder<AssociatePersonasToEntitiesRequest.Builder,AssociatePersonasToEntitiesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AssociatePersonasToEntitiesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static AssociatePersonasToEntitiesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPersonas()	For responses, this returns true if the service returned a value for the Personas property.
String	id()	The identifier of your Amazon Kendra experience.
String	indexId()	The identifier of the index for your Amazon Kendra experience.
List<EntityPersonaConfiguration>	personas()	The personas that define the specific permissions of users or groups in your IAM Identity Center identity source.
List<SdkField<?>>	sdkFields()
static Class<? extends AssociatePersonasToEntitiesRequest.Builder>	serializableBuilderClass()
AssociatePersonasToEntitiesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

The identifier of your Amazon Kendra experience.

Returns:

The identifier of your Amazon Kendra experience.

indexId

public final String indexId()

The identifier of the index for your Amazon Kendra experience.

Returns:

The identifier of the index for your Amazon Kendra experience.

hasPersonas

public final boolean hasPersonas()

For responses, this returns true if the service returned a value for the Personas 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.

personas

public final List<EntityPersonaConfiguration> personas()

The personas that define the specific permissions of users or groups 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.

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 hasPersonas() method.

Returns:

The personas that define the specific permissions of users or groups 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.

toBuilder

public AssociatePersonasToEntitiesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssociatePersonasToEntitiesRequest.Builder,AssociatePersonasToEntitiesRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static AssociatePersonasToEntitiesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo