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

#include <GroupMembers.h>

Public Member Functions

 GroupMembers ()
 
 GroupMembers (Aws::Utils::Json::JsonView jsonValue)
 
GroupMembersoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Vector< MemberGroup > & GetMemberGroups () const
 
bool MemberGroupsHasBeenSet () const
 
void SetMemberGroups (const Aws::Vector< MemberGroup > &value)
 
void SetMemberGroups (Aws::Vector< MemberGroup > &&value)
 
GroupMembersWithMemberGroups (const Aws::Vector< MemberGroup > &value)
 
GroupMembersWithMemberGroups (Aws::Vector< MemberGroup > &&value)
 
GroupMembersAddMemberGroups (const MemberGroup &value)
 
GroupMembersAddMemberGroups (MemberGroup &&value)
 
const Aws::Vector< MemberUser > & GetMemberUsers () const
 
bool MemberUsersHasBeenSet () const
 
void SetMemberUsers (const Aws::Vector< MemberUser > &value)
 
void SetMemberUsers (Aws::Vector< MemberUser > &&value)
 
GroupMembersWithMemberUsers (const Aws::Vector< MemberUser > &value)
 
GroupMembersWithMemberUsers (Aws::Vector< MemberUser > &&value)
 
GroupMembersAddMemberUsers (const MemberUser &value)
 
GroupMembersAddMemberUsers (MemberUser &&value)
 
const S3PathGetS3PathforGroupMembers () const
 
bool S3PathforGroupMembersHasBeenSet () const
 
void SetS3PathforGroupMembers (const S3Path &value)
 
void SetS3PathforGroupMembers (S3Path &&value)
 
GroupMembersWithS3PathforGroupMembers (const S3Path &value)
 
GroupMembersWithS3PathforGroupMembers (S3Path &&value)
 

Detailed Description

A list of users or sub groups that belong to a group. Users and groups are useful for filtering search results to different users based on their group's access to documents.

See Also:

AWS API Reference

Definition at line 36 of file GroupMembers.h.

Constructor & Destructor Documentation

◆ GroupMembers() [1/2]

Aws::kendra::Model::GroupMembers::GroupMembers ( )

◆ GroupMembers() [2/2]

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

Member Function Documentation

◆ AddMemberGroups() [1/2]

GroupMembers& Aws::kendra::Model::GroupMembers::AddMemberGroups ( const MemberGroup value)
inline

A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".

Definition at line 92 of file GroupMembers.h.

◆ AddMemberGroups() [2/2]

GroupMembers& Aws::kendra::Model::GroupMembers::AddMemberGroups ( MemberGroup &&  value)
inline

A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".

Definition at line 99 of file GroupMembers.h.

◆ AddMemberUsers() [1/2]

GroupMembers& Aws::kendra::Model::GroupMembers::AddMemberUsers ( const MemberUser value)
inline

A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.

Definition at line 142 of file GroupMembers.h.

◆ AddMemberUsers() [2/2]

GroupMembers& Aws::kendra::Model::GroupMembers::AddMemberUsers ( MemberUser &&  value)
inline

A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.

Definition at line 148 of file GroupMembers.h.

◆ GetMemberGroups()

const Aws::Vector<MemberGroup>& Aws::kendra::Model::GroupMembers::GetMemberGroups ( ) const
inline

A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".

Definition at line 50 of file GroupMembers.h.

◆ GetMemberUsers()

const Aws::Vector<MemberUser>& Aws::kendra::Model::GroupMembers::GetMemberUsers ( ) const
inline

A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.

Definition at line 106 of file GroupMembers.h.

◆ GetS3PathforGroupMembers()

const S3Path& Aws::kendra::Model::GroupMembers::GetS3PathforGroupMembers ( ) const
inline

If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

You can download this example S3 file that uses the correct format for listing group members. Note, dataSourceId is optional. The value of type for a group is always GROUP and for a user it is always USER.

Definition at line 163 of file GroupMembers.h.

◆ Jsonize()

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

◆ MemberGroupsHasBeenSet()

bool Aws::kendra::Model::GroupMembers::MemberGroupsHasBeenSet ( ) const
inline

A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".

Definition at line 57 of file GroupMembers.h.

◆ MemberUsersHasBeenSet()

bool Aws::kendra::Model::GroupMembers::MemberUsersHasBeenSet ( ) const
inline

A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.

Definition at line 112 of file GroupMembers.h.

◆ operator=()

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

◆ S3PathforGroupMembersHasBeenSet()

bool Aws::kendra::Model::GroupMembers::S3PathforGroupMembersHasBeenSet ( ) const
inline

If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

You can download this example S3 file that uses the correct format for listing group members. Note, dataSourceId is optional. The value of type for a group is always GROUP and for a user it is always USER.

Definition at line 177 of file GroupMembers.h.

◆ SetMemberGroups() [1/2]

void Aws::kendra::Model::GroupMembers::SetMemberGroups ( Aws::Vector< MemberGroup > &&  value)
inline

A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".

Definition at line 71 of file GroupMembers.h.

◆ SetMemberGroups() [2/2]

void Aws::kendra::Model::GroupMembers::SetMemberGroups ( const Aws::Vector< MemberGroup > &  value)
inline

A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".

Definition at line 64 of file GroupMembers.h.

◆ SetMemberUsers() [1/2]

void Aws::kendra::Model::GroupMembers::SetMemberUsers ( Aws::Vector< MemberUser > &&  value)
inline

A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.

Definition at line 124 of file GroupMembers.h.

◆ SetMemberUsers() [2/2]

void Aws::kendra::Model::GroupMembers::SetMemberUsers ( const Aws::Vector< MemberUser > &  value)
inline

A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.

Definition at line 118 of file GroupMembers.h.

◆ SetS3PathforGroupMembers() [1/2]

void Aws::kendra::Model::GroupMembers::SetS3PathforGroupMembers ( const S3Path value)
inline

If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

You can download this example S3 file that uses the correct format for listing group members. Note, dataSourceId is optional. The value of type for a group is always GROUP and for a user it is always USER.

Definition at line 191 of file GroupMembers.h.

◆ SetS3PathforGroupMembers() [2/2]

void Aws::kendra::Model::GroupMembers::SetS3PathforGroupMembers ( S3Path &&  value)
inline

If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

You can download this example S3 file that uses the correct format for listing group members. Note, dataSourceId is optional. The value of type for a group is always GROUP and for a user it is always USER.

Definition at line 205 of file GroupMembers.h.

◆ WithMemberGroups() [1/2]

GroupMembers& Aws::kendra::Model::GroupMembers::WithMemberGroups ( Aws::Vector< MemberGroup > &&  value)
inline

A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".

Definition at line 85 of file GroupMembers.h.

◆ WithMemberGroups() [2/2]

GroupMembers& Aws::kendra::Model::GroupMembers::WithMemberGroups ( const Aws::Vector< MemberGroup > &  value)
inline

A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".

Definition at line 78 of file GroupMembers.h.

◆ WithMemberUsers() [1/2]

GroupMembers& Aws::kendra::Model::GroupMembers::WithMemberUsers ( Aws::Vector< MemberUser > &&  value)
inline

A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.

Definition at line 136 of file GroupMembers.h.

◆ WithMemberUsers() [2/2]

GroupMembers& Aws::kendra::Model::GroupMembers::WithMemberUsers ( const Aws::Vector< MemberUser > &  value)
inline

A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.

Definition at line 130 of file GroupMembers.h.

◆ WithS3PathforGroupMembers() [1/2]

GroupMembers& Aws::kendra::Model::GroupMembers::WithS3PathforGroupMembers ( const S3Path value)
inline

If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

You can download this example S3 file that uses the correct format for listing group members. Note, dataSourceId is optional. The value of type for a group is always GROUP and for a user it is always USER.

Definition at line 219 of file GroupMembers.h.

◆ WithS3PathforGroupMembers() [2/2]

GroupMembers& Aws::kendra::Model::GroupMembers::WithS3PathforGroupMembers ( S3Path &&  value)
inline

If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

You can download this example S3 file that uses the correct format for listing group members. Note, dataSourceId is optional. The value of type for a group is always GROUP and for a user it is always USER.

Definition at line 233 of file GroupMembers.h.


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