Package software.amazon.awssdk.services.macie2.model

Class UserIdentity

java.lang.Object
software.amazon.awssdk.services.macie2.model.UserIdentity
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UserIdentity.Builder,UserIdentity>
@Generated("software.amazon.awssdk:codegen") public final class UserIdentity extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UserIdentity.Builder,UserIdentity>

Provides information about the type and other characteristics of an entity that performed an action on an affected resource.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    UserIdentity.Builder
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final AssumedRole
    assumedRole()
    If the action was performed with temporary security credentials that were obtained using the AssumeRole operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.
    final AwsAccount
    awsAccount()
    If the action was performed using the credentials for another Amazon Web Services account, the details of that account.
    final AwsService
    awsService()
    If the action was performed by an Amazon Web Services account that belongs to an Amazon Web Service, the name of the service.
    static UserIdentity.Builder
    builder()
     
    final boolean
    equals(Object obj)
     
    final boolean
    equalsBySdkFields(Object obj)
    Indicates whether some other object is "equal to" this one by SDK fields.
    final FederatedUser
    federatedUser()
    If the action was performed with temporary security credentials that were obtained using the GetFederationToken operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.
    final <T> Optional<T>
    getValueForField(String fieldName, Class<T> clazz)
     
    final int
    hashCode()
     
    final IamUser
    iamUser()
    If the action was performed using the credentials for an Identity and Access Management (IAM) user, the name and other details about the user.
    final UserIdentityRoot
    root()
    If the action was performed using the credentials for your Amazon Web Services account, the details of your account.
    final List<SdkField<?>>
    sdkFields()
     
    static Class<? extends UserIdentity.Builder>
    serializableBuilderClass()
     
    UserIdentity.Builder
    toBuilder()
    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.
    final UserIdentityType
    type()
    The type of entity that performed the action.
    final String
    typeAsString()
    The type of entity that performed the action.

    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 Details

    • assumedRole

      public final AssumedRole assumedRole()

      If the action was performed with temporary security credentials that were obtained using the AssumeRole operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.

      Returns:
      If the action was performed with temporary security credentials that were obtained using the AssumeRole operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.

    • awsAccount

      public final AwsAccount awsAccount()

      If the action was performed using the credentials for another Amazon Web Services account, the details of that account.

      Returns:
      If the action was performed using the credentials for another Amazon Web Services account, the details of that account.

    • awsService

      public final AwsService awsService()

      If the action was performed by an Amazon Web Services account that belongs to an Amazon Web Service, the name of the service.

      Returns:
      If the action was performed by an Amazon Web Services account that belongs to an Amazon Web Service, the name of the service.

    • federatedUser

      public final FederatedUser federatedUser()

      If the action was performed with temporary security credentials that were obtained using the GetFederationToken operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.

      Returns:
      If the action was performed with temporary security credentials that were obtained using the GetFederationToken operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.

    • iamUser

      public final IamUser iamUser()

      If the action was performed using the credentials for an Identity and Access Management (IAM) user, the name and other details about the user.

      Returns:
      If the action was performed using the credentials for an Identity and Access Management (IAM) user, the name and other details about the user.

    • root

      public final UserIdentityRoot root()

      If the action was performed using the credentials for your Amazon Web Services account, the details of your account.

      Returns:
      If the action was performed using the credentials for your Amazon Web Services account, the details of your account.

    • type

      public final UserIdentityType type()

      The type of entity that performed the action.

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

      Returns:
      The type of entity that performed the action.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of entity that performed the action.

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

      Returns:
      The type of entity that performed the action.
      See Also:

    • toBuilder

      public UserIdentity.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<UserIdentity.Builder,UserIdentity>
      Returns:
      a builder for type T

    • builder

      public static UserIdentity.Builder builder()

    • serializableBuilderClass

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