Package software.amazon.awscdk.services.apigateway

Class JsonSchema.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.JsonSchema.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<JsonSchema>

Enclosing interface:

JsonSchema

@Stability(Stable)
public static final class JsonSchema.Builder
extends Object
implements software.amazon.jsii.Builder<JsonSchema>

A builder for JsonSchema

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
JsonSchema.Builder	additionalItems(List<? extends JsonSchema> additionalItems)	Sets the value of JsonSchema.getAdditionalItems()
JsonSchema.Builder	additionalProperties(Boolean additionalProperties)	Sets the value of JsonSchema.getAdditionalProperties()
JsonSchema.Builder	additionalProperties(JsonSchema additionalProperties)	Sets the value of JsonSchema.getAdditionalProperties()
JsonSchema.Builder	allOf(List<? extends JsonSchema> allOf)	Sets the value of JsonSchema.getAllOf()
JsonSchema.Builder	anyOf(List<? extends JsonSchema> anyOf)	Sets the value of JsonSchema.getAnyOf()
JsonSchema	build()	Builds the configured instance.
JsonSchema.Builder	contains(List<? extends JsonSchema> contains)	Sets the value of JsonSchema.getContains()
JsonSchema.Builder	contains(JsonSchema contains)	Sets the value of JsonSchema.getContains()
JsonSchema.Builder	defaultValue(Object defaultValue)	Sets the value of JsonSchema.getDefaultValue()
JsonSchema.Builder	definitions(Map<String,? extends JsonSchema> definitions)	Sets the value of JsonSchema.getDefinitions()
JsonSchema.Builder	dependencies(Map<String,? extends Object> dependencies)	Sets the value of JsonSchema.getDependencies()
JsonSchema.Builder	description(String description)	Sets the value of JsonSchema.getDescription()
JsonSchema.Builder	enumValue(List<? extends Object> enumValue)	Sets the value of JsonSchema.getEnumValue()
JsonSchema.Builder	exclusiveMaximum(Boolean exclusiveMaximum)	Sets the value of JsonSchema.getExclusiveMaximum()
JsonSchema.Builder	exclusiveMinimum(Boolean exclusiveMinimum)	Sets the value of JsonSchema.getExclusiveMinimum()
JsonSchema.Builder	format(String format)	Sets the value of JsonSchema.getFormat()
JsonSchema.Builder	id(String id)	Sets the value of JsonSchema.getId()
JsonSchema.Builder	items(List<? extends JsonSchema> items)	Sets the value of JsonSchema.getItems()
JsonSchema.Builder	items(JsonSchema items)	Sets the value of JsonSchema.getItems()
JsonSchema.Builder	maximum(Number maximum)	Sets the value of JsonSchema.getMaximum()
JsonSchema.Builder	maxItems(Number maxItems)	Sets the value of JsonSchema.getMaxItems()
JsonSchema.Builder	maxLength(Number maxLength)	Sets the value of JsonSchema.getMaxLength()
JsonSchema.Builder	maxProperties(Number maxProperties)	Sets the value of JsonSchema.getMaxProperties()
JsonSchema.Builder	minimum(Number minimum)	Sets the value of JsonSchema.getMinimum()
JsonSchema.Builder	minItems(Number minItems)	Sets the value of JsonSchema.getMinItems()
JsonSchema.Builder	minLength(Number minLength)	Sets the value of JsonSchema.getMinLength()
JsonSchema.Builder	minProperties(Number minProperties)	Sets the value of JsonSchema.getMinProperties()
JsonSchema.Builder	multipleOf(Number multipleOf)	Sets the value of JsonSchema.getMultipleOf()
JsonSchema.Builder	not(JsonSchema not)	Sets the value of JsonSchema.getNot()
JsonSchema.Builder	oneOf(List<? extends JsonSchema> oneOf)	Sets the value of JsonSchema.getOneOf()
JsonSchema.Builder	pattern(String pattern)	Sets the value of JsonSchema.getPattern()
JsonSchema.Builder	patternProperties(Map<String,? extends JsonSchema> patternProperties)	Sets the value of JsonSchema.getPatternProperties()
JsonSchema.Builder	properties(Map<String,? extends JsonSchema> properties)	Sets the value of JsonSchema.getProperties()
JsonSchema.Builder	propertyNames(JsonSchema propertyNames)	Sets the value of JsonSchema.getPropertyNames()
JsonSchema.Builder	ref(String ref)	Sets the value of JsonSchema.getRef()
JsonSchema.Builder	required(List<String> required)	Sets the value of JsonSchema.getRequired()
JsonSchema.Builder	schema(JsonSchemaVersion schema)	Sets the value of JsonSchema.getSchema()
JsonSchema.Builder	title(String title)	Sets the value of JsonSchema.getTitle()
JsonSchema.Builder	type(List<? extends JsonSchemaType> type)	Sets the value of JsonSchema.getType()
JsonSchema.Builder	type(JsonSchemaType type)	Sets the value of JsonSchema.getType()
JsonSchema.Builder	uniqueItems(Boolean uniqueItems)	Sets the value of JsonSchema.getUniqueItems()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

additionalItems

@Stability(Stable)
public JsonSchema.Builder additionalItems(List<? extends JsonSchema> additionalItems)

Sets the value of JsonSchema.getAdditionalItems()

Parameters:

additionalItems - the value to be set.

Returns:

this

additionalProperties

@Stability(Stable)
public JsonSchema.Builder additionalProperties(Boolean additionalProperties)

Sets the value of JsonSchema.getAdditionalProperties()

Parameters:

additionalProperties - the value to be set.

Returns:

this

additionalProperties

@Stability(Stable)
public JsonSchema.Builder additionalProperties(JsonSchema additionalProperties)

Sets the value of JsonSchema.getAdditionalProperties()

Parameters:

additionalProperties - the value to be set.

Returns:

this

allOf

@Stability(Stable)
public JsonSchema.Builder allOf(List<? extends JsonSchema> allOf)

Sets the value of JsonSchema.getAllOf()

Parameters:

allOf - the value to be set.

Returns:

this

anyOf

@Stability(Stable)
public JsonSchema.Builder anyOf(List<? extends JsonSchema> anyOf)

Sets the value of JsonSchema.getAnyOf()

Parameters:

anyOf - the value to be set.

Returns:

this

contains

@Stability(Stable)
public JsonSchema.Builder contains(JsonSchema contains)

Sets the value of JsonSchema.getContains()

Parameters:

contains - the value to be set.

Returns:

this

contains

@Stability(Stable)
public JsonSchema.Builder contains(List<? extends JsonSchema> contains)

Sets the value of JsonSchema.getContains()

Parameters:

contains - the value to be set.

Returns:

this

defaultValue

@Stability(Stable)
public JsonSchema.Builder defaultValue(Object defaultValue)

Sets the value of JsonSchema.getDefaultValue()

Parameters:

defaultValue - The default value if you use an enum.

Returns:

this

definitions

@Stability(Stable)
public JsonSchema.Builder definitions(Map<String,? extends JsonSchema> definitions)

Sets the value of JsonSchema.getDefinitions()

Parameters:

definitions - the value to be set.

Returns:

this

dependencies

@Stability(Stable)
public JsonSchema.Builder dependencies(Map<String,? extends Object> dependencies)

Sets the value of JsonSchema.getDependencies()

Parameters:

dependencies - the value to be set.

Returns:

this

description

@Stability(Stable)
public JsonSchema.Builder description(String description)

Sets the value of JsonSchema.getDescription()

Parameters:

description - the value to be set.

Returns:

this

enumValue

@Stability(Stable)
public JsonSchema.Builder enumValue(List<? extends Object> enumValue)

Sets the value of JsonSchema.getEnumValue()

Parameters:

enumValue - the value to be set.

Returns:

this

exclusiveMaximum

@Stability(Stable)
public JsonSchema.Builder exclusiveMaximum(Boolean exclusiveMaximum)

Sets the value of JsonSchema.getExclusiveMaximum()

Parameters:

exclusiveMaximum - the value to be set.

Returns:

this

exclusiveMinimum

@Stability(Stable)
public JsonSchema.Builder exclusiveMinimum(Boolean exclusiveMinimum)

Sets the value of JsonSchema.getExclusiveMinimum()

Parameters:

exclusiveMinimum - the value to be set.

Returns:

this

format

@Stability(Stable)
public JsonSchema.Builder format(String format)

Sets the value of JsonSchema.getFormat()

Parameters:

format - the value to be set.

Returns:

this

id

@Stability(Stable)
public JsonSchema.Builder id(String id)

Sets the value of JsonSchema.getId()

Parameters:

id - the value to be set.

Returns:

this

items

@Stability(Stable)
public JsonSchema.Builder items(JsonSchema items)

Sets the value of JsonSchema.getItems()

Parameters:

items - the value to be set.

Returns:

this

items

@Stability(Stable)
public JsonSchema.Builder items(List<? extends JsonSchema> items)

Sets the value of JsonSchema.getItems()

Parameters:

items - the value to be set.

Returns:

this

maximum

@Stability(Stable)
public JsonSchema.Builder maximum(Number maximum)

Sets the value of JsonSchema.getMaximum()

Parameters:

maximum - the value to be set.

Returns:

this

maxItems

@Stability(Stable)
public JsonSchema.Builder maxItems(Number maxItems)

Sets the value of JsonSchema.getMaxItems()

Parameters:

maxItems - the value to be set.

Returns:

this

maxLength

@Stability(Stable)
public JsonSchema.Builder maxLength(Number maxLength)

Sets the value of JsonSchema.getMaxLength()

Parameters:

maxLength - the value to be set.

Returns:

this

maxProperties

@Stability(Stable)
public JsonSchema.Builder maxProperties(Number maxProperties)

Sets the value of JsonSchema.getMaxProperties()

Parameters:

maxProperties - the value to be set.

Returns:

this

minimum

@Stability(Stable)
public JsonSchema.Builder minimum(Number minimum)

Sets the value of JsonSchema.getMinimum()

Parameters:

minimum - the value to be set.

Returns:

this

minItems

@Stability(Stable)
public JsonSchema.Builder minItems(Number minItems)

Sets the value of JsonSchema.getMinItems()

Parameters:

minItems - the value to be set.

Returns:

this

minLength

@Stability(Stable)
public JsonSchema.Builder minLength(Number minLength)

Sets the value of JsonSchema.getMinLength()

Parameters:

minLength - the value to be set.

Returns:

this

minProperties

@Stability(Stable)
public JsonSchema.Builder minProperties(Number minProperties)

Sets the value of JsonSchema.getMinProperties()

Parameters:

minProperties - the value to be set.

Returns:

this

multipleOf

@Stability(Stable)
public JsonSchema.Builder multipleOf(Number multipleOf)

Sets the value of JsonSchema.getMultipleOf()

Parameters:

multipleOf - the value to be set.

Returns:

this

not

@Stability(Stable)
public JsonSchema.Builder not(JsonSchema not)

Sets the value of JsonSchema.getNot()

Parameters:

not - the value to be set.

Returns:

this

oneOf

@Stability(Stable)
public JsonSchema.Builder oneOf(List<? extends JsonSchema> oneOf)

Sets the value of JsonSchema.getOneOf()

Parameters:

oneOf - the value to be set.

Returns:

this

pattern

@Stability(Stable)
public JsonSchema.Builder pattern(String pattern)

Sets the value of JsonSchema.getPattern()

Parameters:

pattern - the value to be set.

Returns:

this

patternProperties

@Stability(Stable)
public JsonSchema.Builder patternProperties(Map<String,? extends JsonSchema> patternProperties)

Sets the value of JsonSchema.getPatternProperties()

Parameters:

patternProperties - the value to be set.

Returns:

this

properties

@Stability(Stable)
public JsonSchema.Builder properties(Map<String,? extends JsonSchema> properties)

Sets the value of JsonSchema.getProperties()

Parameters:

properties - the value to be set.

Returns:

this

propertyNames

@Stability(Stable)
public JsonSchema.Builder propertyNames(JsonSchema propertyNames)

Sets the value of JsonSchema.getPropertyNames()

Parameters:

propertyNames - the value to be set.

Returns:

this

ref

@Stability(Stable)
public JsonSchema.Builder ref(String ref)

Sets the value of JsonSchema.getRef()

Parameters:

ref - the value to be set.

Returns:

this

required

@Stability(Stable)
public JsonSchema.Builder required(List<String> required)

Sets the value of JsonSchema.getRequired()

Parameters:

required - the value to be set.

Returns:

this

schema

@Stability(Stable)
public JsonSchema.Builder schema(JsonSchemaVersion schema)

Sets the value of JsonSchema.getSchema()

Parameters:

schema - the value to be set.

Returns:

this

title

@Stability(Stable)
public JsonSchema.Builder title(String title)

Sets the value of JsonSchema.getTitle()

Parameters:

title - the value to be set.

Returns:

this

type

@Stability(Stable)
public JsonSchema.Builder type(JsonSchemaType type)

Sets the value of JsonSchema.getType()

Parameters:

type - the value to be set.

Returns:

this

type

@Stability(Stable)
public JsonSchema.Builder type(List<? extends JsonSchemaType> type)

Sets the value of JsonSchema.getType()

Parameters:

type - the value to be set.

Returns:

this

uniqueItems

@Stability(Stable)
public JsonSchema.Builder uniqueItems(Boolean uniqueItems)

Sets the value of JsonSchema.getUniqueItems()

Parameters:

uniqueItems - the value to be set.

Returns:

this

build

@Stability(Stable)
public JsonSchema build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<JsonSchema>

Returns:

a new instance of JsonSchema

Throws:

NullPointerException - if any required attribute was not provided