@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.
Modifier and Type | Class and Description |
---|---|
static interface |
Principal.Builder |
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() |
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.
|
copy
public final String name()
The name of the user or group.
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()
.
PrincipalType
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()
.
PrincipalType
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()
.
ReadAccessType
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()
.
ReadAccessType
public Principal.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Principal.Builder,Principal>
public static Principal.Builder builder()
public static Class<? extends Principal.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.