Interface PutGroupRequest.Builder

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

  • Method Details

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

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

    • type

      PutGroupRequest.Builder type(String type)

      The type of the group.

      Parameters:
      type - The type of the group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      PutGroupRequest.Builder type(MembershipType type)

      The type of the group.

      Parameters:
      type - The type of the group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • groupMembers

      default PutGroupRequest.Builder groupMembers(Consumer<GroupMembers.Builder> groupMembers)
      Sets the value of the GroupMembers property for this object. This is a convenience method that creates an instance of the GroupMembers.Builder avoiding the need to create one manually via GroupMembers.builder().

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

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

    • roleArn

      PutGroupRequest.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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