Class OpenApiDocument.HeaderBuilder

java.lang.Object

io.helidon.openapi.OpenApiDocument.HeaderBuilder

All Implemented Interfaces:

Builder<OpenApiDocument.HeaderBuilder, OpenApiDocument.Header>, Supplier<OpenApiDocument.Header>

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.HeaderBuilder
extends Object
implements Builder<OpenApiDocument.HeaderBuilder, OpenApiDocument.Header>

OpenAPI header builder.

Method Summary

Modifier and Type	Method	Description
OpenApiDocument.HeaderBuilder	allowReserved(boolean allowReserved)	Set allow reserved flag.
OpenApiDocument.Header	build()	Build the instance from this builder.
OpenApiDocument.HeaderBuilder	content(String mediaType, OpenApiDocument.MediaTypeObject content)	Add content entry.
OpenApiDocument.HeaderBuilder	content(String mediaType, Consumer<OpenApiDocument.MediaTypeObjectBuilder> content)	Add content entry.
OpenApiDocument.HeaderBuilder	deprecated(boolean deprecated)	Set deprecated flag.
OpenApiDocument.HeaderBuilder	description(String description)	Set description.
OpenApiDocument.HeaderBuilder	example(JsonValue example)	Set example.
OpenApiDocument.HeaderBuilder	example(String name, OpenApiDocument.Example example)	Add example.
OpenApiDocument.HeaderBuilder	explode(boolean explode)	Set explode flag.
OpenApiDocument.HeaderBuilder	extension(String name, JsonValue value)	Add an extension.
OpenApiDocument.HeaderBuilder	ref(String ref)	Set reference.
OpenApiDocument.HeaderBuilder	required(boolean required)	Set required flag.
OpenApiDocument.HeaderBuilder	schema(JsonValue schema)	Set schema.
OpenApiDocument.HeaderBuilder	style(String style)	Set style.
OpenApiDocument.HeaderBuilder	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.Header	get()
default OpenApiDocument.HeaderBuilder	identity()	Instance of this builder as the correct type.
default OpenApiDocument.HeaderBuilder	update(Consumer<OpenApiDocument.HeaderBuilder> consumer)	Update the builder in a fluent API way.

Method Details

ref

public OpenApiDocument.HeaderBuilder ref(String ref)

Set reference.

Parameters:

ref - reference

Returns:

updated builder

summary

public OpenApiDocument.HeaderBuilder summary(String summary)

Set reference summary.

Parameters:

summary - summary

Returns:

updated builder

description

public OpenApiDocument.HeaderBuilder description(String description)

Set description.

Parameters:

description - description

Returns:

updated builder

required

public OpenApiDocument.HeaderBuilder required(boolean required)

Set required flag.

Parameters:

required - required flag

Returns:

updated builder

deprecated

public OpenApiDocument.HeaderBuilder deprecated(boolean deprecated)

Set deprecated flag.

Parameters:

deprecated - deprecated flag

Returns:

updated builder

style

public OpenApiDocument.HeaderBuilder style(String style)

Set style.

Parameters:

style - style

Returns:

updated builder

explode

public OpenApiDocument.HeaderBuilder explode(boolean explode)

Set explode flag.

Parameters:

explode - explode flag

Returns:

updated builder

allowReserved

public OpenApiDocument.HeaderBuilder allowReserved(boolean allowReserved)

Set allow reserved flag.

Parameters:

allowReserved - allow reserved flag

Returns:

updated builder

schema

public OpenApiDocument.HeaderBuilder schema(JsonValue schema)

Set schema.

Parameters:

schema - schema

Returns:

updated builder

example

public OpenApiDocument.HeaderBuilder example(JsonValue example)

Set example.

Parameters:

example - example value

Returns:

updated builder

example

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

Add example.

Parameters:

name - example name

example - example

Returns:

updated builder

content

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

Add content entry.

Parameters:

mediaType - media type

content - media type object

Returns:

updated builder

content

public OpenApiDocument.HeaderBuilder 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.HeaderBuilder 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.Header build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenApiDocument.HeaderBuilder, OpenApiDocument.Header>

Returns:

instance of the built type