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:
  • Method Details

    • 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()
      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 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)
      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 an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.