AWS SDK for C++  1.9.4
AWS SDK for C++
Public Member Functions | List of all members
Aws::kendra::Model::Principal Class Reference

#include <Principal.h>

Public Member Functions

 Principal ()
 
 Principal (Aws::Utils::Json::JsonView jsonValue)
 
Principaloperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
PrincipalWithName (const Aws::String &value)
 
PrincipalWithName (Aws::String &&value)
 
PrincipalWithName (const char *value)
 
const PrincipalTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const PrincipalType &value)
 
void SetType (PrincipalType &&value)
 
PrincipalWithType (const PrincipalType &value)
 
PrincipalWithType (PrincipalType &&value)
 
const ReadAccessTypeGetAccess () const
 
bool AccessHasBeenSet () const
 
void SetAccess (const ReadAccessType &value)
 
void SetAccess (ReadAccessType &&value)
 
PrincipalWithAccess (const ReadAccessType &value)
 
PrincipalWithAccess (ReadAccessType &&value)
 

Detailed Description

Provides user and group information for document access filtering.

See Also:

AWS API Reference

Definition at line 34 of file Principal.h.

Constructor & Destructor Documentation

◆ Principal() [1/2]

Aws::kendra::Model::Principal::Principal ( )

◆ Principal() [2/2]

Aws::kendra::Model::Principal::Principal ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AccessHasBeenSet()

bool Aws::kendra::Model::Principal::AccessHasBeenSet ( ) const
inline

Whether to allow or deny access to the principal.

Definition at line 123 of file Principal.h.

◆ GetAccess()

const ReadAccessType& Aws::kendra::Model::Principal::GetAccess ( ) const
inline

Whether to allow or deny access to the principal.

Definition at line 118 of file Principal.h.

◆ GetName()

const Aws::String& Aws::kendra::Model::Principal::GetName ( ) const
inline

The name of the user or group.

Definition at line 46 of file Principal.h.

◆ GetType()

const PrincipalType& Aws::kendra::Model::Principal::GetType ( ) const
inline

The type of principal.

Definition at line 87 of file Principal.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::kendra::Model::Principal::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::kendra::Model::Principal::NameHasBeenSet ( ) const
inline

The name of the user or group.

Definition at line 51 of file Principal.h.

◆ operator=()

Principal& Aws::kendra::Model::Principal::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetAccess() [1/2]

void Aws::kendra::Model::Principal::SetAccess ( const ReadAccessType value)
inline

Whether to allow or deny access to the principal.

Definition at line 128 of file Principal.h.

◆ SetAccess() [2/2]

void Aws::kendra::Model::Principal::SetAccess ( ReadAccessType &&  value)
inline

Whether to allow or deny access to the principal.

Definition at line 133 of file Principal.h.

◆ SetName() [1/3]

void Aws::kendra::Model::Principal::SetName ( Aws::String &&  value)
inline

The name of the user or group.

Definition at line 61 of file Principal.h.

◆ SetName() [2/3]

void Aws::kendra::Model::Principal::SetName ( const Aws::String value)
inline

The name of the user or group.

Definition at line 56 of file Principal.h.

◆ SetName() [3/3]

void Aws::kendra::Model::Principal::SetName ( const char *  value)
inline

The name of the user or group.

Definition at line 66 of file Principal.h.

◆ SetType() [1/2]

void Aws::kendra::Model::Principal::SetType ( const PrincipalType value)
inline

The type of principal.

Definition at line 97 of file Principal.h.

◆ SetType() [2/2]

void Aws::kendra::Model::Principal::SetType ( PrincipalType &&  value)
inline

The type of principal.

Definition at line 102 of file Principal.h.

◆ TypeHasBeenSet()

bool Aws::kendra::Model::Principal::TypeHasBeenSet ( ) const
inline

The type of principal.

Definition at line 92 of file Principal.h.

◆ WithAccess() [1/2]

Principal& Aws::kendra::Model::Principal::WithAccess ( const ReadAccessType value)
inline

Whether to allow or deny access to the principal.

Definition at line 138 of file Principal.h.

◆ WithAccess() [2/2]

Principal& Aws::kendra::Model::Principal::WithAccess ( ReadAccessType &&  value)
inline

Whether to allow or deny access to the principal.

Definition at line 143 of file Principal.h.

◆ WithName() [1/3]

Principal& Aws::kendra::Model::Principal::WithName ( Aws::String &&  value)
inline

The name of the user or group.

Definition at line 76 of file Principal.h.

◆ WithName() [2/3]

Principal& Aws::kendra::Model::Principal::WithName ( const Aws::String value)
inline

The name of the user or group.

Definition at line 71 of file Principal.h.

◆ WithName() [3/3]

Principal& Aws::kendra::Model::Principal::WithName ( const char *  value)
inline

The name of the user or group.

Definition at line 81 of file Principal.h.

◆ WithType() [1/2]

Principal& Aws::kendra::Model::Principal::WithType ( const PrincipalType value)
inline

The type of principal.

Definition at line 107 of file Principal.h.

◆ WithType() [2/2]

Principal& Aws::kendra::Model::Principal::WithType ( PrincipalType &&  value)
inline

The type of principal.

Definition at line 112 of file Principal.h.


The documentation for this class was generated from the following file: