Package software.amazon.awssdk.services.qbusiness.model

Interface PutGroupRequest.Builder

    • Method Detail

      • applicationId

        PutGroupRequest.Builder applicationId​(String applicationId)

        The identifier of the application in which the user and group mapping belongs.

        Parameters:
        applicationId - The identifier of the application in which the user and group mapping belongs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • indexId

        PutGroupRequest.Builder indexId​(String indexId)

        The identifier of the index in which you want to map users to their groups.

        Parameters:
        indexId - The identifier of the index in which you want to map users to their groups.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • groupName

        PutGroupRequest.Builder groupName​(String groupName)

        The list that contains your users or sub groups that belong the same group. For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".

        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.

        Parameters:
        groupName - The list that contains your users or sub groups that belong the same group. For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".

        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataSourceId

        PutGroupRequest.Builder dataSourceId​(String dataSourceId)

        The identifier of the data source for which you want to map users to their groups. This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.

        Parameters:
        dataSourceId - The identifier of the data source for which you want to map users to their groups. This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • groupMembers

        PutGroupRequest.Builder groupMembers​(GroupMembers groupMembers)
        Sets the value of the GroupMembers property for this object.
        Parameters:
        groupMembers - The new value for the GroupMembers property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.