Package software.amazon.awscdk.services.apigateway

Enum JsonSchemaType

java.lang.Object

java.lang.Enum<JsonSchemaType>

software.amazon.awscdk.services.apigateway.JsonSchemaType

All Implemented Interfaces:

Serializable, Comparable<JsonSchemaType>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:02.008Z")
@Stability(Stable)
public enum JsonSchemaType
extends Enum<JsonSchemaType>

Example:

 RestApi api;
 // We define the JSON Schema for the transformed valid response
 Model responseModel = api.addModel("ResponseModel", ModelOptions.builder()
         .contentType("application/json")
         .modelName("ResponseModel")
         .schema(JsonSchema.builder()
                 .schema(JsonSchemaVersion.DRAFT4)
                 .title("pollResponse")
                 .type(JsonSchemaType.OBJECT)
                 .properties(Map.of(
                         "state", JsonSchema.builder().type(JsonSchemaType.STRING).build(),
                         "greeting", JsonSchema.builder().type(JsonSchemaType.STRING).build()))
                 .build())
         .build());
 // We define the JSON Schema for the transformed error response
 Model errorResponseModel = api.addModel("ErrorResponseModel", ModelOptions.builder()
         .contentType("application/json")
         .modelName("ErrorResponseModel")
         .schema(JsonSchema.builder()
                 .schema(JsonSchemaVersion.DRAFT4)
                 .title("errorResponse")
                 .type(JsonSchemaType.OBJECT)
                 .properties(Map.of(
                         "state", JsonSchema.builder().type(JsonSchemaType.STRING).build(),
                         "message", JsonSchema.builder().type(JsonSchemaType.STRING).build()))
                 .build())
         .build());
 

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
ARRAY
BOOLEAN
INTEGER
NULL
NUMBER
OBJECT
STRING

Method Summary

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

NULL

@Stability(Stable)
public static final JsonSchemaType NULL

BOOLEAN

@Stability(Stable)
public static final JsonSchemaType BOOLEAN

OBJECT

@Stability(Stable)
public static final JsonSchemaType OBJECT

ARRAY

@Stability(Stable)
public static final JsonSchemaType ARRAY

NUMBER

@Stability(Stable)
public static final JsonSchemaType NUMBER

INTEGER

@Stability(Stable)
public static final JsonSchemaType INTEGER

STRING

@Stability(Stable)
public static final JsonSchemaType STRING

Method Details

values

public static JsonSchemaType[] values()

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

Returns:

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

valueOf

public static JsonSchemaType valueOf(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:

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

NullPointerException - if the argument is null