Package com.okta.sdk.resource.model

Enum SamlRelayStateFormat

java.lang.Object

java.lang.Enum<SamlRelayStateFormat>

com.okta.sdk.resource.model.SamlRelayStateFormat

All Implemented Interfaces:

Serializable, Comparable<SamlRelayStateFormat>, java.lang.constant.Constable

public enum SamlRelayStateFormat
extends Enum<SamlRelayStateFormat>

The format used to generate the `relayState` in the SAML request. The `FROM_URL` format is used if this value is null.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FROM_URL
OPAQUE
UNKNOWN_DEFAULT_OPEN_API

Method Summary

Modifier and Type	Method	Description
static SamlRelayStateFormat	fromValue(String value)
String	getValue()
String	toString()
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
static SamlRelayStateFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SamlRelayStateFormat[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FROM_URL

public static final SamlRelayStateFormat FROM_URL

OPAQUE

public static final SamlRelayStateFormat OPAQUE

UNKNOWN_DEFAULT_OPEN_API

public static final SamlRelayStateFormat UNKNOWN_DEFAULT_OPEN_API

Method Details

values

public static SamlRelayStateFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SamlRelayStateFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

toString

public String toString()

Overrides:

toString in class Enum<SamlRelayStateFormat>

fromValue

public static SamlRelayStateFormat fromValue(String value)

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string