com.amazonaws.services.qbusiness.model

Class PutGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.qbusiness.model.PutGroupRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutGroupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutGroupRequest()

Method Summary

Modifier and Type	Method and Description
PutGroupRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getApplicationId() The identifier of the application in which the user and group mapping belongs.
String	getDataSourceId() The identifier of the data source for which you want to map users to their groups.
GroupMembers	getGroupMembers()
String	getGroupName() The list that contains your users or sub groups that belong the same group.
String	getIndexId() The identifier of the index in which you want to map users to their groups.
String	getType() The type of the group.
int	hashCode()
void	setApplicationId(String applicationId) The identifier of the application in which the user and group mapping belongs.
void	setDataSourceId(String dataSourceId) The identifier of the data source for which you want to map users to their groups.
void	setGroupMembers(GroupMembers groupMembers)
void	setGroupName(String groupName) The list that contains your users or sub groups that belong the same group.
void	setIndexId(String indexId) The identifier of the index in which you want to map users to their groups.
void	setType(String type) The type of the group.
String	toString() Returns a string representation of this object.
PutGroupRequest	withApplicationId(String applicationId) The identifier of the application in which the user and group mapping belongs.
PutGroupRequest	withDataSourceId(String dataSourceId) The identifier of the data source for which you want to map users to their groups.
PutGroupRequest	withGroupMembers(GroupMembers groupMembers)
PutGroupRequest	withGroupName(String groupName) The list that contains your users or sub groups that belong the same group.
PutGroupRequest	withIndexId(String indexId) The identifier of the index in which you want to map users to their groups.
PutGroupRequest	withType(MembershipType type) The type of the group.
PutGroupRequest	withType(String type) The type of the group.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutGroupRequest

public PutGroupRequest()

Method Detail

setApplicationId

public void setApplicationId(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.

getApplicationId

public String getApplicationId()

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.

withApplicationId

public PutGroupRequest withApplicationId(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.

setDataSourceId

public void setDataSourceId(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.

getDataSourceId

public String getDataSourceId()

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.

withDataSourceId

public PutGroupRequest withDataSourceId(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.

setGroupMembers

public void setGroupMembers(GroupMembers groupMembers)

Parameters:

groupMembers -

getGroupMembers

public GroupMembers getGroupMembers()

Returns:

withGroupMembers

public PutGroupRequest withGroupMembers(GroupMembers groupMembers)

Parameters:

groupMembers -

Returns:

Returns a reference to this object so that method calls can be chained together.

setGroupName

public void setGroupName(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.

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.

getGroupName

public String getGroupName()

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.

withGroupName

public PutGroupRequest withGroupName(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.

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.

setIndexId

public void setIndexId(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.

getIndexId

public String getIndexId()

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.

withIndexId

public PutGroupRequest withIndexId(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.

setType

public void setType(String type)

The type of the group.

Parameters:

type - The type of the group.

See Also:

MembershipType

getType

public String getType()

The type of the group.

Returns:

The type of the group.

See Also:

MembershipType

withType

public PutGroupRequest withType(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:

MembershipType

withType

public PutGroupRequest withType(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:

MembershipType

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PutGroupRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()