Class Principal

java.lang.Object
software.amazon.awssdk.services.qbusiness.model.Principal
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Principal.Builder,Principal>
@Generated("software.amazon.awssdk:codegen") public final class Principal extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Principal.Builder,Principal>

Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.

See Also:

  • Method Details

    • user

      public final PrincipalUser user()

      The user associated with the principal.

      Returns:
      The user associated with the principal.

    • group

      public final PrincipalGroup group()

      The group associated with the principal.

      Returns:
      The group associated with the principal.

    • toBuilder

      public Principal.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Principal.Builder,Principal>
      Returns:
      a builder for type T

    • builder

      public static Principal.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Principal.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • fromUser

      public static Principal fromUser(PrincipalUser user)
      Create an instance of this class with user() initialized to the given value.

      The user associated with the principal.

      Parameters:
      user - The user associated with the principal.

    • fromUser

      public static Principal fromUser(Consumer<PrincipalUser.Builder> user)
      Create an instance of this class with user() initialized to the given value.

      The user associated with the principal.

      Parameters:
      user - The user associated with the principal.

    • fromGroup

      public static Principal fromGroup(PrincipalGroup group)
      Create an instance of this class with group() initialized to the given value.

      The group associated with the principal.

      Parameters:
      group - The group associated with the principal.

    • fromGroup

      public static Principal fromGroup(Consumer<PrincipalGroup.Builder> group)
      Create an instance of this class with group() initialized to the given value.

      The group associated with the principal.

      Parameters:
      group - The group associated with the principal.

    • type

      public Principal.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be Principal.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be Principal.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.