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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Principal.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.static Principal
fromGroup
(Consumer<PrincipalGroup.Builder> group) Create an instance of this class withgroup()
initialized to the given value.static Principal
fromGroup
(PrincipalGroup group) Create an instance of this class withgroup()
initialized to the given value.static Principal
Create an instance of this class withuser()
initialized to the given value.static Principal
fromUser
(PrincipalUser user) Create an instance of this class withuser()
initialized to the given value.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final PrincipalGroup
group()
The group associated with the principal.final int
hashCode()
static Class
<? extends Principal.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.type()
Retrieve an enum value representing which member of this object is populated.final PrincipalUser
user()
The user associated with the principal.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
user
The user associated with the principal.
- Returns:
- The user associated with the principal.
-
group
The group associated with the principal.
- Returns:
- The group associated with the principal.
-
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 interfaceToCopyableBuilder<Principal.Builder,
Principal> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
fromUser
Create an instance of this class withuser()
initialized to the given value.The user associated with the principal.
- Parameters:
user
- The user associated with the principal.
-
fromUser
Create an instance of this class withuser()
initialized to the given value.The user associated with the principal.
- Parameters:
user
- The user associated with the principal.
-
fromGroup
Create an instance of this class withgroup()
initialized to the given value.The group associated with the principal.
- Parameters:
group
- The group associated with the principal.
-
fromGroup
Create an instance of this class withgroup()
initialized to the given value.The group associated with the principal.
- Parameters:
group
- The group associated with the principal.
-
type
Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will bePrincipal.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 bePrincipal.Type.UNKNOWN_TO_SDK_VERSION
if zero members are set, andnull
if more than one member is set. -
sdkFields
-