com.amazonaws.services.kendra.model

Class HierarchicalPrincipal

java.lang.Object

com.amazonaws.services.kendra.model.HierarchicalPrincipal

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HierarchicalPrincipal
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
HierarchicalPrincipal()

Method Summary

Modifier and Type	Method and Description
HierarchicalPrincipal	clone()
boolean	equals(Object obj)
List<Principal>	getPrincipalList() A list of principal lists that define the hierarchy for which documents users should have access to.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setPrincipalList(Collection<Principal> principalList) A list of principal lists that define the hierarchy for which documents users should have access to.
String	toString() Returns a string representation of this object.
HierarchicalPrincipal	withPrincipalList(Collection<Principal> principalList) A list of principal lists that define the hierarchy for which documents users should have access to.
HierarchicalPrincipal	withPrincipalList(Principal... principalList) A list of principal lists that define the hierarchy for which documents users should have access to.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HierarchicalPrincipal

public HierarchicalPrincipal()

Method Detail

getPrincipalList

public List<Principal> getPrincipalList()

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.

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.

setPrincipalList

public void setPrincipalList(Collection<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.

Parameters:

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.

withPrincipalList

public HierarchicalPrincipal withPrincipalList(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.

NOTE: This method appends the values to the existing list (if any). Use setPrincipalList(java.util.Collection) or withPrincipalList(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

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

withPrincipalList

public HierarchicalPrincipal withPrincipalList(Collection<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.

Parameters:

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.

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 HierarchicalPrincipal clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.