Package software.amazon.awssdk.services.qbusiness.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Principal.Builder
static class	Principal.Type

Method Summary

Modifier and Type	Method	Description
static Principal.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
static Principal	fromGroup(Consumer<PrincipalGroup.Builder> group)	Create an instance of this class with group() initialized to the given value.
static Principal	fromGroup(PrincipalGroup group)	Create an instance of this class with group() initialized to the given value.
static Principal	fromUser(Consumer<PrincipalUser.Builder> user)	Create an instance of this class with user() initialized to the given value.
static Principal	fromUser(PrincipalUser user)	Create an instance of this class with user() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
PrincipalGroup	group()	The group associated with the principal.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends Principal.Builder>	serializableBuilderClass()
Principal.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Principal.Type	type()	Retrieve an enum value representing which member of this object is populated.
PrincipalUser	user()	The user associated with the principal.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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

Specified by:

toBuilder in interface ToCopyableBuilder<Principal.Builder,Principal>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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