Class OAuthCredentialProvider

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

Configuration for an OAuth 2.0 credential provider used to authenticate tool calls.

See Also:

  • Method Details

    • providerArn

      public final String providerArn()

      The ARN of the OAuth 2.0 credential provider in AgentCore Identity.

      Returns:
      The ARN of the OAuth 2.0 credential provider in AgentCore Identity.

    • 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 2.0 scopes to request when obtaining an access token.

      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 2.0 scopes to request when obtaining an access token.

    • 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()

      Additional custom parameters to include in the OAuth 2.0 token request.

      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:
      Additional custom parameters to include in the OAuth 2.0 token request.

    • grantType

      public final OAuthGrantType grantType()

      The OAuth 2.0 grant type to use for authentication.

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

      Returns:
      The OAuth 2.0 grant type to use for authentication.
      See Also:

    • grantTypeAsString

      public final String grantTypeAsString()

      The OAuth 2.0 grant type to use for authentication.

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

      Returns:
      The OAuth 2.0 grant type to use for authentication.
      See Also:

    • defaultReturnUrl

      public final String defaultReturnUrl()

      The default return URL for the OAuth 2.0 authorization flow.

      Returns:
      The default return URL for the OAuth 2.0 authorization flow.

    • toBuilder

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

    • builder

      public static OAuthCredentialProvider.Builder builder()

    • serializableBuilderClass

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