Class UserIdentifier

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

The OAuth2.0 token or user ID that was used to generate the workload access token used for initiating the user authorization flow to retrieve OAuth2.0 tokens.

See Also:

  • Method Details

    • userToken

      public final String userToken()

      The OAuth2.0 token issued by the user’s identity provider that was used to generate the workload access token

      Returns:
      The OAuth2.0 token issued by the user’s identity provider that was used to generate the workload access token

    • userId

      public final String userId()

      The ID of the user for whom you have retrieved a workload access token for

      Returns:
      The ID of the user for whom you have retrieved a workload access token for

    • toBuilder

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

    • builder

      public static UserIdentifier.Builder builder()

    • serializableBuilderClass

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

    • fromUserToken

      public static UserIdentifier fromUserToken(String userToken)
      Create an instance of this class with userToken() initialized to the given value.

      The OAuth2.0 token issued by the user’s identity provider that was used to generate the workload access token

      Parameters:
      userToken - The OAuth2.0 token issued by the user’s identity provider that was used to generate the workload access token

    • fromUserId

      public static UserIdentifier fromUserId(String userId)
      Create an instance of this class with userId() initialized to the given value.

      The ID of the user for whom you have retrieved a workload access token for

      Parameters:
      userId - The ID of the user for whom you have retrieved a workload access token for

    • type

      public UserIdentifier.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be UserIdentifier.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be UserIdentifier.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

    • 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.