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

#include <UserContext.h>

Public Member Functions

 UserContext ()
 
 UserContext (Aws::Utils::Json::JsonView jsonValue)
 
UserContextoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetToken () const
 
bool TokenHasBeenSet () const
 
void SetToken (const Aws::String &value)
 
void SetToken (Aws::String &&value)
 
void SetToken (const char *value)
 
UserContextWithToken (const Aws::String &value)
 
UserContextWithToken (Aws::String &&value)
 
UserContextWithToken (const char *value)
 
const Aws::StringGetUserId () const
 
bool UserIdHasBeenSet () const
 
void SetUserId (const Aws::String &value)
 
void SetUserId (Aws::String &&value)
 
void SetUserId (const char *value)
 
UserContextWithUserId (const Aws::String &value)
 
UserContextWithUserId (Aws::String &&value)
 
UserContextWithUserId (const char *value)
 
const Aws::Vector< Aws::String > & GetGroups () const
 
bool GroupsHasBeenSet () const
 
void SetGroups (const Aws::Vector< Aws::String > &value)
 
void SetGroups (Aws::Vector< Aws::String > &&value)
 
UserContextWithGroups (const Aws::Vector< Aws::String > &value)
 
UserContextWithGroups (Aws::Vector< Aws::String > &&value)
 
UserContextAddGroups (const Aws::String &value)
 
UserContextAddGroups (Aws::String &&value)
 
UserContextAddGroups (const char *value)
 
const Aws::Vector< DataSourceGroup > & GetDataSourceGroups () const
 
bool DataSourceGroupsHasBeenSet () const
 
void SetDataSourceGroups (const Aws::Vector< DataSourceGroup > &value)
 
void SetDataSourceGroups (Aws::Vector< DataSourceGroup > &&value)
 
UserContextWithDataSourceGroups (const Aws::Vector< DataSourceGroup > &value)
 
UserContextWithDataSourceGroups (Aws::Vector< DataSourceGroup > &&value)
 
UserContextAddDataSourceGroups (const DataSourceGroup &value)
 
UserContextAddDataSourceGroups (DataSourceGroup &&value)
 

Detailed Description

Provides information about the user context for an Amazon Kendra index.

This is used for filtering search results for different users based on their access to documents.

You provide one of the following:

If you provide both, an exception is thrown.

See Also:

AWS API Reference

Definition at line 38 of file UserContext.h.

Constructor & Destructor Documentation

◆ UserContext() [1/2]

Aws::kendra::Model::UserContext::UserContext ( )

◆ UserContext() [2/2]

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

Member Function Documentation

◆ AddDataSourceGroups() [1/2]

UserContext& Aws::kendra::Model::UserContext::AddDataSourceGroups ( const DataSourceGroup value)
inline

The list of data source groups you want to filter search results based on groups' access to documents in that data source.

Definition at line 240 of file UserContext.h.

◆ AddDataSourceGroups() [2/2]

UserContext& Aws::kendra::Model::UserContext::AddDataSourceGroups ( DataSourceGroup &&  value)
inline

The list of data source groups you want to filter search results based on groups' access to documents in that data source.

Definition at line 246 of file UserContext.h.

◆ AddGroups() [1/3]

UserContext& Aws::kendra::Model::UserContext::AddGroups ( Aws::String &&  value)
inline

The list of groups you want to filter search results based on the groups' access to documents.

Definition at line 191 of file UserContext.h.

◆ AddGroups() [2/3]

UserContext& Aws::kendra::Model::UserContext::AddGroups ( const Aws::String value)
inline

The list of groups you want to filter search results based on the groups' access to documents.

Definition at line 185 of file UserContext.h.

◆ AddGroups() [3/3]

UserContext& Aws::kendra::Model::UserContext::AddGroups ( const char *  value)
inline

The list of groups you want to filter search results based on the groups' access to documents.

Definition at line 197 of file UserContext.h.

◆ DataSourceGroupsHasBeenSet()

bool Aws::kendra::Model::UserContext::DataSourceGroupsHasBeenSet ( ) const
inline

The list of data source groups you want to filter search results based on groups' access to documents in that data source.

Definition at line 210 of file UserContext.h.

◆ GetDataSourceGroups()

const Aws::Vector<DataSourceGroup>& Aws::kendra::Model::UserContext::GetDataSourceGroups ( ) const
inline

The list of data source groups you want to filter search results based on groups' access to documents in that data source.

Definition at line 204 of file UserContext.h.

◆ GetGroups()

const Aws::Vector<Aws::String>& Aws::kendra::Model::UserContext::GetGroups ( ) const
inline

The list of groups you want to filter search results based on the groups' access to documents.

Definition at line 149 of file UserContext.h.

◆ GetToken()

const Aws::String& Aws::kendra::Model::UserContext::GetToken ( ) const
inline

The user context token for filtering search results for a user. It must be a JWT or a JSON token.

Definition at line 51 of file UserContext.h.

◆ GetUserId()

const Aws::String& Aws::kendra::Model::UserContext::GetUserId ( ) const
inline

The identifier of the user you want to filter search results based on their access to documents.

Definition at line 100 of file UserContext.h.

◆ GroupsHasBeenSet()

bool Aws::kendra::Model::UserContext::GroupsHasBeenSet ( ) const
inline

The list of groups you want to filter search results based on the groups' access to documents.

Definition at line 155 of file UserContext.h.

◆ Jsonize()

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

◆ operator=()

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

◆ SetDataSourceGroups() [1/2]

void Aws::kendra::Model::UserContext::SetDataSourceGroups ( Aws::Vector< DataSourceGroup > &&  value)
inline

The list of data source groups you want to filter search results based on groups' access to documents in that data source.

Definition at line 222 of file UserContext.h.

◆ SetDataSourceGroups() [2/2]

void Aws::kendra::Model::UserContext::SetDataSourceGroups ( const Aws::Vector< DataSourceGroup > &  value)
inline

The list of data source groups you want to filter search results based on groups' access to documents in that data source.

Definition at line 216 of file UserContext.h.

◆ SetGroups() [1/2]

void Aws::kendra::Model::UserContext::SetGroups ( Aws::Vector< Aws::String > &&  value)
inline

The list of groups you want to filter search results based on the groups' access to documents.

Definition at line 167 of file UserContext.h.

◆ SetGroups() [2/2]

void Aws::kendra::Model::UserContext::SetGroups ( const Aws::Vector< Aws::String > &  value)
inline

The list of groups you want to filter search results based on the groups' access to documents.

Definition at line 161 of file UserContext.h.

◆ SetToken() [1/3]

void Aws::kendra::Model::UserContext::SetToken ( Aws::String &&  value)
inline

The user context token for filtering search results for a user. It must be a JWT or a JSON token.

Definition at line 69 of file UserContext.h.

◆ SetToken() [2/3]

void Aws::kendra::Model::UserContext::SetToken ( const Aws::String value)
inline

The user context token for filtering search results for a user. It must be a JWT or a JSON token.

Definition at line 63 of file UserContext.h.

◆ SetToken() [3/3]

void Aws::kendra::Model::UserContext::SetToken ( const char *  value)
inline

The user context token for filtering search results for a user. It must be a JWT or a JSON token.

Definition at line 75 of file UserContext.h.

◆ SetUserId() [1/3]

void Aws::kendra::Model::UserContext::SetUserId ( Aws::String &&  value)
inline

The identifier of the user you want to filter search results based on their access to documents.

Definition at line 118 of file UserContext.h.

◆ SetUserId() [2/3]

void Aws::kendra::Model::UserContext::SetUserId ( const Aws::String value)
inline

The identifier of the user you want to filter search results based on their access to documents.

Definition at line 112 of file UserContext.h.

◆ SetUserId() [3/3]

void Aws::kendra::Model::UserContext::SetUserId ( const char *  value)
inline

The identifier of the user you want to filter search results based on their access to documents.

Definition at line 124 of file UserContext.h.

◆ TokenHasBeenSet()

bool Aws::kendra::Model::UserContext::TokenHasBeenSet ( ) const
inline

The user context token for filtering search results for a user. It must be a JWT or a JSON token.

Definition at line 57 of file UserContext.h.

◆ UserIdHasBeenSet()

bool Aws::kendra::Model::UserContext::UserIdHasBeenSet ( ) const
inline

The identifier of the user you want to filter search results based on their access to documents.

Definition at line 106 of file UserContext.h.

◆ WithDataSourceGroups() [1/2]

UserContext& Aws::kendra::Model::UserContext::WithDataSourceGroups ( Aws::Vector< DataSourceGroup > &&  value)
inline

The list of data source groups you want to filter search results based on groups' access to documents in that data source.

Definition at line 234 of file UserContext.h.

◆ WithDataSourceGroups() [2/2]

UserContext& Aws::kendra::Model::UserContext::WithDataSourceGroups ( const Aws::Vector< DataSourceGroup > &  value)
inline

The list of data source groups you want to filter search results based on groups' access to documents in that data source.

Definition at line 228 of file UserContext.h.

◆ WithGroups() [1/2]

UserContext& Aws::kendra::Model::UserContext::WithGroups ( Aws::Vector< Aws::String > &&  value)
inline

The list of groups you want to filter search results based on the groups' access to documents.

Definition at line 179 of file UserContext.h.

◆ WithGroups() [2/2]

UserContext& Aws::kendra::Model::UserContext::WithGroups ( const Aws::Vector< Aws::String > &  value)
inline

The list of groups you want to filter search results based on the groups' access to documents.

Definition at line 173 of file UserContext.h.

◆ WithToken() [1/3]

UserContext& Aws::kendra::Model::UserContext::WithToken ( Aws::String &&  value)
inline

The user context token for filtering search results for a user. It must be a JWT or a JSON token.

Definition at line 87 of file UserContext.h.

◆ WithToken() [2/3]

UserContext& Aws::kendra::Model::UserContext::WithToken ( const Aws::String value)
inline

The user context token for filtering search results for a user. It must be a JWT or a JSON token.

Definition at line 81 of file UserContext.h.

◆ WithToken() [3/3]

UserContext& Aws::kendra::Model::UserContext::WithToken ( const char *  value)
inline

The user context token for filtering search results for a user. It must be a JWT or a JSON token.

Definition at line 93 of file UserContext.h.

◆ WithUserId() [1/3]

UserContext& Aws::kendra::Model::UserContext::WithUserId ( Aws::String &&  value)
inline

The identifier of the user you want to filter search results based on their access to documents.

Definition at line 136 of file UserContext.h.

◆ WithUserId() [2/3]

UserContext& Aws::kendra::Model::UserContext::WithUserId ( const Aws::String value)
inline

The identifier of the user you want to filter search results based on their access to documents.

Definition at line 130 of file UserContext.h.

◆ WithUserId() [3/3]

UserContext& Aws::kendra::Model::UserContext::WithUserId ( const char *  value)
inline

The identifier of the user you want to filter search results based on their access to documents.

Definition at line 142 of file UserContext.h.


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