com.amazonaws.services.kendra.model

Class CreateAccessControlConfigurationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.model.CreateAccessControlConfigurationRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
CreateAccessControlConfigurationRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<Principal>	getAccessControlList() Information on principals (users and/or groups) and which documents they should have access to.
String	getClientToken() A token that you provide to identify the request to create an access control configuration.
String	getDescription() A description for 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	getIndexId() The identifier of the index to create an access control configuration for your documents.
String	getName() A 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	setClientToken(String clientToken) A token that you provide to identify the request to create an access control configuration.
void	setDescription(String description) A description for 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	setIndexId(String indexId) The identifier of the index to create an access control configuration for your documents.
void	setName(String name) A name for the access control configuration.
String	toString() Returns a string representation of this object.
CreateAccessControlConfigurationRequest	withAccessControlList(Collection<Principal> accessControlList) Information on principals (users and/or groups) and which documents they should have access to.
CreateAccessControlConfigurationRequest	withAccessControlList(Principal... accessControlList) Information on principals (users and/or groups) and which documents they should have access to.
CreateAccessControlConfigurationRequest	withClientToken(String clientToken) A token that you provide to identify the request to create an access control configuration.
CreateAccessControlConfigurationRequest	withDescription(String description) A description for the access control configuration.
CreateAccessControlConfigurationRequest	withHierarchicalAccessControlList(Collection<HierarchicalPrincipal> hierarchicalAccessControlList) The list of principal lists that define the hierarchy for which documents users should have access to.
CreateAccessControlConfigurationRequest	withHierarchicalAccessControlList(HierarchicalPrincipal... hierarchicalAccessControlList) The list of principal lists that define the hierarchy for which documents users should have access to.
CreateAccessControlConfigurationRequest	withIndexId(String indexId) The identifier of the index to create an access control configuration for your documents.
CreateAccessControlConfigurationRequest	withName(String name) A 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

CreateAccessControlConfigurationRequest

public CreateAccessControlConfigurationRequest()

Method Detail

setIndexId

public void setIndexId(String indexId)

The identifier of the index to create an access control configuration for your documents.

Parameters:

indexId - The identifier of the index to create an access control configuration for your documents.

getIndexId

public String getIndexId()

The identifier of the index to create an access control configuration for your documents.

Returns:

The identifier of the index to create an access control configuration for your documents.

withIndexId

public CreateAccessControlConfigurationRequest withIndexId(String indexId)

The identifier of the index to create an access control configuration for your documents.

Parameters:

indexId - The identifier of the index to create an access control configuration for your documents.

Returns:

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

setName

public void setName(String name)

A name for the access control configuration.

Parameters:

name - A name for the access control configuration.

getName

public String getName()

A name for the access control configuration.

Returns:

A name for the access control configuration.

withName

public CreateAccessControlConfigurationRequest withName(String name)

A name for the access control configuration.

Parameters:

name - A 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 description for the access control configuration.

Parameters:

description - A description for the access control configuration.

getDescription

public String getDescription()

A description for the access control configuration.

Returns:

A description for the access control configuration.

withDescription

public CreateAccessControlConfigurationRequest withDescription(String description)

A description for the access control configuration.

Parameters:

description - A 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 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 CreateAccessControlConfigurationRequest 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 CreateAccessControlConfigurationRequest 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 CreateAccessControlConfigurationRequest 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 CreateAccessControlConfigurationRequest 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.

setClientToken

public void setClientToken(String clientToken)

A token that you provide to identify the request to create an access control configuration. Multiple calls to the CreateAccessControlConfiguration API with the same client token will create only one access control configuration.

Parameters:

clientToken - A token that you provide to identify the request to create an access control configuration. Multiple calls to the CreateAccessControlConfiguration API with the same client token will create only one access control configuration.

getClientToken

public String getClientToken()

A token that you provide to identify the request to create an access control configuration. Multiple calls to the CreateAccessControlConfiguration API with the same client token will create only one access control configuration.

Returns:

A token that you provide to identify the request to create an access control configuration. Multiple calls to the CreateAccessControlConfiguration API with the same client token will create only one access control configuration.

withClientToken

public CreateAccessControlConfigurationRequest withClientToken(String clientToken)

A token that you provide to identify the request to create an access control configuration. Multiple calls to the CreateAccessControlConfiguration API with the same client token will create only one access control configuration.

Parameters:

clientToken - A token that you provide to identify the request to create an access control configuration. Multiple calls to the CreateAccessControlConfiguration API with the same client token will create only one access control configuration.

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