Class OpenApiDocument.CallbackBuilder

java.lang.Object

io.helidon.openapi.OpenApiDocument.CallbackBuilder

All Implemented Interfaces:

Builder<OpenApiDocument.CallbackBuilder, OpenApiDocument.Callback>, Supplier<OpenApiDocument.Callback>

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.CallbackBuilder
extends Object
implements Builder<OpenApiDocument.CallbackBuilder, OpenApiDocument.Callback>

OpenAPI callback builder.

Method Summary

Modifier and Type	Method	Description
OpenApiDocument.Callback	build()	Build the instance from this builder.
OpenApiDocument.CallbackBuilder	description(String description)	Set reference description.
OpenApiDocument.CallbackBuilder	expression(String expression, OpenApiDocument.PathItem pathItem)	Add a callback path item.
OpenApiDocument.CallbackBuilder	expression(String expression, Consumer<OpenApiDocument.PathItemBuilder> pathItem)	Add a callback path item.
OpenApiDocument.CallbackBuilder	extension(String name, JsonValue value)	Add an extension.
OpenApiDocument.CallbackBuilder	ref(String ref)	Set reference.
OpenApiDocument.CallbackBuilder	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.Callback	get()
default OpenApiDocument.CallbackBuilder	identity()	Instance of this builder as the correct type.
default OpenApiDocument.CallbackBuilder	update(Consumer<OpenApiDocument.CallbackBuilder> consumer)	Update the builder in a fluent API way.

Method Details

ref

public OpenApiDocument.CallbackBuilder ref(String ref)

Set reference.

Parameters:

ref - reference

Returns:

updated builder

summary

public OpenApiDocument.CallbackBuilder summary(String summary)

Set reference summary.

Parameters:

summary - summary

Returns:

updated builder

description

public OpenApiDocument.CallbackBuilder description(String description)

Set reference description.

Parameters:

description - description

Returns:

updated builder

expression

public OpenApiDocument.CallbackBuilder expression(String expression,
 OpenApiDocument.PathItem pathItem)

Add a callback path item.

Parameters:

expression - callback runtime expression

pathItem - path item

Returns:

updated builder

expression

public OpenApiDocument.CallbackBuilder expression(String expression,
 Consumer<OpenApiDocument.PathItemBuilder> pathItem)

Add a callback path item.

Parameters:

expression - callback runtime expression

pathItem - consumer to update path item builder

Returns:

updated builder

extension

public OpenApiDocument.CallbackBuilder 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.Callback build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenApiDocument.CallbackBuilder, OpenApiDocument.Callback>

Returns:

instance of the built type