JsonSchema.Builder (software.amazon.awscdk:aws-cdk-lib 2.0.0-rc.10 API)

java.lang.Object
- software.amazon.awscdk.services.apigateway.JsonSchema.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<JsonSchema>

Enclosing interface:: JsonSchema

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

A builder for JsonSchema

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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(JsonSchema contains)` Sets the value of `JsonSchema.getContains()`
`JsonSchema.Builder`	`contains(List<? extends 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(JsonSchema items)` Sets the value of `JsonSchema.getItems()`
`JsonSchema.Builder`	`items(List<? extends 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(JsonSchemaType type)` Sets the value of `JsonSchema.getType()`
`JsonSchema.Builder`	`type(List<? extends 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 Detail
  - Builder
```
public Builder()
```
- Method Detail
  - additionalItems
```
@Stability(value=Experimental)
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(value=Experimental)
public JsonSchema.Builder additionalProperties(Boolean additionalProperties)
```
    Sets the value of JsonSchema.getAdditionalProperties()
    
    Parameters:
    
    additionalProperties - the value to be set.
    
    Returns:
    
    this
  - additionalProperties
```
@Stability(value=Experimental)
public JsonSchema.Builder additionalProperties(JsonSchema additionalProperties)
```
    Sets the value of JsonSchema.getAdditionalProperties()
    
    Parameters:
    
    additionalProperties - the value to be set.
    
    Returns:
    
    this
  - allOf
```
@Stability(value=Experimental)
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(value=Experimental)
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(value=Experimental)
public JsonSchema.Builder contains(JsonSchema contains)
```
    Sets the value of JsonSchema.getContains()
    
    Parameters:
    
    contains - the value to be set.
    
    Returns:
    
    this
  - contains
```
@Stability(value=Experimental)
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(value=Experimental)
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(value=Experimental)
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(value=Experimental)
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(value=Experimental)
public JsonSchema.Builder description(String description)
```
    Sets the value of JsonSchema.getDescription()
    
    Parameters:
    
    description - the value to be set.
    
    Returns:
    
    this
  - enumValue
```
@Stability(value=Experimental)
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(value=Experimental)
public JsonSchema.Builder exclusiveMaximum(Boolean exclusiveMaximum)
```
    Sets the value of JsonSchema.getExclusiveMaximum()
    
    Parameters:
    
    exclusiveMaximum - the value to be set.
    
    Returns:
    
    this
  - exclusiveMinimum
```
@Stability(value=Experimental)
public JsonSchema.Builder exclusiveMinimum(Boolean exclusiveMinimum)
```
    Sets the value of JsonSchema.getExclusiveMinimum()
    
    Parameters:
    
    exclusiveMinimum - the value to be set.
    
    Returns:
    
    this
  - format
```
@Stability(value=Experimental)
public JsonSchema.Builder format(String format)
```
    Sets the value of JsonSchema.getFormat()
    
    Parameters:
    
    format - the value to be set.
    
    Returns:
    
    this
  - id
```
@Stability(value=Experimental)
public JsonSchema.Builder id(String id)
```
    Sets the value of JsonSchema.getId()
    
    Parameters:
    
    id - the value to be set.
    
    Returns:
    
    this
  - items
```
@Stability(value=Experimental)
public JsonSchema.Builder items(JsonSchema items)
```
    Sets the value of JsonSchema.getItems()
    
    Parameters:
    
    items - the value to be set.
    
    Returns:
    
    this
  - items
```
@Stability(value=Experimental)
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(value=Experimental)
public JsonSchema.Builder maximum(Number maximum)
```
    Sets the value of JsonSchema.getMaximum()
    
    Parameters:
    
    maximum - the value to be set.
    
    Returns:
    
    this
  - maxItems
```
@Stability(value=Experimental)
public JsonSchema.Builder maxItems(Number maxItems)
```
    Sets the value of JsonSchema.getMaxItems()
    
    Parameters:
    
    maxItems - the value to be set.
    
    Returns:
    
    this
  - maxLength
```
@Stability(value=Experimental)
public JsonSchema.Builder maxLength(Number maxLength)
```
    Sets the value of JsonSchema.getMaxLength()
    
    Parameters:
    
    maxLength - the value to be set.
    
    Returns:
    
    this
  - maxProperties
```
@Stability(value=Experimental)
public JsonSchema.Builder maxProperties(Number maxProperties)
```
    Sets the value of JsonSchema.getMaxProperties()
    
    Parameters:
    
    maxProperties - the value to be set.
    
    Returns:
    
    this
  - minimum
```
@Stability(value=Experimental)
public JsonSchema.Builder minimum(Number minimum)
```
    Sets the value of JsonSchema.getMinimum()
    
    Parameters:
    
    minimum - the value to be set.
    
    Returns:
    
    this
  - minItems
```
@Stability(value=Experimental)
public JsonSchema.Builder minItems(Number minItems)
```
    Sets the value of JsonSchema.getMinItems()
    
    Parameters:
    
    minItems - the value to be set.
    
    Returns:
    
    this
  - minLength
```
@Stability(value=Experimental)
public JsonSchema.Builder minLength(Number minLength)
```
    Sets the value of JsonSchema.getMinLength()
    
    Parameters:
    
    minLength - the value to be set.
    
    Returns:
    
    this
  - minProperties
```
@Stability(value=Experimental)
public JsonSchema.Builder minProperties(Number minProperties)
```
    Sets the value of JsonSchema.getMinProperties()
    
    Parameters:
    
    minProperties - the value to be set.
    
    Returns:
    
    this
  - multipleOf
```
@Stability(value=Experimental)
public JsonSchema.Builder multipleOf(Number multipleOf)
```
    Sets the value of JsonSchema.getMultipleOf()
    
    Parameters:
    
    multipleOf - the value to be set.
    
    Returns:
    
    this
  - not
```
@Stability(value=Experimental)
public JsonSchema.Builder not(JsonSchema not)
```
    Sets the value of JsonSchema.getNot()
    
    Parameters:
    
    not - the value to be set.
    
    Returns:
    
    this
  - oneOf
```
@Stability(value=Experimental)
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(value=Experimental)
public JsonSchema.Builder pattern(String pattern)
```
    Sets the value of JsonSchema.getPattern()
    
    Parameters:
    
    pattern - the value to be set.
    
    Returns:
    
    this
  - patternProperties
```
@Stability(value=Experimental)
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(value=Experimental)
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(value=Experimental)
public JsonSchema.Builder propertyNames(JsonSchema propertyNames)
```
    Sets the value of JsonSchema.getPropertyNames()
    
    Parameters:
    
    propertyNames - the value to be set.
    
    Returns:
    
    this
  - ref
```
@Stability(value=Experimental)
public JsonSchema.Builder ref(String ref)
```
    Sets the value of JsonSchema.getRef()
    
    Parameters:
    
    ref - the value to be set.
    
    Returns:
    
    this
  - required
```
@Stability(value=Experimental)
public JsonSchema.Builder required(List<String> required)
```
    Sets the value of JsonSchema.getRequired()
    
    Parameters:
    
    required - the value to be set.
    
    Returns:
    
    this
  - schema
```
@Stability(value=Experimental)
public JsonSchema.Builder schema(JsonSchemaVersion schema)
```
    Sets the value of JsonSchema.getSchema()
    
    Parameters:
    
    schema - the value to be set.
    
    Returns:
    
    this
  - title
```
@Stability(value=Experimental)
public JsonSchema.Builder title(String title)
```
    Sets the value of JsonSchema.getTitle()
    
    Parameters:
    
    title - the value to be set.
    
    Returns:
    
    this
  - type
```
@Stability(value=Experimental)
public JsonSchema.Builder type(JsonSchemaType type)
```
    Sets the value of JsonSchema.getType()
    
    Parameters:
    
    type - the value to be set.
    
    Returns:
    
    this
  - type
```
@Stability(value=Experimental)
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(value=Experimental)
public JsonSchema.Builder uniqueItems(Boolean uniqueItems)
```
    Sets the value of JsonSchema.getUniqueItems()
    
    Parameters:
    
    uniqueItems - the value to be set.
    
    Returns:
    
    this
  - build
```
@Stability(value=Experimental)
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

Class JsonSchema.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

additionalItems

additionalProperties

additionalProperties

allOf

anyOf

contains

contains

defaultValue

definitions

dependencies

description

enumValue

exclusiveMaximum

exclusiveMinimum

format

id

items

items

maximum

maxItems

maxLength

maxProperties

minimum

minItems

minLength

minProperties

multipleOf

not

oneOf

pattern

patternProperties

properties

propertyNames

ref

required

schema

title

type

type

uniqueItems

build