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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PortalOptions.Builder

Method Summary

Modifier and Type	Method	Description
static PortalOptions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends PortalOptions.Builder>	serializableBuilderClass()
SignInOptions	signInOptions()	A structure that describes the sign-in options for the access portal.
PortalOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ApplicationVisibility	visibility()	Indicates whether this application is visible in the access portal.
String	visibilityAsString()	Indicates whether this application is visible in the access portal.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

ApplicationVisibility

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:

ApplicationVisibility

toBuilder

public PortalOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PortalOptions.Builder,PortalOptions>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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