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

Class DescribeAccessControlConfigurationResponse

    • Method Detail

      • name

        public final String name()

        The name for the access control configuration.

        Returns:
        The name for the access control configuration.

      • description

        public final String description()

        The description for the access control configuration.

        Returns:
        The description for the access control configuration.

      • errorMessage

        public final String errorMessage()

        The error message containing details if there are issues processing the access control configuration.

        Returns:
        The error message containing details if there are issues processing the access control configuration.

      • hasAccessControlList

        public final boolean hasAccessControlList()
        For responses, this returns true if the service returned a value for the AccessControlList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • accessControlList

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAccessControlList() method.

        Returns:
        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.

      • hasHierarchicalAccessControlList

        public final boolean hasHierarchicalAccessControlList()
        For responses, this returns true if the service returned a value for the HierarchicalAccessControlList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • hierarchicalAccessControlList

        public final List<HierarchicalPrincipal> hierarchicalAccessControlList()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHierarchicalAccessControlList() method.

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

      • 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