software.amazon.awscdk.services.apigateway

Enum JsonSchemaVersion

java.lang.Object

java.lang.Enum<JsonSchemaVersion>

software.amazon.awscdk.services.apigateway.JsonSchemaVersion

All Implemented Interfaces:

Serializable, Comparable<JsonSchemaVersion>

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.176Z")
 @Stability(value=Stable)
public enum JsonSchemaVersion
extends Enum<JsonSchemaVersion>

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
DRAFT4 In API Gateway models are defined using the JSON schema draft 4.
DRAFT7

Method Summary

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

DRAFT4

@Stability(value=Stable)
public static final JsonSchemaVersion DRAFT4

In API Gateway models are defined using the JSON schema draft 4.

See Also:

https://tools.ietf.org/html/draft-zyp-json-schema-04

DRAFT7

@Stability(value=Stable)
public static final JsonSchemaVersion DRAFT7

Method Detail

values

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

Returns:

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

valueOf

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