GroupMembers (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kendra.model.GroupMembers

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GroupMembers
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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 Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GroupMembers()

Constructors
Constructor and Description
`GroupMembers()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GroupMembers`	`clone()`
`boolean`	`equals(Object obj)`
`List<MemberGroup>`	`getMemberGroups()` A list of sub groups that belong to a group.
`List<MemberUser>`	`getMemberUsers()` A list of users that belong to a group.
`S3Path`	`getS3PathforGroupMembers()` 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.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setMemberGroups(Collection<MemberGroup> memberGroups)` A list of sub groups that belong to a group.
`void`	`setMemberUsers(Collection<MemberUser> memberUsers)` A list of users that belong to a group.
`void`	`setS3PathforGroupMembers(S3Path s3PathforGroupMembers)` 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.
`String`	`toString()` Returns a string representation of this object.
`GroupMembers`	`withMemberGroups(Collection<MemberGroup> memberGroups)` A list of sub groups that belong to a group.
`GroupMembers`	`withMemberGroups(MemberGroup... memberGroups)` A list of sub groups that belong to a group.
`GroupMembers`	`withMemberUsers(Collection<MemberUser> memberUsers)` A list of users that belong to a group.
`GroupMembers`	`withMemberUsers(MemberUser... memberUsers)` A list of users that belong to a group.
`GroupMembers`	`withS3PathforGroupMembers(S3Path s3PathforGroupMembers)` 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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GroupMembers
```
public GroupMembers()
```
- Method Detail
  - getMemberGroups
```
public List<MemberGroup> getMemberGroups()
```
    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".
    
    Returns:
    
    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".
  - setMemberGroups
```
public void setMemberGroups(Collection<MemberGroup> memberGroups)
```
    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".
    
    Parameters:
    
    memberGroups - 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".
  - withMemberGroups
```
public GroupMembers withMemberGroups(MemberGroup... memberGroups)
```
    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".
    
    NOTE: This method appends the values to the existing list (if any). Use setMemberGroups(java.util.Collection) or withMemberGroups(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    memberGroups - 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".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withMemberGroups
```
public GroupMembers withMemberGroups(Collection<MemberGroup> memberGroups)
```
    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".
    
    Parameters:
    
    memberGroups - 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".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMemberUsers
```
public List<MemberUser> getMemberUsers()
```
    A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
    
    Returns:
    
    A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
  - setMemberUsers
```
public void setMemberUsers(Collection<MemberUser> memberUsers)
```
    A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
    
    Parameters:
    
    memberUsers - A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
  - withMemberUsers
```
public GroupMembers withMemberUsers(MemberUser... memberUsers)
```
    A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
    
    NOTE: This method appends the values to the existing list (if any). Use setMemberUsers(java.util.Collection) or withMemberUsers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    memberUsers - A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withMemberUsers
```
public GroupMembers withMemberUsers(Collection<MemberUser> memberUsers)
```
    A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
    
    Parameters:
    
    memberUsers - A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3PathforGroupMembers
```
public void setS3PathforGroupMembers(S3Path s3PathforGroupMembers)
```
    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 .
    
    Parameters:
    
    s3PathforGroupMembers - 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.
  - getS3PathforGroupMembers
```
public S3Path getS3PathforGroupMembers()
```
    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 .
    
    Returns:
    
    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.
  - withS3PathforGroupMembers
```
public GroupMembers withS3PathforGroupMembers(S3Path s3PathforGroupMembers)
```
    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 .
    
    Parameters:
    
    s3PathforGroupMembers - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GroupMembers clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class GroupMembers

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GroupMembers

Method Detail

getMemberGroups

setMemberGroups

withMemberGroups

withMemberGroups

getMemberUsers

setMemberUsers

withMemberUsers

withMemberUsers

setS3PathforGroupMembers

getS3PathforGroupMembers

withS3PathforGroupMembers

toString

equals

hashCode

clone

marshall