Interface UpdateAccessControlConfigurationRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateAccessControlConfigurationRequest.Builder,UpdateAccessControlConfigurationRequest>, KendraRequest.Builder, SdkBuilder<UpdateAccessControlConfigurationRequest.Builder,UpdateAccessControlConfigurationRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateAccessControlConfigurationRequest

@Mutable
@NotThreadSafe
public static interface UpdateAccessControlConfigurationRequest.Builder
extends KendraRequest.Builder, SdkPojo, CopyableBuilder<UpdateAccessControlConfigurationRequest.Builder,UpdateAccessControlConfigurationRequest>

Method Summary

Modifier and Type	Method	Description
UpdateAccessControlConfigurationRequest.Builder	accessControlList(Collection<Principal> accessControlList)	Information you want to update on principals (users and/or groups) and which documents they should have access to.
UpdateAccessControlConfigurationRequest.Builder	accessControlList(Consumer<Principal.Builder>... accessControlList)	Information you want to update on principals (users and/or groups) and which documents they should have access to.
UpdateAccessControlConfigurationRequest.Builder	accessControlList(Principal... accessControlList)	Information you want to update on principals (users and/or groups) and which documents they should have access to.
UpdateAccessControlConfigurationRequest.Builder	description(String description)	A new description for the access control configuration.
UpdateAccessControlConfigurationRequest.Builder	hierarchicalAccessControlList(Collection<HierarchicalPrincipal> hierarchicalAccessControlList)	The updated list of principal lists that define the hierarchy for which documents users should have access to.
UpdateAccessControlConfigurationRequest.Builder	hierarchicalAccessControlList(Consumer<HierarchicalPrincipal.Builder>... hierarchicalAccessControlList)	The updated list of principal lists that define the hierarchy for which documents users should have access to.
UpdateAccessControlConfigurationRequest.Builder	hierarchicalAccessControlList(HierarchicalPrincipal... hierarchicalAccessControlList)	The updated list of principal lists that define the hierarchy for which documents users should have access to.
UpdateAccessControlConfigurationRequest.Builder	id(String id)	The identifier of the access control configuration you want to update.
UpdateAccessControlConfigurationRequest.Builder	indexId(String indexId)	The identifier of the index for an access control configuration.
UpdateAccessControlConfigurationRequest.Builder	name(String name)	A new name for the access control configuration.
UpdateAccessControlConfigurationRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateAccessControlConfigurationRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

indexId

UpdateAccessControlConfigurationRequest.Builder indexId(String indexId)

The identifier of the index for an access control configuration.

Parameters:

indexId - The identifier of the index for an access control configuration.

Returns:

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

id

UpdateAccessControlConfigurationRequest.Builder id(String id)

The identifier of the access control configuration you want to update.

Parameters:

id - The identifier of the access control configuration you want to update.

Returns:

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

name

UpdateAccessControlConfigurationRequest.Builder name(String name)

A new name for the access control configuration.

Parameters:

name - A new name for the access control configuration.

Returns:

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

description

UpdateAccessControlConfigurationRequest.Builder description(String description)

A new description for the access control configuration.

Parameters:

description - A new description for the access control configuration.

Returns:

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

accessControlList

UpdateAccessControlConfigurationRequest.Builder accessControlList(Collection<Principal> accessControlList)

Information you want to update on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Parameters:

accessControlList - Information you want to update on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Returns:

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

accessControlList

UpdateAccessControlConfigurationRequest.Builder accessControlList(Principal... accessControlList)

Information you want to update on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Parameters:

accessControlList - Information you want to update on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Returns:

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

accessControlList

UpdateAccessControlConfigurationRequest.Builder accessControlList(Consumer<Principal.Builder>... accessControlList)

Information you want to update on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

This is a convenience method that creates an instance of the Principal.Builder avoiding the need to create one manually via Principal.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to accessControlList(List<Principal>).

Parameters:

accessControlList - a consumer that will call methods on Principal.Builder

Returns:

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

See Also:

• accessControlList(java.util.Collection<Principal>)

hierarchicalAccessControlList

UpdateAccessControlConfigurationRequest.Builder hierarchicalAccessControlList(Collection<HierarchicalPrincipal> hierarchicalAccessControlList)

The updated list of principal lists that define the hierarchy for which documents users should have access to.

Parameters:

hierarchicalAccessControlList - The updated list of principal lists that define the hierarchy for which documents users should have access to.

Returns:

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

hierarchicalAccessControlList

UpdateAccessControlConfigurationRequest.Builder hierarchicalAccessControlList(HierarchicalPrincipal... hierarchicalAccessControlList)

The updated list of principal lists that define the hierarchy for which documents users should have access to.

Parameters:

hierarchicalAccessControlList - The updated list of principal lists that define the hierarchy for which documents users should have access to.

Returns:

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

hierarchicalAccessControlList

UpdateAccessControlConfigurationRequest.Builder hierarchicalAccessControlList(Consumer<HierarchicalPrincipal.Builder>... hierarchicalAccessControlList)

The updated list of principal lists that define the hierarchy for which documents users should have access to.

This is a convenience method that creates an instance of the HierarchicalPrincipal.Builder avoiding the need to create one manually via HierarchicalPrincipal.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to hierarchicalAccessControlList(List<HierarchicalPrincipal>).

Parameters:

hierarchicalAccessControlList - a consumer that will call methods on HierarchicalPrincipal.Builder

Returns:

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

See Also:

• hierarchicalAccessControlList(java.util.Collection<HierarchicalPrincipal>)

overrideConfiguration

UpdateAccessControlConfigurationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

UpdateAccessControlConfigurationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.