com.amazonaws.services.kendra.model

Class UpdateAccessControlConfigurationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.model.UpdateAccessControlConfigurationRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateAccessControlConfigurationRequest
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
UpdateAccessControlConfigurationRequest()

Method Summary

Modifier and Type	Method and Description
UpdateAccessControlConfigurationRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<Principal>	getAccessControlList() Information you want to update on principals (users and/or groups) and which documents they should have access to.
String	getDescription() A new description for the access control configuration.
List<HierarchicalPrincipal>	getHierarchicalAccessControlList() The updated list of principal lists that define the hierarchy for which documents users should have access to.
String	getId() The identifier of the access control configuration you want to update.
String	getIndexId() The identifier of the index for an access control configuration.
String	getName() A new name for the access control configuration.
int	hashCode()
void	setAccessControlList(Collection<Principal> accessControlList) Information you want to update on principals (users and/or groups) and which documents they should have access to.
void	setDescription(String description) A new description for the access control configuration.
void	setHierarchicalAccessControlList(Collection<HierarchicalPrincipal> hierarchicalAccessControlList) The updated list of principal lists that define the hierarchy for which documents users should have access to.
void	setId(String id) The identifier of the access control configuration you want to update.
void	setIndexId(String indexId) The identifier of the index for an access control configuration.
void	setName(String name) A new name for the access control configuration.
String	toString() Returns a string representation of this object.
UpdateAccessControlConfigurationRequest	withAccessControlList(Collection<Principal> accessControlList) Information you want to update on principals (users and/or groups) and which documents they should have access to.
UpdateAccessControlConfigurationRequest	withAccessControlList(Principal... accessControlList) Information you want to update on principals (users and/or groups) and which documents they should have access to.
UpdateAccessControlConfigurationRequest	withDescription(String description) A new description for the access control configuration.
UpdateAccessControlConfigurationRequest	withHierarchicalAccessControlList(Collection<HierarchicalPrincipal> hierarchicalAccessControlList) The updated list of principal lists that define the hierarchy for which documents users should have access to.
UpdateAccessControlConfigurationRequest	withHierarchicalAccessControlList(HierarchicalPrincipal... hierarchicalAccessControlList) The updated list of principal lists that define the hierarchy for which documents users should have access to.
UpdateAccessControlConfigurationRequest	withId(String id) The identifier of the access control configuration you want to update.
UpdateAccessControlConfigurationRequest	withIndexId(String indexId) The identifier of the index for an access control configuration.
UpdateAccessControlConfigurationRequest	withName(String name) A new name for the access control configuration.

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

UpdateAccessControlConfigurationRequest

public UpdateAccessControlConfigurationRequest()

Method Detail

setIndexId

public void setIndexId(String indexId)

The identifier of the index for an access control configuration.

Parameters:

indexId - The identifier of the index for an access control configuration.

getIndexId

public String getIndexId()

The identifier of the index for an access control configuration.

Returns:

The identifier of the index for an access control configuration.

withIndexId

public UpdateAccessControlConfigurationRequest withIndexId(String indexId)

The identifier of the index for an access control configuration.

Parameters:

indexId - The identifier of the index for an access control configuration.

Returns:

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

setId

public void setId(String id)

The identifier of the access control configuration you want to update.

Parameters:

id - The identifier of the access control configuration you want to update.

getId

public String getId()

The identifier of the access control configuration you want to update.

Returns:

The identifier of the access control configuration you want to update.

withId

public UpdateAccessControlConfigurationRequest withId(String id)

The identifier of the access control configuration you want to update.

Parameters:

id - The identifier of the access control configuration you want to update.

Returns:

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

setName

public void setName(String name)

A new name for the access control configuration.

Parameters:

name - A new name for the access control configuration.

getName

public String getName()

A new name for the access control configuration.

Returns:

A new name for the access control configuration.

withName

public UpdateAccessControlConfigurationRequest withName(String name)

A new name for the access control configuration.

Parameters:

name - A new name for the access control configuration.

Returns:

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

setDescription

public void setDescription(String description)

A new description for the access control configuration.

Parameters:

description - A new description for the access control configuration.

getDescription

public String getDescription()

A new description for the access control configuration.

Returns:

A new description for the access control configuration.

withDescription

public UpdateAccessControlConfigurationRequest withDescription(String description)

A new description for the access control configuration.

Parameters:

description - A new description for the access control configuration.

Returns:

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

getAccessControlList

public List<Principal> getAccessControlList()

Information you want to update on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Returns:

Information you want to update on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

setAccessControlList

public void setAccessControlList(Collection<Principal> accessControlList)

Information you want to update on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Parameters:

accessControlList - Information you want to update on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

withAccessControlList

public UpdateAccessControlConfigurationRequest withAccessControlList(Principal... accessControlList)

Information you want to update on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

NOTE: This method appends the values to the existing list (if any). Use setAccessControlList(java.util.Collection) or withAccessControlList(java.util.Collection) if you want to override the existing values.

Parameters:

accessControlList - Information you want to update on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Returns:

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

withAccessControlList

public UpdateAccessControlConfigurationRequest withAccessControlList(Collection<Principal> accessControlList)

Information you want to update on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Parameters:

accessControlList - Information you want to update on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Returns:

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

getHierarchicalAccessControlList

public List<HierarchicalPrincipal> getHierarchicalAccessControlList()

The updated list of principal lists that define the hierarchy for which documents users should have access to.

Returns:

The updated list of principal lists that define the hierarchy for which documents users should have access to.

setHierarchicalAccessControlList

public void setHierarchicalAccessControlList(Collection<HierarchicalPrincipal> hierarchicalAccessControlList)

The updated list of principal lists that define the hierarchy for which documents users should have access to.

Parameters:

hierarchicalAccessControlList - The updated list of principal lists that define the hierarchy for which documents users should have access to.

withHierarchicalAccessControlList

public UpdateAccessControlConfigurationRequest withHierarchicalAccessControlList(HierarchicalPrincipal... hierarchicalAccessControlList)

The updated list of principal lists that define the hierarchy for which documents users should have access to.

NOTE: This method appends the values to the existing list (if any). Use setHierarchicalAccessControlList(java.util.Collection) or withHierarchicalAccessControlList(java.util.Collection) if you want to override the existing values.

Parameters:

hierarchicalAccessControlList - The updated list of principal lists that define the hierarchy for which documents users should have access to.

Returns:

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

withHierarchicalAccessControlList

public UpdateAccessControlConfigurationRequest withHierarchicalAccessControlList(Collection<HierarchicalPrincipal> hierarchicalAccessControlList)

The updated list of principal lists that define the hierarchy for which documents users should have access to.

Parameters:

hierarchicalAccessControlList - The updated list of principal lists that define the hierarchy for which documents users should have access to.

Returns:

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

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 UpdateAccessControlConfigurationRequest 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()