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

Class DeleteGroupRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeleteGroupRequest.Builder,DeleteGroupRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeleteGroupRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The identifier of the application in which the group mapping belongs.
static DeleteGroupRequest.Builder	builder()
String	dataSourceId()	The identifier of the data source linked to the group
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	groupName()	The name of the group you want to delete.
int	hashCode()
String	indexId()	The identifier of the index you want to delete the group from.
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteGroupRequest.Builder>	serializableBuilderClass()
DeleteGroupRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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 group mapping belongs.

Returns:

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

dataSourceId

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

Returns:

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.

groupName

public final String groupName()

The name of the group you want to delete.

Returns:

The name of the group you want to delete.

indexId

public final String indexId()

The identifier of the index you want to delete the group from.

Returns:

The identifier of the index you want to delete the group from.

toBuilder

public DeleteGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteGroupRequest.Builder,DeleteGroupRequest>

Specified by:

toBuilder in class QBusinessRequest

builder

public static DeleteGroupRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DeleteGroupRequest.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