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

Class HierarchicalPrincipal

java.lang.Object

software.amazon.awssdk.services.kendra.model.HierarchicalPrincipal

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HierarchicalPrincipal.Builder,HierarchicalPrincipal>

@Generated("software.amazon.awssdk:codegen")
public final class HierarchicalPrincipal
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HierarchicalPrincipal.Builder,HierarchicalPrincipal>

Information to define the hierarchy for which documents users should have access to.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HierarchicalPrincipal.Builder

Method Summary

Modifier and Type	Method	Description
static HierarchicalPrincipal.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPrincipalList()	For responses, this returns true if the service returned a value for the PrincipalList property.
List<Principal>	principalList()	A list of principal lists that define the hierarchy for which documents users should have access to.
List<SdkField<?>>	sdkFields()
static Class<? extends HierarchicalPrincipal.Builder>	serializableBuilderClass()
HierarchicalPrincipal.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

hasPrincipalList

public final boolean hasPrincipalList()

For responses, this returns true if the service returned a value for the PrincipalList 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.

principalList

public final List<Principal> principalList()

A list of principal lists that define the hierarchy for which documents users should have access to. Each hierarchical list specifies which user or group has allow or deny access for each document.

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 hasPrincipalList() method.

Returns:

A list of principal lists that define the hierarchy for which documents users should have access to. Each hierarchical list specifies which user or group has allow or deny access for each document.

toBuilder

public HierarchicalPrincipal.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HierarchicalPrincipal.Builder,HierarchicalPrincipal>

builder

public static HierarchicalPrincipal.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo