Package software.amazon.smithy.aws.apigateway.openapi

Enum Class ApiGatewayConfig.ApiType

java.lang.Object

java.lang.Enum<ApiGatewayConfig.ApiType>

software.amazon.smithy.aws.apigateway.openapi.ApiGatewayConfig.ApiType

All Implemented Interfaces:

Serializable, Comparable<ApiGatewayConfig.ApiType>, Constable

Enclosing class:

ApiGatewayConfig

public static enum ApiGatewayConfig.ApiType
extends Enum<ApiGatewayConfig.ApiType>

The type of API Gateway service to generate.

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
DISABLED	Disables API Gateway OpenAPI plugins.
HTTP	Generates an OpenAPI model for an API Gateway "HTTP" API.
REST	Generates an OpenAPI model for an API Gateway "REST" API.

Method Summary

Modifier and Type	Method	Description
static ApiGatewayConfig.ApiType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ApiGatewayConfig.ApiType[]	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

REST

public static final ApiGatewayConfig.ApiType REST

Generates an OpenAPI model for an API Gateway "REST" API.

This is the default type of OpenAPI model to generate when not specified.

See Also:

• REST API

HTTP

public static final ApiGatewayConfig.ApiType HTTP

Generates an OpenAPI model for an API Gateway "HTTP" API.

This converter does not currently support for HTTP APIs.

See Also:

• HTTP API

DISABLED

public static final ApiGatewayConfig.ApiType DISABLED

Disables API Gateway OpenAPI plugins.

Method Details

values

public static ApiGatewayConfig.ApiType[] 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 ApiGatewayConfig.ApiType 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