Class OpenApiDocument.ExampleBuilder

java.lang.Object

io.helidon.openapi.OpenApiDocument.ExampleBuilder

All Implemented Interfaces:

Builder<OpenApiDocument.ExampleBuilder, OpenApiDocument.Example>, Supplier<OpenApiDocument.Example>

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.ExampleBuilder
extends Object
implements Builder<OpenApiDocument.ExampleBuilder, OpenApiDocument.Example>

OpenAPI example builder.

Method Summary

Modifier and Type	Method	Description
OpenApiDocument.Example	build()	Build the instance from this builder.
OpenApiDocument.ExampleBuilder	dataValue(JsonValue value)	Set OpenAPI 3.2 data value.
OpenApiDocument.ExampleBuilder	description(String description)	Set description.
OpenApiDocument.ExampleBuilder	extension(String name, JsonValue value)	Add an extension.
OpenApiDocument.ExampleBuilder	externalValue(String externalValue)	Set external value.
OpenApiDocument.ExampleBuilder	ref(String ref)	Set reference.
OpenApiDocument.ExampleBuilder	serializedValue(String value)	Set OpenAPI 3.2 serialized value.
OpenApiDocument.ExampleBuilder	summary(String summary)	Set summary.
OpenApiDocument.ExampleBuilder	value(JsonValue value)	Set value.

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.Example	get()
default OpenApiDocument.ExampleBuilder	identity()	Instance of this builder as the correct type.
default OpenApiDocument.ExampleBuilder	update(Consumer<OpenApiDocument.ExampleBuilder> consumer)	Update the builder in a fluent API way.

Method Details

ref

public OpenApiDocument.ExampleBuilder ref(String ref)

Set reference.

Parameters:

ref - reference

Returns:

updated builder

summary

public OpenApiDocument.ExampleBuilder summary(String summary)

Set summary.

Parameters:

summary - summary

Returns:

updated builder

description

public OpenApiDocument.ExampleBuilder description(String description)

Set description.

Parameters:

description - description

Returns:

updated builder

value

public OpenApiDocument.ExampleBuilder value(JsonValue value)

Set value.

Parameters:

value - value

Returns:

updated builder

dataValue

public OpenApiDocument.ExampleBuilder dataValue(JsonValue value)

Set OpenAPI 3.2 data value.

Parameters:

value - data value

Returns:

updated builder

serializedValue

public OpenApiDocument.ExampleBuilder serializedValue(String value)

Set OpenAPI 3.2 serialized value.

Parameters:

value - serialized value

Returns:

updated builder

externalValue

public OpenApiDocument.ExampleBuilder externalValue(String externalValue)

Set external value.

Parameters:

externalValue - external value

Returns:

updated builder

extension

public OpenApiDocument.ExampleBuilder 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.Example build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenApiDocument.ExampleBuilder, OpenApiDocument.Example>

Returns:

instance of the built type