software.amazon.awssdk.services.codestar.model

Class UserProfileSummary

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<UserProfileSummary.Builder,UserProfileSummary>

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

Information about a user's profile in AWS CodeStar.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UserProfileSummary.Builder

Method Summary

Modifier and Type	Method and 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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
static Class<? extends UserProfileSummary.Builder>	serializableBuilderClass()
String	sshPublicKey() The SSH public key associated with the user in AWS CodeStar.
UserProfileSummary.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	userArn() The Amazon Resource Name (ARN) of the user in IAM.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

userArn

public 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 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 String emailAddress()

The email address associated with the user.

Returns:

The email address associated with the user.

sshPublicKey

public 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()

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 interface ToCopyableBuilder<UserProfileSummary.Builder,UserProfileSummary>

Returns:

a builder for type T

builder

public static UserProfileSummary.Builder builder()

serializableBuilderClass

public static Class<? extends UserProfileSummary.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.