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

Interface DescribeAccessControlConfigurationResponse.Builder

    • Method Detail

      • name

        DescribeAccessControlConfigurationResponse.Builder name​(String 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

        DescribeAccessControlConfigurationResponse.Builder description​(String 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

        DescribeAccessControlConfigurationResponse.Builder errorMessage​(String 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 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).

        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)

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