com.amazonaws.services.kendra.model

Class PutPrincipalMappingRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.model.PutPrincipalMappingRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutPrincipalMappingRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutPrincipalMappingRequest()

Method Summary

Modifier and Type	Method and Description
PutPrincipalMappingRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDataSourceId() The identifier of the data source you want to map users to their groups.
String	getGroupId() The identifier of the group you want to map its users to.
GroupMembers	getGroupMembers() The list that contains your users or sub groups that belong the same group.
String	getIndexId() The identifier of the index you want to map users to their groups.
Long	getOrderingId() The timestamp identifier you specify to ensure Amazon Kendra does not override the latest PUT action with previous actions.
String	getRoleArn() 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.
int	hashCode()
void	setDataSourceId(String dataSourceId) The identifier of the data source you want to map users to their groups.
void	setGroupId(String groupId) The identifier of the group you want to map its users to.
void	setGroupMembers(GroupMembers groupMembers) The list that contains your users or sub groups that belong the same group.
void	setIndexId(String indexId) The identifier of the index you want to map users to their groups.
void	setOrderingId(Long orderingId) The timestamp identifier you specify to ensure Amazon Kendra does not override the latest PUT action with previous actions.
void	setRoleArn(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.
String	toString() Returns a string representation of this object.
PutPrincipalMappingRequest	withDataSourceId(String dataSourceId) The identifier of the data source you want to map users to their groups.
PutPrincipalMappingRequest	withGroupId(String groupId) The identifier of the group you want to map its users to.
PutPrincipalMappingRequest	withGroupMembers(GroupMembers groupMembers) The list that contains your users or sub groups that belong the same group.
PutPrincipalMappingRequest	withIndexId(String indexId) The identifier of the index you want to map users to their groups.
PutPrincipalMappingRequest	withOrderingId(Long orderingId) The timestamp identifier you specify to ensure Amazon Kendra does not override the latest PUT action with previous actions.
PutPrincipalMappingRequest	withRoleArn(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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutPrincipalMappingRequest

public PutPrincipalMappingRequest()

Method Detail

setIndexId

public void setIndexId(String indexId)

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

Parameters:

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

getIndexId

public String getIndexId()

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.

withIndexId

public PutPrincipalMappingRequest withIndexId(String indexId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setDataSourceId

public void setDataSourceId(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.

Parameters:

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.

getDataSourceId

public String getDataSourceId()

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.

withDataSourceId

public PutPrincipalMappingRequest withDataSourceId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setGroupId

public void setGroupId(String groupId)

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

Parameters:

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

getGroupId

public String getGroupId()

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.

withGroupId

public PutPrincipalMappingRequest withGroupId(String groupId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setGroupMembers

public void setGroupMembers(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.

Parameters:

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.

getGroupMembers

public GroupMembers getGroupMembers()

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.

withGroupMembers

public PutPrincipalMappingRequest withGroupMembers(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setOrderingId

public void setOrderingId(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.

Parameters:

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.

getOrderingId

public Long getOrderingId()

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.

withOrderingId

public PutPrincipalMappingRequest withOrderingId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setRoleArn

public void setRoleArn(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.

Parameters:

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.

getRoleArn

public String getRoleArn()

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.

withRoleArn

public PutPrincipalMappingRequest withRoleArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PutPrincipalMappingRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()