Class GetResourceOauth2TokenResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.bedrockagentcore.model.BedrockAgentCoreResponse
software.amazon.awssdk.services.bedrockagentcore.model.GetResourceOauth2TokenResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetResourceOauth2TokenResponse.Builder,GetResourceOauth2TokenResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetResourceOauth2TokenResponse extends BedrockAgentCoreResponse implements ToCopyableBuilder<GetResourceOauth2TokenResponse.Builder,GetResourceOauth2TokenResponse>

  • Method Details

    • authorizationUrl

      public final String authorizationUrl()

      The URL to initiate the authorization process, provided when the access token requires user authorization.

      Returns:
      The URL to initiate the authorization process, provided when the access token requires user authorization.

    • accessToken

      public final String accessToken()

      The OAuth 2.0 access token to use.

      Returns:
      The OAuth 2.0 access token to use.

    • sessionUri

      public final String sessionUri()

      Unique identifier for the user's authorization session for retrieving OAuth2 tokens. This matches the sessionId from the request and can be used to track the session state.

      Returns:
      Unique identifier for the user's authorization session for retrieving OAuth2 tokens. This matches the sessionId from the request and can be used to track the session state.

    • sessionStatus

      public final SessionStatus sessionStatus()

      Status indicating whether the user's authorization session is in progress or has failed. This helps determine the next steps in the OAuth2 authentication flow.

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

      Returns:
      Status indicating whether the user's authorization session is in progress or has failed. This helps determine the next steps in the OAuth2 authentication flow.
      See Also:

    • sessionStatusAsString

      public final String sessionStatusAsString()

      Status indicating whether the user's authorization session is in progress or has failed. This helps determine the next steps in the OAuth2 authentication flow.

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

      Returns:
      Status indicating whether the user's authorization session is in progress or has failed. This helps determine the next steps in the OAuth2 authentication flow.
      See Also:

    • toBuilder

      public GetResourceOauth2TokenResponse.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<GetResourceOauth2TokenResponse.Builder,GetResourceOauth2TokenResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetResourceOauth2TokenResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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