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

Enum ApiGatewayConfig.ApiType

    • 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

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static ApiGatewayConfig.ApiType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ApiGatewayConfig.ApiType[] 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

      • 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

    • Method Detail

      • values

        public static ApiGatewayConfig.ApiType[] 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 (ApiGatewayConfig.ApiType c : ApiGatewayConfig.ApiType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

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