Package software.amazon.smithy.openapi.model

Class ParameterObject.Builder

java.lang.Object

software.amazon.smithy.openapi.model.Component.Builder<ParameterObject.Builder,ParameterObject>

software.amazon.smithy.openapi.model.ParameterObject.Builder

All Implemented Interfaces:

SmithyBuilder<ParameterObject>

Enclosing class:

ParameterObject

public static final class ParameterObject.Builder
extends Component.Builder<ParameterObject.Builder,ParameterObject>

Method Summary

Modifier and Type	Method	Description
ParameterObject.Builder	allowEmptyValue(boolean allowEmptyValue)
ParameterObject.Builder	allowReserved(boolean allowReserved)
ParameterObject	build()	Creates an immutable object that is created from the properties that have been set on the builder.
ParameterObject.Builder	content(Map<String,MediaTypeObject> content)
ParameterObject.Builder	deprecated(boolean deprecated)
ParameterObject.Builder	description(String description)
ParameterObject.Builder	example(Node example)
ParameterObject.Builder	examples(Map<String,Node> examples)
ParameterObject.Builder	explode(boolean explode)
ParameterObject.Builder	in(String in)
ParameterObject.Builder	name(String name)
ParameterObject.Builder	putContent(String name, MediaTypeObject mediaTypeObject)
ParameterObject.Builder	putExample(String name, Node example)
ParameterObject.Builder	required(boolean required)
ParameterObject.Builder	schema(Schema schema)
ParameterObject.Builder	style(String style)

Methods inherited from class software.amazon.smithy.openapi.model.Component.Builder

extensions, extensions, getExtensions, putExtension, putExtension, putExtension, putExtension, removeExtension

Methods inherited from class java.lang.Object

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

Method Details

build

public ParameterObject build()

Description copied from interface: SmithyBuilder

Creates an immutable object that is created from the properties that have been set on the builder.

Returns:

an instance of T

name

public ParameterObject.Builder name(String name)

in

public ParameterObject.Builder in(String in)

description

public ParameterObject.Builder description(String description)

required

public ParameterObject.Builder required(boolean required)

deprecated

public ParameterObject.Builder deprecated(boolean deprecated)

allowEmptyValue

public ParameterObject.Builder allowEmptyValue(boolean allowEmptyValue)

style

public ParameterObject.Builder style(String style)

explode

public ParameterObject.Builder explode(boolean explode)

allowReserved

public ParameterObject.Builder allowReserved(boolean allowReserved)

schema

public ParameterObject.Builder schema(Schema schema)

example

public ParameterObject.Builder example(Node example)

examples

public ParameterObject.Builder examples(Map<String,Node> examples)

putExample

public ParameterObject.Builder putExample(String name,
 Node example)

content

public ParameterObject.Builder content(Map<String,MediaTypeObject> content)

putContent

public ParameterObject.Builder putContent(String name,
 MediaTypeObject mediaTypeObject)