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

Class OAuth2CustomParameter

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

Custom parameter required for OAuth 2.0 authentication.

See Also:

  • Method Details

    • key

      public final String key()

      The key of the custom parameter required for OAuth 2.0 authentication.

      Returns:
      The key of the custom parameter required for OAuth 2.0 authentication.

    • isRequired

      public final Boolean isRequired()

      Indicates whether the custom parameter for OAuth 2.0 authentication is required.

      Returns:
      Indicates whether the custom parameter for OAuth 2.0 authentication is required.

    • label

      public final String label()

      The label of the custom parameter used for OAuth 2.0 authentication.

      Returns:
      The label of the custom parameter used for OAuth 2.0 authentication.

    • description

      public final String description()

      A description about the custom parameter used for OAuth 2.0 authentication.

      Returns:
      A description about the custom parameter used for OAuth 2.0 authentication.

    • isSensitiveField

      public final Boolean isSensitiveField()

      Indicates whether this authentication custom parameter is a sensitive field.

      Returns:
      Indicates whether this authentication custom parameter is a sensitive field.

    • hasConnectorSuppliedValues

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

    • connectorSuppliedValues

      public final List<String> connectorSuppliedValues()

      Contains default values for this authentication parameter that are supplied 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 hasConnectorSuppliedValues() method.

      Returns:
      Contains default values for this authentication parameter that are supplied by the connector.

    • type

      public final OAuth2CustomPropType type()

      Indicates whether custom parameter is used with TokenUrl or AuthUrl.

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

      Returns:
      Indicates whether custom parameter is used with TokenUrl or AuthUrl.
      See Also:

    • typeAsString

      public final String typeAsString()

      Indicates whether custom parameter is used with TokenUrl or AuthUrl.

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

      Returns:
      Indicates whether custom parameter is used with TokenUrl or AuthUrl.
      See Also:

    • toBuilder

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

    • builder

      public static OAuth2CustomParameter.Builder builder()

    • serializableBuilderClass

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