software.amazon.smithy.openapi

Enum OpenApiConfig.HttpPrefixHeadersStrategy

java.lang.Object

java.lang.Enum<OpenApiConfig.HttpPrefixHeadersStrategy>

software.amazon.smithy.openapi.OpenApiConfig.HttpPrefixHeadersStrategy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OpenApiConfig.HttpPrefixHeadersStrategy>

Enclosing class:

OpenApiConfig

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

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

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static OpenApiConfig.HttpPrefixHeadersStrategy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OpenApiConfig.HttpPrefixHeadersStrategy[]	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

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 Detail

values

public static OpenApiConfig.HttpPrefixHeadersStrategy[] 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 (OpenApiConfig.HttpPrefixHeadersStrategy c : OpenApiConfig.HttpPrefixHeadersStrategy.values())
    System.out.println(c);

Returns:

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

valueOf

public static OpenApiConfig.HttpPrefixHeadersStrategy 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