com.amazonaws.services.qbusiness.model

Class Principal

java.lang.Object

com.amazonaws.services.qbusiness.model.Principal

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Principal
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Principal()

Method Summary

Modifier and Type	Method and Description
Principal	clone()
boolean	equals(Object obj)
PrincipalGroup	getGroup() The group associated with the principal.
PrincipalUser	getUser() The user associated with the principal.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setGroup(PrincipalGroup group) The group associated with the principal.
void	setUser(PrincipalUser user) The user associated with the principal.
String	toString() Returns a string representation of this object.
Principal	withGroup(PrincipalGroup group) The group associated with the principal.
Principal	withUser(PrincipalUser user) The user associated with the principal.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Principal

public Principal()

Method Detail

setUser

public void setUser(PrincipalUser user)

The user associated with the principal.

Parameters:

user - The user associated with the principal.

getUser

public PrincipalUser getUser()

The user associated with the principal.

Returns:

The user associated with the principal.

withUser

public Principal withUser(PrincipalUser user)

The user associated with the principal.

Parameters:

user - The user associated with the principal.

Returns:

Returns a reference to this object so that method calls can be chained together.

setGroup

public void setGroup(PrincipalGroup group)

The group associated with the principal.

Parameters:

group - The group associated with the principal.

getGroup

public PrincipalGroup getGroup()

The group associated with the principal.

Returns:

The group associated with the principal.

withGroup

public Principal withGroup(PrincipalGroup group)

The group associated with the principal.

Parameters:

group - The group associated with the principal.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Principal clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.