Package software.amazon.smithy.openapi

Enum Class OpenApiConfig.HttpPrefixHeadersStrategy

java.lang.Object

java.lang.Enum<OpenApiConfig.HttpPrefixHeadersStrategy>

software.amazon.smithy.openapi.OpenApiConfig.HttpPrefixHeadersStrategy

All Implemented Interfaces:

Serializable, Comparable<OpenApiConfig.HttpPrefixHeadersStrategy>, Constable

Enclosing class:

OpenApiConfig

public static enum OpenApiConfig.HttpPrefixHeadersStrategy
extends Enum<OpenApiConfig.HttpPrefixHeadersStrategy>

Specifies what to do when the httpPrefixHeaders trait is found in a model.

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
FAIL	The default setting that causes the build to fail.
WARN	The header is omitted from the OpenAPI model and a warning is logged.

Method Summary

Modifier and Type	Method	Description
static OpenApiConfig.HttpPrefixHeadersStrategy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenApiConfig.HttpPrefixHeadersStrategy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FAIL

public static final OpenApiConfig.HttpPrefixHeadersStrategy FAIL

The default setting that causes the build to fail.

WARN

public static final OpenApiConfig.HttpPrefixHeadersStrategy WARN

The header is omitted from the OpenAPI model and a warning is logged.

Method Details

values

public static OpenApiConfig.HttpPrefixHeadersStrategy[] values()

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

Returns:

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

valueOf

public static OpenApiConfig.HttpPrefixHeadersStrategy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null