Struct GroupMembers 

#[non_exhaustive]
pub struct GroupMembers {
    pub member_groups: Option<Vec<MemberGroup>>,
    pub member_users: Option<Vec<MemberUser>>,
    pub s3_pathfor_group_members: Option<S3Path>,
}

A list of users that belong to a group. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

member_groups: Option<Vec<MemberGroup>>

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

member_users: Option<Vec<MemberUser>>

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

s3_pathfor_group_members: Option<S3Path>

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.

Implementations

impl GroupMembers

pub fn member_groups(&self) -> &[MemberGroup]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .member_groups.is_none().

pub fn member_users(&self) -> &[MemberUser]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .member_users.is_none().

pub fn s3_pathfor_group_members(&self) -> Option<&S3Path>

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.

impl GroupMembers

pub fn builder() -> GroupMembersBuilder

Creates a new builder-style object to manufacture GroupMembers.

Trait Implementations

impl Clone for GroupMembers

fn clone(&self) -> GroupMembers

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GroupMembers

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GroupMembers

fn eq(&self, other: &GroupMembers) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GroupMembers