Class UserAccessResultItem

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

Contains information about a user's access to an application.

See Also:

  • Method Details

    • app

      public final String app()

      The name of the application.

      Returns:
      The name of the application.

    • tenantId

      public final String tenantId()

      The ID of the application tenant.

      Returns:
      The ID of the application tenant.

    • tenantDisplayName

      public final String tenantDisplayName()

      The display name of the tenant.

      Returns:
      The display name of the tenant.

    • taskId

      public final String taskId()

      The unique ID of the task.

      Returns:
      The unique ID of the task.

    • resultStatus

      public final ResultStatus resultStatus()

      The status of the user access result item.

      The following states are possible:

      • IN_PROGRESS: The user access task is in progress.

      • COMPLETED: The user access task completed successfully.

      • FAILED: The user access task failed.

      • EXPIRED: The user access task expired.

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

      Returns:
      The status of the user access result item.

      The following states are possible:

      • IN_PROGRESS: The user access task is in progress.

      • COMPLETED: The user access task completed successfully.

      • FAILED: The user access task failed.

      • EXPIRED: The user access task expired.

      See Also:

    • resultStatusAsString

      public final String resultStatusAsString()

      The status of the user access result item.

      The following states are possible:

      • IN_PROGRESS: The user access task is in progress.

      • COMPLETED: The user access task completed successfully.

      • FAILED: The user access task failed.

      • EXPIRED: The user access task expired.

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

      Returns:
      The status of the user access result item.

      The following states are possible:

      • IN_PROGRESS: The user access task is in progress.

      • COMPLETED: The user access task completed successfully.

      • FAILED: The user access task failed.

      • EXPIRED: The user access task expired.

      See Also:

    • email

      public final String email()

      The email address of the target user.

      Returns:
      The email address of the target user.

    • userId

      public final String userId()

      The unique ID of user.

      Returns:
      The unique ID of user.

    • userFullName

      public final String userFullName()

      The full name of the user.

      Returns:
      The full name of the user.

    • userFirstName

      public final String userFirstName()

      The first name of the user.

      Returns:
      The first name of the user.

    • userLastName

      public final String userLastName()

      The last name of the user.

      Returns:
      The last name of the user.

    • userStatus

      public final String userStatus()

      The status of the user returned by the application.

      Returns:
      The status of the user returned by the application.

    • taskError

      public final TaskError taskError()

      Contains information about an error returned from a user access task.

      Returns:
      Contains information about an error returned from a user access task.

    • toBuilder

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

    • builder

      public static UserAccessResultItem.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.