Interface ListGroupsRequest.Builder

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

  • Method Details

    • applicationId

      ListGroupsRequest.Builder applicationId(String applicationId)

      The identifier of the application for getting a list of groups mapped to users.

      Parameters:
      applicationId - The identifier of the application for getting a list of groups mapped to users.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • indexId

      ListGroupsRequest.Builder indexId(String indexId)

      The identifier of the index for getting a list of groups mapped to users.

      Parameters:
      indexId - The identifier of the index for getting a list of groups mapped to users.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedEarlierThan

      ListGroupsRequest.Builder updatedEarlierThan(Instant updatedEarlierThan)

      The timestamp identifier used for the latest PUT or DELETE action for mapping users to their groups.

      Parameters:
      updatedEarlierThan - The timestamp identifier used for the latest PUT or DELETE action for mapping users to their groups.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSourceId

      ListGroupsRequest.Builder dataSourceId(String dataSourceId)

      The identifier of the data source for getting a list of groups mapped to users.

      Parameters:
      dataSourceId - The identifier of the data source for getting a list of groups mapped to users.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListGroupsRequest.Builder nextToken(String nextToken)

      If the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.

      Parameters:
      nextToken - If the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListGroupsRequest.Builder maxResults(Integer maxResults)

      The maximum number of returned groups that are mapped to users.

      Parameters:
      maxResults - The maximum number of returned groups that are mapped to users.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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