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

Class PutGroupRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.qbusiness.model.QBusinessRequest

software.amazon.awssdk.services.qbusiness.model.PutGroupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutGroupRequest.Builder,PutGroupRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutGroupRequest
extends QBusinessRequest
implements ToCopyableBuilder<PutGroupRequest.Builder,PutGroupRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutGroupRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The identifier of the application in which the user and group mapping belongs.
static PutGroupRequest.Builder	builder()
String	dataSourceId()	The identifier of the data source for which you want to map users to their groups.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
GroupMembers	groupMembers()	Returns the value of the GroupMembers property for this object.
String	groupName()	The list that contains your users or sub groups that belong the same group.
int	hashCode()
String	indexId()	The identifier of the index in which you want to map users to their groups.
List<SdkField<?>>	sdkFields()
static Class<? extends PutGroupRequest.Builder>	serializableBuilderClass()
PutGroupRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
MembershipType	type()	The type of the group.
String	typeAsString()	The type of the group.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

applicationId

public final String applicationId()

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

Returns:

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

dataSourceId

public final 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.

Returns:

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.

groupMembers

public final GroupMembers groupMembers()

Returns the value of the GroupMembers property for this object.

Returns:

The value of the GroupMembers property for this object.

groupName

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

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:

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.

indexId

public final String indexId()

The identifier of the index in which you want to map users to their groups.

Returns:

The identifier of the index in which you want to map users to their groups.

type

public final MembershipType type()

The type of the group.

If the service returns an enum value that is not available in the current SDK version, type will return MembershipType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the group.

See Also:

MembershipType

typeAsString

public final String typeAsString()

The type of the group.

If the service returns an enum value that is not available in the current SDK version, type will return MembershipType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the group.

See Also:

MembershipType

toBuilder

public PutGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutGroupRequest.Builder,PutGroupRequest>

Specified by:

toBuilder in class QBusinessRequest

builder

public static PutGroupRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutGroupRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo