Class OpenApiDocument.ParameterBuilder

java.lang.Object

io.helidon.openapi.OpenApiDocument.ParameterBuilder

All Implemented Interfaces:

Builder<OpenApiDocument.ParameterBuilder, OpenApiDocument.Parameter>, Supplier<OpenApiDocument.Parameter>

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.ParameterBuilder
extends Object
implements Builder<OpenApiDocument.ParameterBuilder, OpenApiDocument.Parameter>

OpenAPI parameter builder.

Method Summary

Modifier and Type	Method	Description
OpenApiDocument.ParameterBuilder	allowEmptyValue(boolean allowEmptyValue)	Set allow empty value flag.
OpenApiDocument.ParameterBuilder	allowReserved(boolean allowReserved)	Set allow reserved flag.
OpenApiDocument.Parameter	build()	Build the instance from this builder.
OpenApiDocument.ParameterBuilder	content(String mediaType, OpenApiDocument.MediaTypeObject content)	Add content entry.
OpenApiDocument.ParameterBuilder	content(String mediaType, Consumer<OpenApiDocument.MediaTypeObjectBuilder> content)	Add content entry.
OpenApiDocument.ParameterBuilder	deprecated(boolean deprecated)	Set deprecated flag.
OpenApiDocument.ParameterBuilder	description(String description)	Set description.
OpenApiDocument.ParameterBuilder	example(JsonValue example)	Set example.
OpenApiDocument.ParameterBuilder	example(String name, OpenApiDocument.Example example)	Add example.
OpenApiDocument.ParameterBuilder	explode(boolean explode)	Set explode flag.
OpenApiDocument.ParameterBuilder	extension(String name, JsonValue value)	Add an extension.
OpenApiDocument.ParameterBuilder	in(String in)	Set location.
OpenApiDocument.ParameterBuilder	name(String name)	Set name.
OpenApiDocument.ParameterBuilder	ref(String ref)	Set reference.
OpenApiDocument.ParameterBuilder	required(boolean required)	Set required flag.
OpenApiDocument.ParameterBuilder	schema(JsonValue schema)	Set schema.
OpenApiDocument.ParameterBuilder	style(String style)	Set style.
OpenApiDocument.ParameterBuilder	summary(String summary)	Set reference summary.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default OpenApiDocument.Parameter	get()
default OpenApiDocument.ParameterBuilder	identity()	Instance of this builder as the correct type.
default OpenApiDocument.ParameterBuilder	update(Consumer<OpenApiDocument.ParameterBuilder> consumer)	Update the builder in a fluent API way.

Method Details

ref

public OpenApiDocument.ParameterBuilder ref(String ref)

Set reference.

Parameters:

ref - reference

Returns:

updated builder

summary

public OpenApiDocument.ParameterBuilder summary(String summary)

Set reference summary.

Parameters:

summary - summary

Returns:

updated builder

name

public OpenApiDocument.ParameterBuilder name(String name)

Set name.

Parameters:

name - name

Returns:

updated builder

in

public OpenApiDocument.ParameterBuilder in(String in)

Set location.

Parameters:

in - location

Returns:

updated builder

description

public OpenApiDocument.ParameterBuilder description(String description)

Set description.

Parameters:

description - description

Returns:

updated builder

required

public OpenApiDocument.ParameterBuilder required(boolean required)

Set required flag.

Parameters:

required - required flag

Returns:

updated builder

deprecated

public OpenApiDocument.ParameterBuilder deprecated(boolean deprecated)

Set deprecated flag.

Parameters:

deprecated - deprecated flag

Returns:

updated builder

allowEmptyValue

public OpenApiDocument.ParameterBuilder allowEmptyValue(boolean allowEmptyValue)

Set allow empty value flag.

Parameters:

allowEmptyValue - allow empty value flag

Returns:

updated builder

style

public OpenApiDocument.ParameterBuilder style(String style)

Set style.

Parameters:

style - style

Returns:

updated builder

explode

public OpenApiDocument.ParameterBuilder explode(boolean explode)

Set explode flag.

Parameters:

explode - explode flag

Returns:

updated builder

allowReserved

public OpenApiDocument.ParameterBuilder allowReserved(boolean allowReserved)

Set allow reserved flag.

Parameters:

allowReserved - allow reserved flag

Returns:

updated builder

schema

public OpenApiDocument.ParameterBuilder schema(JsonValue schema)

Set schema.

Parameters:

schema - schema

Returns:

updated builder

example

public OpenApiDocument.ParameterBuilder example(JsonValue example)

Set example.

Parameters:

example - example value

Returns:

updated builder

example

public OpenApiDocument.ParameterBuilder example(String name,
 OpenApiDocument.Example example)

Add example.

Parameters:

name - example name

example - example

Returns:

updated builder

content

public OpenApiDocument.ParameterBuilder content(String mediaType,
 OpenApiDocument.MediaTypeObject content)

Add content entry.

Parameters:

mediaType - media type

content - media type object

Returns:

updated builder

content

public OpenApiDocument.ParameterBuilder content(String mediaType,
 Consumer<OpenApiDocument.MediaTypeObjectBuilder> content)

Add content entry.

Parameters:

mediaType - media type

content - consumer to update media type object builder

Returns:

updated builder

extension

public OpenApiDocument.ParameterBuilder extension(String name,
 JsonValue value)

Add an extension.

Extension names must start with x-.

Parameters:

name - extension name

value - extension value

Returns:

updated builder

build

public OpenApiDocument.Parameter build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenApiDocument.ParameterBuilder, OpenApiDocument.Parameter>

Returns:

instance of the built type