qbusiness/aws.sdk.kotlin.services.qbusiness.model/Principal

Principal

sealed class Principal

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

Inheritors

Types

data class Group(val value: PrincipalGroup) : Principal

The group associated with the principal.

object SdkUnknown : Principal

data class User(val value: PrincipalUser) : Principal

The user associated with the principal.

Functions

fun asGroup(): PrincipalGroup

Casts this Principal as a Group and retrieves its aws.sdk.kotlin.services.qbusiness.model.PrincipalGroup value. Throws an exception if the Principal is not a Group.

fun asGroupOrNull(): PrincipalGroup?

Casts this Principal as a Group and retrieves its aws.sdk.kotlin.services.qbusiness.model.PrincipalGroup value. Returns null if the Principal is not a Group.

fun asUser(): PrincipalUser

Casts this Principal as a User and retrieves its aws.sdk.kotlin.services.qbusiness.model.PrincipalUser value. Throws an exception if the Principal is not a User.

fun asUserOrNull(): PrincipalUser?

Casts this Principal as a User and retrieves its aws.sdk.kotlin.services.qbusiness.model.PrincipalUser value. Returns null if the Principal is not a User.