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

Interface DeleteGroupRequest.Builder

    • Method Detail

      • applicationId

        DeleteGroupRequest.Builder applicationId​(String applicationId)

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

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

      • indexId

        DeleteGroupRequest.Builder indexId​(String indexId)

        The identifier of the index you want to delete the group from.

        Parameters:
        indexId - The identifier of the index you want to delete the group from.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • groupName

        DeleteGroupRequest.Builder groupName​(String groupName)

        The name of the group you want to delete.

        Parameters:
        groupName - The name of the group you want to delete.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataSourceId

        DeleteGroupRequest.Builder dataSourceId​(String dataSourceId)

        The identifier of the data source linked to the group

        A group can be tied to multiple data sources. You can delete a group from accessing documents in 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. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.

        Parameters:
        dataSourceId - The identifier of the data source linked to the group

        A group can be tied to multiple data sources. You can delete a group from accessing documents in 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. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.

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