com.amazonaws.services.kendra.model

Class DescribeAccessControlConfigurationResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.kendra.model.DescribeAccessControlConfigurationResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeAccessControlConfigurationResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeAccessControlConfigurationResult()

Method Summary

Modifier and Type	Method and Description
DescribeAccessControlConfigurationResult	clone()
boolean	equals(Object obj)
List<Principal>	getAccessControlList() Information on principals (users and/or groups) and which documents they should have access to.
String	getDescription() The description for the access control configuration.
String	getErrorMessage() The error message containing details if there are issues processing the access control configuration.
List<HierarchicalPrincipal>	getHierarchicalAccessControlList() The list of principal lists that define the hierarchy for which documents users should have access to.
String	getName() The name for the access control configuration.
int	hashCode()
void	setAccessControlList(Collection<Principal> accessControlList) Information on principals (users and/or groups) and which documents they should have access to.
void	setDescription(String description) The description for the access control configuration.
void	setErrorMessage(String errorMessage) The error message containing details if there are issues processing the access control configuration.
void	setHierarchicalAccessControlList(Collection<HierarchicalPrincipal> hierarchicalAccessControlList) The list of principal lists that define the hierarchy for which documents users should have access to.
void	setName(String name) The name for the access control configuration.
String	toString() Returns a string representation of this object.
DescribeAccessControlConfigurationResult	withAccessControlList(Collection<Principal> accessControlList) Information on principals (users and/or groups) and which documents they should have access to.
DescribeAccessControlConfigurationResult	withAccessControlList(Principal... accessControlList) Information on principals (users and/or groups) and which documents they should have access to.
DescribeAccessControlConfigurationResult	withDescription(String description) The description for the access control configuration.
DescribeAccessControlConfigurationResult	withErrorMessage(String errorMessage) The error message containing details if there are issues processing the access control configuration.
DescribeAccessControlConfigurationResult	withHierarchicalAccessControlList(Collection<HierarchicalPrincipal> hierarchicalAccessControlList) The list of principal lists that define the hierarchy for which documents users should have access to.
DescribeAccessControlConfigurationResult	withHierarchicalAccessControlList(HierarchicalPrincipal... hierarchicalAccessControlList) The list of principal lists that define the hierarchy for which documents users should have access to.
DescribeAccessControlConfigurationResult	withName(String name) The name for the access control configuration.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeAccessControlConfigurationResult

public DescribeAccessControlConfigurationResult()

Method Detail

setName

public void setName(String name)

The name for the access control configuration.

Parameters:

name - The name for the access control configuration.

getName

public String getName()

The name for the access control configuration.

Returns:

The name for the access control configuration.

withName

public DescribeAccessControlConfigurationResult withName(String name)

The name for the access control configuration.

Parameters:

name - The 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)

The description for the access control configuration.

Parameters:

description - The description for the access control configuration.

getDescription

public String getDescription()

The description for the access control configuration.

Returns:

The description for the access control configuration.

withDescription

public DescribeAccessControlConfigurationResult withDescription(String description)

The description for the access control configuration.

Parameters:

description - The description for the access control configuration.

Returns:

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

setErrorMessage

public void setErrorMessage(String errorMessage)

The error message containing details if there are issues processing the access control configuration.

Parameters:

errorMessage - The error message containing details if there are issues processing the access control configuration.

getErrorMessage

public String getErrorMessage()

The error message containing details if there are issues processing the access control configuration.

Returns:

The error message containing details if there are issues processing the access control configuration.

withErrorMessage

public DescribeAccessControlConfigurationResult withErrorMessage(String errorMessage)

The error message containing details if there are issues processing the access control configuration.

Parameters:

errorMessage - The error message containing details if there are issues processing 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 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 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 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 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 DescribeAccessControlConfigurationResult withAccessControlList(Principal... accessControlList)

Information 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 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 DescribeAccessControlConfigurationResult withAccessControlList(Collection<Principal> accessControlList)

Information 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 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 list of principal lists that define the hierarchy for which documents users should have access to.

Returns:

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

setHierarchicalAccessControlList

public void setHierarchicalAccessControlList(Collection<HierarchicalPrincipal> hierarchicalAccessControlList)

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

Parameters:

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

withHierarchicalAccessControlList

public DescribeAccessControlConfigurationResult withHierarchicalAccessControlList(HierarchicalPrincipal... hierarchicalAccessControlList)

The 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 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 DescribeAccessControlConfigurationResult withHierarchicalAccessControlList(Collection<HierarchicalPrincipal> hierarchicalAccessControlList)

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

Parameters:

hierarchicalAccessControlList - The 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 DescribeAccessControlConfigurationResult clone()

Overrides:

clone in class Object