Package software.amazon.awssdk.services.kendra.model

Interface GroupMembers.Builder

    • Method Detail

      • memberGroups

        GroupMembers.Builder memberGroups​(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.

      • memberGroups

        GroupMembers.Builder memberGroups​(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.

      • memberGroups

        GroupMembers.Builder memberGroups​(Consumer<MemberGroup.Builder>... 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".

        This is a convenience method that creates an instance of the MemberGroup.Builder avoiding the need to create one manually via MemberGroup.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #memberGroups(List).

        Parameters:
        memberGroups - a consumer that will call methods on MemberGroup.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #memberGroups(java.util.Collection)

      • memberUsers

        GroupMembers.Builder memberUsers​(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.

      • memberUsers

        GroupMembers.Builder memberUsers​(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.

      • memberUsers

        GroupMembers.Builder memberUsers​(Consumer<MemberUser.Builder>... memberUsers)

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

        This is a convenience method that creates an instance of the MemberUser.Builder avoiding the need to create one manually via MemberUser.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #memberUsers(List).

        Parameters:
        memberUsers - a consumer that will call methods on MemberUser.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #memberUsers(java.util.Collection)

      • s3PathforGroupMembers

        GroupMembers.Builder s3PathforGroupMembers​(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.

      • s3PathforGroupMembers

        default GroupMembers.Builder s3PathforGroupMembers​(Consumer<S3Path.Builder> 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.

        This is a convenience method that creates an instance of the S3Path.Builder avoiding the need to create one manually via S3Path.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3PathforGroupMembers(S3Path).

        Parameters:
        s3PathforGroupMembers - a consumer that will call methods on S3Path.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        s3PathforGroupMembers(S3Path)