Class Principal
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Principal.Builder,
Principal>
Information about a principal.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Principal.Builder
builder()
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
The ARN of the principal (user, role, or group).final PrincipalType
The principal type.final String
The principal type.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
principalARN
The ARN of the principal (user, role, or group). This field allows for an ARN with no
accountID
, with or without wildcard characters if thePrincipalType
is anIAM_PATTERN
.For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.
- Returns:
- The ARN of the principal (user, role, or group). This field allows for an ARN with no
accountID
, with or without wildcard characters if thePrincipalType
is anIAM_PATTERN
.For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.
-
principalType
The principal type. The supported value is
IAM
if you use a fully defined ARN, orIAM_PATTERN
if you use an ARN with noaccountID
, with or without wildcard characters.If the service returns an enum value that is not available in the current SDK version,
principalType
will returnPrincipalType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprincipalTypeAsString()
.- Returns:
- The principal type. The supported value is
IAM
if you use a fully defined ARN, orIAM_PATTERN
if you use an ARN with noaccountID
, with or without wildcard characters. - See Also:
-
principalTypeAsString
The principal type. The supported value is
IAM
if you use a fully defined ARN, orIAM_PATTERN
if you use an ARN with noaccountID
, with or without wildcard characters.If the service returns an enum value that is not available in the current SDK version,
principalType
will returnPrincipalType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprincipalTypeAsString()
.- Returns:
- The principal type. The supported value is
IAM
if you use a fully defined ARN, orIAM_PATTERN
if you use an ARN with noaccountID
, with or without wildcard characters. - See Also:
-
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
-