Class OpenApiDocument.ServerVariableBuilder

java.lang.Object

io.helidon.openapi.OpenApiDocument.ServerVariableBuilder

All Implemented Interfaces:

Builder<OpenApiDocument.ServerVariableBuilder, OpenApiDocument.ServerVariable>, Supplier<OpenApiDocument.ServerVariable>

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.ServerVariableBuilder
extends Object
implements Builder<OpenApiDocument.ServerVariableBuilder, OpenApiDocument.ServerVariable>

OpenAPI server variable builder.

Method Summary

Modifier and Type	Method	Description
OpenApiDocument.ServerVariableBuilder	allowedValues(List<String> values)	Set allowed values.
OpenApiDocument.ServerVariable	build()	Build the instance from this builder.
OpenApiDocument.ServerVariableBuilder	description(String description)	Set description.
OpenApiDocument.ServerVariableBuilder	extension(String name, JsonValue value)	Add an extension.
OpenApiDocument.ServerVariableBuilder	value(String value)	Set default 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.ServerVariable	get()
default OpenApiDocument.ServerVariableBuilder	identity()	Instance of this builder as the correct type.
default OpenApiDocument.ServerVariableBuilder	update(Consumer<OpenApiDocument.ServerVariableBuilder> consumer)	Update the builder in a fluent API way.

Method Details

value

public OpenApiDocument.ServerVariableBuilder value(String value)

Set default value.

Parameters:

value - default value

Returns:

updated builder

allowedValues

public OpenApiDocument.ServerVariableBuilder allowedValues(List<String> values)

Set allowed values.

Parameters:

values - allowed values

Returns:

updated builder

description

public OpenApiDocument.ServerVariableBuilder description(String description)

Set description.

Parameters:

description - description

Returns:

updated builder

extension

public OpenApiDocument.ServerVariableBuilder 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.ServerVariable build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenApiDocument.ServerVariableBuilder, OpenApiDocument.ServerVariable>

Returns:

instance of the built type