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

Class UserContext

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<UserContext.Builder,​UserContext>
    @Generated("software.amazon.awssdk:codegen")
public final class UserContext
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UserContext.Builder,​UserContext>

    Provides information about the user context for an Amazon Kendra index.

    User context filtering is a kind of personalized search with the benefit of controlling access to documents. For example, not all teams that search the company portal for information should access top-secret company documents, nor are these documents relevant to all users. Only specific users or groups of teams given access to top-secret documents should see these documents in their search results.

    You provide one of the following:

    • User token

    • User ID, the groups the user belongs to, and any data sources the groups can access.

    If you provide both, an exception is thrown.

    See Also:
    Serialized Form

    • Method Detail

      • token

        public final String token()

        The user context token for filtering search results for a user. It must be a JWT or a JSON token.

        Returns:
        The user context token for filtering search results for a user. It must be a JWT or a JSON token.

      • userId

        public final String userId()

        The identifier of the user you want to filter search results based on their access to documents.

        Returns:
        The identifier of the user you want to filter search results based on their access to documents.

      • hasGroups

        public final boolean hasGroups()
        For responses, this returns true if the service returned a value for the Groups 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.

      • groups

        public final List<String> groups()

        The list of groups you want to filter search results based on the groups' 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 hasGroups() method.

        Returns:
        The list of groups you want to filter search results based on the groups' access to documents.

      • hasDataSourceGroups

        public final boolean hasDataSourceGroups()
        For responses, this returns true if the service returned a value for the DataSourceGroups 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.

      • dataSourceGroups

        public final List<DataSourceGroup> dataSourceGroups()

        The list of data source groups you want to filter search results based on groups' access to documents in that data source.

        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 hasDataSourceGroups() method.

        Returns:
        The list of data source groups you want to filter search results based on groups' access to documents in that data source.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

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