software.amazon.awssdk.services.servicecatalog.model

Class Principal

java.lang.Object

software.amazon.awssdk.services.servicecatalog.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>

Information about a principal.

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
static Principal.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	principalARN() The ARN of the principal (user, role, or group).
PrincipalType	principalType() The principal type.
String	principalTypeAsString() The principal type.
List<SdkField<?>>	sdkFields()
static Class<? extends Principal.Builder>	serializableBuilderClass()
Principal.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

principalARN

public final String 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 the PrincipalType is an IAM_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 the PrincipalType is an IAM_PATTERN.

For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.

principalType

public final PrincipalType principalType()

The principal type. The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.

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

Returns:

The principal type. The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.

See Also:

PrincipalType

principalTypeAsString

public final String principalTypeAsString()

The principal type. The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.

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

Returns:

The principal type. The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.

See Also:

PrincipalType

toBuilder

public Principal.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Principal.Builder,Principal>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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