software.amazon.awssdk.services.kendra.model

Class Principal

java.lang.Object

software.amazon.awssdk.services.kendra.model.Principal

All Implemented Interfaces:

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

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

Provides user and group information for document access filtering.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Principal.Builder

Method Summary

Modifier and Type	Method and Description
ReadAccessType	access() Whether to allow or deny access to the principal.
String	accessAsString() Whether to allow or deny access to the principal.
static Principal.Builder	builder()
String	dataSourceId() The identifier of the data source the principal should access documents from.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The name of the user or group.
List<SdkField<?>>	sdkFields()
static Class<? extends Principal.Builder>	serializableBuilderClass()
Principal.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
PrincipalType	type() The type of principal.
String	typeAsString() The type of principal.

Methods inherited from class java.lang.Object

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 of the user or group.

Returns:

The name of the user or group.

type

public final PrincipalType type()

The type of principal.

If the service returns an enum value that is not available in the current SDK version, type will return PrincipalType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of principal.

See Also:

PrincipalType

typeAsString

public final String typeAsString()

The type of principal.

If the service returns an enum value that is not available in the current SDK version, type will return PrincipalType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of principal.

See Also:

PrincipalType

access

public final ReadAccessType access()

Whether to allow or deny access to the principal.

If the service returns an enum value that is not available in the current SDK version, access will return ReadAccessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accessAsString().

Returns:

Whether to allow or deny access to the principal.

See Also:

ReadAccessType

accessAsString

public final String accessAsString()

Whether to allow or deny access to the principal.

If the service returns an enum value that is not available in the current SDK version, access will return ReadAccessType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accessAsString().

Returns:

Whether to allow or deny access to the principal.

See Also:

ReadAccessType

dataSourceId

public final String dataSourceId()

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.

toBuilder

public Principal.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Principal.Builder,Principal>

Returns:

a builder for type T

builder

public static Principal.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.