Class Principal
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Principal.Builder,
Principal>
Provides user and group information for user context filtering.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ReadAccessType
access()
Whether to allow or deny document access to the principal.final String
Whether to allow or deny document access to the principal.static Principal.Builder
builder()
final String
The identifier of the data source the principal should access documents from.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
name()
The name of the user or group.static Class
<? extends Principal.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final PrincipalType
type()
The type of principal.final String
The type of principal.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the user or group.
- Returns:
- The name of the user or group.
-
type
The type of principal.
If the service returns an enum value that is not available in the current SDK version,
type
will returnPrincipalType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of principal.
- See Also:
-
typeAsString
The type of principal.
If the service returns an enum value that is not available in the current SDK version,
type
will returnPrincipalType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of principal.
- See Also:
-
access
Whether to allow or deny document access to the principal.
If the service returns an enum value that is not available in the current SDK version,
access
will returnReadAccessType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaccessAsString()
.- Returns:
- Whether to allow or deny document access to the principal.
- See Also:
-
accessAsString
Whether to allow or deny document access to the principal.
If the service returns an enum value that is not available in the current SDK version,
access
will returnReadAccessType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaccessAsString()
.- Returns:
- Whether to allow or deny document access to the principal.
- See Also:
-
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
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 interfaceToCopyableBuilder<Principal.Builder,
Principal> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-