com.amazonaws.services.kendra.model

Class Principal

java.lang.Object

com.amazonaws.services.kendra.model.Principal

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Provides user and group information for user context filtering.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Principal()

Method Summary

Modifier and Type	Method and Description
Principal	clone()
boolean	equals(Object obj)
String	getAccess() Whether to allow or deny document access to the principal.
String	getDataSourceId() The identifier of the data source the principal should access documents from.
String	getName() The name of the user or group.
String	getType() The type of principal.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAccess(String access) Whether to allow or deny document access to the principal.
void	setDataSourceId(String dataSourceId) The identifier of the data source the principal should access documents from.
void	setName(String name) The name of the user or group.
void	setType(String type) The type of principal.
String	toString() Returns a string representation of this object.
Principal	withAccess(ReadAccessType access) Whether to allow or deny document access to the principal.
Principal	withAccess(String access) Whether to allow or deny document access to the principal.
Principal	withDataSourceId(String dataSourceId) The identifier of the data source the principal should access documents from.
Principal	withName(String name) The name of the user or group.
Principal	withType(PrincipalType type) The type of principal.
Principal	withType(String type) The type of principal.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Principal

public Principal()

Method Detail

setName

public void setName(String name)

The name of the user or group.

Parameters:

name - The name of the user or group.

getName

public String getName()

The name of the user or group.

Returns:

The name of the user or group.

withName

public Principal withName(String name)

The name of the user or group.

Parameters:

name - The name of the user or group.

Returns:

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

setType

public void setType(String type)

The type of principal.

Parameters:

type - The type of principal.

See Also:

PrincipalType

getType

public String getType()

The type of principal.

Returns:

The type of principal.

See Also:

PrincipalType

withType

public Principal withType(String type)

The type of principal.

Parameters:

type - The type of principal.

Returns:

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

See Also:

PrincipalType

withType

public Principal withType(PrincipalType type)

The type of principal.

Parameters:

type - The type of principal.

Returns:

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

See Also:

PrincipalType

setAccess

public void setAccess(String access)

Whether to allow or deny document access to the principal.

Parameters:

access - Whether to allow or deny document access to the principal.

See Also:

ReadAccessType

getAccess

public String getAccess()

Whether to allow or deny document access to the principal.

Returns:

Whether to allow or deny document access to the principal.

See Also:

ReadAccessType

withAccess

public Principal withAccess(String access)

Whether to allow or deny document access to the principal.

Parameters:

access - Whether to allow or deny document access to the principal.

Returns:

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

See Also:

ReadAccessType

withAccess

public Principal withAccess(ReadAccessType access)

Whether to allow or deny document access to the principal.

Parameters:

access - Whether to allow or deny document access to the principal.

Returns:

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

See Also:

ReadAccessType

setDataSourceId

public void setDataSourceId(String dataSourceId)

The identifier of the data source the principal should access documents from.

Parameters:

dataSourceId - The identifier of the data source the principal should access documents from.

getDataSourceId

public String getDataSourceId()

The identifier of the data source the principal should access documents from.

Returns:

The identifier of the data source the principal should access documents from.

withDataSourceId

public Principal withDataSourceId(String dataSourceId)

The identifier of the data source the principal should access documents from.

Parameters:

dataSourceId - The identifier of the data source the principal should access documents from.

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 Principal 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.