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

Class DeletePrincipalMappingRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeletePrincipalMappingRequest.Builder,DeletePrincipalMappingRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeletePrincipalMappingRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DeletePrincipalMappingRequest.Builder	builder()
String	dataSourceId()	The identifier of the data source you want to delete a group from.
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 delete.
int	hashCode()
String	indexId()	The identifier of the index you want to delete a group from.
Long	orderingId()	The timestamp identifier you specify to ensure Amazon Kendra does not override the latest DELETE action with previous actions.
List<SdkField<?>>	sdkFields()
static Class<? extends DeletePrincipalMappingRequest.Builder>	serializableBuilderClass()
DeletePrincipalMappingRequest.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 delete a group from.

Returns:

The identifier of the index you want to delete a group from.

dataSourceId

public final String dataSourceId()

The identifier of the data source you want to delete a group from.

A group can be tied to multiple data sources. You can delete a group from accessing documents in 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. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.

Returns:

The identifier of the data source you want to delete a group from.

A group can be tied to multiple data sources. You can delete a group from accessing documents in 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. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.

groupId

public final String groupId()

The identifier of the group you want to delete.

Returns:

The identifier of the group you want to delete.

orderingId

public final Long orderingId()

The timestamp identifier you specify to ensure Amazon Kendra does not override the latest DELETE 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 DELETE action for that updated group with the latest members list doesn't get overwritten by earlier DELETE 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 DELETE 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 DELETE action for that updated group with the latest members list doesn't get overwritten by earlier DELETE 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.

toBuilder

public DeletePrincipalMappingRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeletePrincipalMappingRequest.Builder,DeletePrincipalMappingRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static DeletePrincipalMappingRequest.Builder builder()

serializableBuilderClass

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