software.amazon.awssdk.services.kendra.model

Class GroupMembers

java.lang.Object

software.amazon.awssdk.services.kendra.model.GroupMembers

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GroupMembers.Builder,GroupMembers>

@Generated(value="software.amazon.awssdk:codegen")
public final class GroupMembers
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GroupMembers.Builder,GroupMembers>

A list of users or sub groups 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GroupMembers.Builder

Method Summary

Modifier and Type	Method and Description
static GroupMembers.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMemberGroups() For responses, this returns true if the service returned a value for the MemberGroups property.
boolean	hasMemberUsers() For responses, this returns true if the service returned a value for the MemberUsers property.
List<MemberGroup>	memberGroups() A list of sub groups that belong to a group.
List<MemberUser>	memberUsers() A list of users that belong to a group.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends GroupMembers.Builder>	serializableBuilderClass()
GroupMembers.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasMemberGroups

public final boolean hasMemberGroups()

For responses, this returns true if the service returned a value for the MemberGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

memberGroups

public final List<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".

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMemberGroups() method.

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".

hasMemberUsers

public final boolean hasMemberUsers()

For responses, this returns true if the service returned a value for the MemberUsers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

memberUsers

public final List<MemberUser> memberUsers()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMemberUsers() method.

Returns:

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

s3PathforGroupMembers

public final 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 .

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.

toBuilder

public GroupMembers.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GroupMembers.Builder,GroupMembers>

builder

public static GroupMembers.Builder builder()

serializableBuilderClass

public static Class<? extends GroupMembers.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo