Package software.amazon.awssdk.services.ssoadmin.model

Class PortalOptions

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

A structure that describes the options for the access portal associated with an application.

See Also:

  • Method Details

    • signInOptions

      public final SignInOptions signInOptions()

      A structure that describes the sign-in options for the access portal.

      Returns:
      A structure that describes the sign-in options for the access portal.

    • visibility

      public final ApplicationVisibility visibility()

      Indicates whether this application is visible in the access portal.

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

      Returns:
      Indicates whether this application is visible in the access portal.
      See Also:

    • visibilityAsString

      public final String visibilityAsString()

      Indicates whether this application is visible in the access portal.

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

      Returns:
      Indicates whether this application is visible in the access portal.
      See Also:

    • toBuilder

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

    • builder

      public static PortalOptions.Builder builder()

    • serializableBuilderClass

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