Interface PutGroupRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<PutGroupRequest.Builder,
,PutGroupRequest> QBusinessRequest.Builder
,SdkBuilder<PutGroupRequest.Builder,
,PutGroupRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
PutGroupRequest
-
Method Summary
Modifier and TypeMethodDescriptionapplicationId
(String applicationId) The identifier of the application in which the user and group mapping belongs.dataSourceId
(String dataSourceId) The identifier of the data source for which you want to map users to their groups.default PutGroupRequest.Builder
groupMembers
(Consumer<GroupMembers.Builder> groupMembers) Sets the value of the GroupMembers property for this object.groupMembers
(GroupMembers groupMembers) Sets the value of the GroupMembers property for this object.The list that contains your users or sub groups that belong the same group.The identifier of the index in which you want to map users to their groups.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The type of the group.type
(MembershipType type) The type of the group.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.qbusiness.model.QBusinessRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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
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
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
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
Sets the value of the GroupMembers property for this object. This is a convenience method that creates an instance of theGroupMembers.Builder
avoiding the need to create one manually viaGroupMembers.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed togroupMembers(GroupMembers)
.- Parameters:
groupMembers
- a consumer that will call methods onGroupMembers.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
PutGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-