Package software.amazon.awssdk.services.kendra.model

Class CreateAccessControlConfigurationRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kendra.model.KendraRequest

software.amazon.awssdk.services.kendra.model.CreateAccessControlConfigurationRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAccessControlConfigurationRequest.Builder,CreateAccessControlConfigurationRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateAccessControlConfigurationRequest.Builder

Method Summary

Modifier and Type	Method	Description
List<Principal>	accessControlList()	Information on principals (users and/or groups) and which documents they should have access to.
static CreateAccessControlConfigurationRequest.Builder	builder()
String	clientToken()	A token that you provide to identify the request to create an access control configuration.
String	description()	A description for the access control configuration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAccessControlList()	For responses, this returns true if the service returned a value for the AccessControlList property.
int	hashCode()
boolean	hasHierarchicalAccessControlList()	For responses, this returns true if the service returned a value for the HierarchicalAccessControlList property.
List<HierarchicalPrincipal>	hierarchicalAccessControlList()	The list of principal lists that define the hierarchy for which documents users should have access to.
String	indexId()	The identifier of the index to create an access control configuration for your documents.
String	name()	A name for the access control configuration.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAccessControlConfigurationRequest.Builder>	serializableBuilderClass()
CreateAccessControlConfigurationRequest.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

indexId

public final String indexId()

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.

name

public final String name()

A name for the access control configuration.

Returns:

A name for the access control configuration.

description

public final String description()

A description for the access control configuration.

Returns:

A description for the access control configuration.

hasAccessControlList

public final boolean hasAccessControlList()

For responses, this returns true if the service returned a value for the AccessControlList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

accessControlList

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAccessControlList() method.

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.

hasHierarchicalAccessControlList

public final boolean hasHierarchicalAccessControlList()

For responses, this returns true if the service returned a value for the HierarchicalAccessControlList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

hierarchicalAccessControlList

public final List<HierarchicalPrincipal> hierarchicalAccessControlList()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHierarchicalAccessControlList() method.

Returns:

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

clientToken

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

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.

toBuilder

public CreateAccessControlConfigurationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAccessControlConfigurationRequest.Builder,CreateAccessControlConfigurationRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static CreateAccessControlConfigurationRequest.Builder builder()

serializableBuilderClass

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