software.amazon.smithy.model.knowledge

Enum ServiceIndex.AuthSchemeMode

java.lang.Object

java.lang.Enum<ServiceIndex.AuthSchemeMode>

software.amazon.smithy.model.knowledge.ServiceIndex.AuthSchemeMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ServiceIndex.AuthSchemeMode>

Enclosing class:

ServiceIndex

public static enum ServiceIndex.AuthSchemeMode
extends java.lang.Enum<ServiceIndex.AuthSchemeMode>

Defines the type of auth schemes returned by ServiceIndex.getEffectiveAuthSchemes(software.amazon.smithy.model.shapes.ToShapeId).

Enum Constant Summary

Enum Constants

Enum Constant and Description
MODELED Use only the modeled auth schemes.
NO_AUTH_AWARE Use the modeled auth schemes, as well as the synthetic NoAuthTrait where applicable.

Method Summary

Modifier and Type	Method and Description
static ServiceIndex.AuthSchemeMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ServiceIndex.AuthSchemeMode[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MODELED

public static final ServiceIndex.AuthSchemeMode MODELED

Use only the modeled auth schemes. This is the default.

NO_AUTH_AWARE

public static final ServiceIndex.AuthSchemeMode NO_AUTH_AWARE

Use the modeled auth schemes, as well as the synthetic NoAuthTrait where applicable.

The Smithy Reference Architecture recommends using the smithy.api#noAuth auth scheme to represent no authentication which is available as the NoAuthTrait.

Method Detail

values

public static ServiceIndex.AuthSchemeMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ServiceIndex.AuthSchemeMode c : ServiceIndex.AuthSchemeMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static ServiceIndex.AuthSchemeMode valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null