Package software.amazon.awssdk.services.codestar.model

Class UserProfileSummary

java.lang.Object

software.amazon.awssdk.services.codestar.model.UserProfileSummary

All Implemented Interfaces:

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

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

Information about a user's profile in AWS CodeStar.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UserProfileSummary.Builder

Method Summary

Modifier and Type	Method	Description
static UserProfileSummary.Builder	builder()
String	displayName()	The display name of a user in AWS CodeStar.
String	emailAddress()	The email address associated with the user.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends UserProfileSummary.Builder>	serializableBuilderClass()
String	sshPublicKey()	The SSH public key associated with the user in AWS CodeStar.
UserProfileSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userArn()	The Amazon Resource Name (ARN) of the user in IAM.

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

userArn

public final String userArn()

The Amazon Resource Name (ARN) of the user in IAM.

Returns:

The Amazon Resource Name (ARN) of the user in IAM.

displayName

public final String displayName()

The display name of a user in AWS CodeStar. For example, this could be set to both first and last name ("Mary Major") or a single name ("Mary"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major") would generate an initial icon using the first character and the first character after the space ("MJ", not "MM").

Returns:

The display name of a user in AWS CodeStar. For example, this could be set to both first and last name ("Mary Major") or a single name ("Mary"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major") would generate an initial icon using the first character and the first character after the space ("MJ", not "MM").

emailAddress

public final String emailAddress()

The email address associated with the user.

Returns:

The email address associated with the user.

sshPublicKey

public final String sshPublicKey()

The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.

Returns:

The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.

toBuilder

public UserProfileSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UserProfileSummary.Builder,UserProfileSummary>

builder

public static UserProfileSummary.Builder builder()

serializableBuilderClass

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