Interface DeleteGroupRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DeleteGroupRequest.Builder,DeleteGroupRequest>, QBusinessRequest.Builder, SdkBuilder<DeleteGroupRequest.Builder,DeleteGroupRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DeleteGroupRequest
@Mutable @NotThreadSafe public static interface DeleteGroupRequest.Builder extends QBusinessRequest.Builder, SdkPojo, CopyableBuilder<DeleteGroupRequest.Builder,DeleteGroupRequest>

  • Method Details

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

    • overrideConfiguration

      DeleteGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DeleteGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.