software.amazon.awscdk.services.apigateway

Enum JsonSchemaType

java.lang.Object

java.lang.Enum<JsonSchemaType>

software.amazon.awscdk.services.apigateway.JsonSchemaType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JsonSchemaType>

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:20:03.577Z")
public enum JsonSchemaType
extends java.lang.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());
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARRAY
BOOLEAN
INTEGER
NULL
NUMBER
OBJECT
STRING

Method Summary

Modifier and Type	Method and Description
static JsonSchemaType	valueOf(java.lang.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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NULL

public static final JsonSchemaType NULL

BOOLEAN

public static final JsonSchemaType BOOLEAN

OBJECT

public static final JsonSchemaType OBJECT

ARRAY

public static final JsonSchemaType ARRAY

NUMBER

public static final JsonSchemaType NUMBER

INTEGER

public static final JsonSchemaType INTEGER

STRING

public static final JsonSchemaType STRING

Method Detail

values

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

Returns:

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

valueOf

public static JsonSchemaType 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