software.amazon.awssdk.services.kendra.model

Class DescribeAccessControlConfigurationResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.kendra.model.KendraResponse

software.amazon.awssdk.services.kendra.model.DescribeAccessControlConfigurationResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeAccessControlConfigurationResponse.Builder,DescribeAccessControlConfigurationResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeAccessControlConfigurationResponse
extends KendraResponse
implements ToCopyableBuilder<DescribeAccessControlConfigurationResponse.Builder,DescribeAccessControlConfigurationResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeAccessControlConfigurationResponse.Builder

Method Summary

Modifier and Type	Method and Description
List<Principal>	accessControlList() Information on principals (users and/or groups) and which documents they should have access to.
static DescribeAccessControlConfigurationResponse.Builder	builder()
String	description() The description for the access control configuration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	errorMessage() The error message containing details if there are issues processing the access control configuration.
<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	name() The name for the access control configuration.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeAccessControlConfigurationResponse.Builder>	serializableBuilderClass()
DescribeAccessControlConfigurationResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.kendra.model.KendraResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

name

public final String name()

The name for the access control configuration.

Returns:

The name for the access control configuration.

description

public final String description()

The description for the access control configuration.

Returns:

The description for the access control configuration.

errorMessage

public final String errorMessage()

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.

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.

toBuilder

public DescribeAccessControlConfigurationResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeAccessControlConfigurationResponse.Builder,DescribeAccessControlConfigurationResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeAccessControlConfigurationResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeAccessControlConfigurationResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo