Package software.amazon.awssdk.services.appflow.model

Class OAuth2Defaults

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

Contains the default values required for OAuth 2.0 authentication.

See Also:

  • Method Details

    • hasOauthScopes

      public final boolean hasOauthScopes()
      For responses, this returns true if the service returned a value for the OauthScopes 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.

    • oauthScopes

      public final List<String> oauthScopes()

      OAuth 2.0 scopes that the connector supports.

      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 hasOauthScopes() method.

      Returns:
      OAuth 2.0 scopes that the connector supports.

    • hasTokenUrls

      public final boolean hasTokenUrls()
      For responses, this returns true if the service returned a value for the TokenUrls 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.

    • tokenUrls

      public final List<String> tokenUrls()

      Token URLs that can be used for OAuth 2.0 authentication.

      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 hasTokenUrls() method.

      Returns:
      Token URLs that can be used for OAuth 2.0 authentication.

    • hasAuthCodeUrls

      public final boolean hasAuthCodeUrls()
      For responses, this returns true if the service returned a value for the AuthCodeUrls 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.

    • authCodeUrls

      public final List<String> authCodeUrls()

      Auth code URLs that can be used for OAuth 2.0 authentication.

      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 hasAuthCodeUrls() method.

      Returns:
      Auth code URLs that can be used for OAuth 2.0 authentication.

    • oauth2GrantTypesSupported

      public final List<OAuth2GrantType> oauth2GrantTypesSupported()

      OAuth 2.0 grant types supported by the connector.

      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 hasOauth2GrantTypesSupported() method.

      Returns:
      OAuth 2.0 grant types supported by the connector.

    • hasOauth2GrantTypesSupported

      public final boolean hasOauth2GrantTypesSupported()
      For responses, this returns true if the service returned a value for the Oauth2GrantTypesSupported 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.

    • oauth2GrantTypesSupportedAsStrings

      public final List<String> oauth2GrantTypesSupportedAsStrings()

      OAuth 2.0 grant types supported by the connector.

      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 hasOauth2GrantTypesSupported() method.

      Returns:
      OAuth 2.0 grant types supported by the connector.

    • hasOauth2CustomProperties

      public final boolean hasOauth2CustomProperties()
      For responses, this returns true if the service returned a value for the Oauth2CustomProperties 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.

    • oauth2CustomProperties

      public final List<OAuth2CustomParameter> oauth2CustomProperties()

      List of custom parameters required for OAuth 2.0 authentication.

      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 hasOauth2CustomProperties() method.

      Returns:
      List of custom parameters required for OAuth 2.0 authentication.

    • toBuilder

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

    • builder

      public static OAuth2Defaults.Builder builder()

    • serializableBuilderClass

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