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

Class PutPrincipalMappingRequest

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.PutPrincipalMappingRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutPrincipalMappingRequest.Builder,PutPrincipalMappingRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutPrincipalMappingRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutPrincipalMappingRequest.Builder	builder()
String	dataSourceId()	The identifier of the data source you want to map users to their groups.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	groupId()	The identifier of the group you want to map its users to.
GroupMembers	groupMembers()	The list that contains your users or sub groups that belong the same group.
int	hashCode()
String	indexId()	The identifier of the index you want to map users to their groups.
Long	orderingId()	The timestamp identifier you specify to ensure Amazon Kendra does not override the latest PUT action with previous actions.
String	roleArn()	The Amazon Resource Name (ARN) of a role that has access to the S3 file that contains your list of users or sub groups that belong to a group.
List<SdkField<?>>	sdkFields()
static Class<? extends PutPrincipalMappingRequest.Builder>	serializableBuilderClass()
PutPrincipalMappingRequest.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

indexId

public final String indexId()

The identifier of the index you want to map users to their groups.

Returns:

The identifier of the index you want to map users to their groups.

dataSourceId

public final String dataSourceId()

The identifier of the data source you want to map users to their groups.

This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.

Returns:

The identifier of the data source you want to map users to their groups.

This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.

groupId

public final String groupId()

The identifier of the group you want to map its users to.

Returns:

The identifier of the group you want to map its users to.

groupMembers

public final GroupMembers groupMembers()

The list that contains your users or sub groups that belong the same group.

For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".

If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

Returns:

The list that contains your users or sub groups that belong the same group.

For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".

If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

orderingId

public final Long orderingId()

The timestamp identifier you specify to ensure Amazon Kendra does not override the latest PUT action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.

The ordering ID can be the Unix time of the last update you made to a group members list. You would then provide this list when calling PutPrincipalMapping. This ensures your PUT action for that updated group with the latest members list doesn't get overwritten by earlier PUT actions for the same group which are yet to be processed.

The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra.

Returns:

The timestamp identifier you specify to ensure Amazon Kendra does not override the latest PUT action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.

The ordering ID can be the Unix time of the last update you made to a group members list. You would then provide this list when calling PutPrincipalMapping. This ensures your PUT action for that updated group with the latest members list doesn't get overwritten by earlier PUT actions for the same group which are yet to be processed.

The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of a role that has access to the S3 file that contains your list of users or sub groups that belong to a group.

For more information, see IAM roles for Amazon Kendra.

Returns:

The Amazon Resource Name (ARN) of a role that has access to the S3 file that contains your list of users or sub groups that belong to a group.

For more information, see IAM roles for Amazon Kendra.

toBuilder

public PutPrincipalMappingRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutPrincipalMappingRequest.Builder,PutPrincipalMappingRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static PutPrincipalMappingRequest.Builder builder()

serializableBuilderClass

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