Interface DescribeAccessControlConfigurationResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<DescribeAccessControlConfigurationResponse.Builder,
,DescribeAccessControlConfigurationResponse> KendraResponse.Builder
,SdkBuilder<DescribeAccessControlConfigurationResponse.Builder,
,DescribeAccessControlConfigurationResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeAccessControlConfigurationResponse
-
Method Summary
Modifier and TypeMethodDescriptionaccessControlList
(Collection<Principal> accessControlList) Information on principals (users and/or groups) and which documents they should have access to.accessControlList
(Consumer<Principal.Builder>... accessControlList) Information on principals (users and/or groups) and which documents they should have access to.accessControlList
(Principal... accessControlList) Information on principals (users and/or groups) and which documents they should have access to.description
(String description) The description for the access control configuration.errorMessage
(String errorMessage) The error message containing details if there are issues processing the access control configuration.hierarchicalAccessControlList
(Collection<HierarchicalPrincipal> hierarchicalAccessControlList) The list of principal lists that define the hierarchy for which documents users should have access to.hierarchicalAccessControlList
(Consumer<HierarchicalPrincipal.Builder>... hierarchicalAccessControlList) The list of principal lists that define the hierarchy for which documents users should have access to.hierarchicalAccessControlList
(HierarchicalPrincipal... hierarchicalAccessControlList) The list of principal lists that define the hierarchy for which documents users should have access to.The name for the access control configuration.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
name
The name for the access control configuration.
- Parameters:
name
- The name for the access control configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
The description for the access control configuration.
- Parameters:
description
- The description for the access control configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
errorMessage
The error message containing details if there are issues processing the access control configuration.
- Parameters:
errorMessage
- The error message containing details if there are issues processing the access control configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
accessControlList
DescribeAccessControlConfigurationResponse.Builder accessControlList(Collection<Principal> accessControlList) Information 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 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
DescribeAccessControlConfigurationResponse.Builder accessControlList(Principal... accessControlList) Information 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 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
DescribeAccessControlConfigurationResponse.Builder accessControlList(Consumer<Principal.Builder>... accessControlList) Information 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 thePrincipal.Builder
avoiding the need to create one manually viaPrincipal.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toaccessControlList(List<Principal>)
.- Parameters:
accessControlList
- a consumer that will call methods onPrincipal.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
hierarchicalAccessControlList
DescribeAccessControlConfigurationResponse.Builder hierarchicalAccessControlList(Collection<HierarchicalPrincipal> hierarchicalAccessControlList) The list of principal lists that define the hierarchy for which documents users should have access to.
- Parameters:
hierarchicalAccessControlList
- The 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
DescribeAccessControlConfigurationResponse.Builder hierarchicalAccessControlList(HierarchicalPrincipal... hierarchicalAccessControlList) The list of principal lists that define the hierarchy for which documents users should have access to.
- Parameters:
hierarchicalAccessControlList
- The 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
DescribeAccessControlConfigurationResponse.Builder hierarchicalAccessControlList(Consumer<HierarchicalPrincipal.Builder>... hierarchicalAccessControlList) The 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 theHierarchicalPrincipal.Builder
avoiding the need to create one manually viaHierarchicalPrincipal.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohierarchicalAccessControlList(List<HierarchicalPrincipal>)
.- Parameters:
hierarchicalAccessControlList
- a consumer that will call methods onHierarchicalPrincipal.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-