Class GetResourceOauth2TokenRequest

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

  • Method Details

    • workloadIdentityToken

      public final String workloadIdentityToken()

      The identity token of the workload from which you want to retrieve the OAuth2 token.

      Returns:
      The identity token of the workload from which you want to retrieve the OAuth2 token.

    • resourceCredentialProviderName

      public final String resourceCredentialProviderName()

      The name of the resource's credential provider.

      Returns:
      The name of the resource's credential provider.

    • hasScopes

      public final boolean hasScopes()
      For responses, this returns true if the service returned a value for the Scopes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • scopes

      public final List<String> scopes()

      The OAuth scopes being requested.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasScopes() method.

      Returns:
      The OAuth scopes being requested.

    • oauth2Flow

      public final Oauth2FlowType oauth2Flow()

      The type of flow to be performed.

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

      Returns:
      The type of flow to be performed.
      See Also:

    • oauth2FlowAsString

      public final String oauth2FlowAsString()

      The type of flow to be performed.

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

      Returns:
      The type of flow to be performed.
      See Also:

    • sessionUri

      public final String sessionUri()

      Unique identifier for the user's authentication session for retrieving OAuth2 tokens. This ID tracks the authorization flow state across multiple requests and responses during the OAuth2 authentication process.

      Returns:
      Unique identifier for the user's authentication session for retrieving OAuth2 tokens. This ID tracks the authorization flow state across multiple requests and responses during the OAuth2 authentication process.

    • resourceOauth2ReturnUrl

      public final String resourceOauth2ReturnUrl()

      The callback URL to redirect to after the OAuth 2.0 token retrieval is complete. This URL must be one of the provided URLs configured for the workload identity.

      Returns:
      The callback URL to redirect to after the OAuth 2.0 token retrieval is complete. This URL must be one of the provided URLs configured for the workload identity.

    • forceAuthentication

      public final Boolean forceAuthentication()

      Indicates whether to always initiate a new three-legged OAuth (3LO) flow, regardless of any existing session.

      Returns:
      Indicates whether to always initiate a new three-legged OAuth (3LO) flow, regardless of any existing session.

    • hasCustomParameters

      public final boolean hasCustomParameters()
      For responses, this returns true if the service returned a value for the CustomParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • customParameters

      public final Map<String,String> customParameters()

      A map of custom parameters to include in the authorization request to the resource credential provider. These parameters are in addition to the standard OAuth 2.0 flow parameters, and will not override them.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCustomParameters() method.

      Returns:
      A map of custom parameters to include in the authorization request to the resource credential provider. These parameters are in addition to the standard OAuth 2.0 flow parameters, and will not override them.

    • customState

      public final String customState()

      An opaque string that will be sent back to the callback URL provided in resourceOauth2ReturnUrl. This state should be used to protect the callback URL of your application against CSRF attacks by ensuring the response corresponds to the original request.

      Returns:
      An opaque string that will be sent back to the callback URL provided in resourceOauth2ReturnUrl. This state should be used to protect the callback URL of your application against CSRF attacks by ensuring the response corresponds to the original request.

    • toBuilder

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

    • builder

      public static GetResourceOauth2TokenRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.