Class OpenApiDocument.ServerBuilder

java.lang.Object

io.helidon.openapi.OpenApiDocument.ServerBuilder

All Implemented Interfaces:

Builder<OpenApiDocument.ServerBuilder, OpenApiDocument.Server>, Supplier<OpenApiDocument.Server>

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.ServerBuilder
extends Object
implements Builder<OpenApiDocument.ServerBuilder, OpenApiDocument.Server>

OpenAPI server builder.

Method Summary

Modifier and Type	Method	Description
OpenApiDocument.Server	build()	Build the instance from this builder.
OpenApiDocument.ServerBuilder	description(String description)	Set server description.
OpenApiDocument.ServerBuilder	extension(String name, JsonValue value)	Add an extension.
OpenApiDocument.ServerBuilder	name(String name)	Set server name.
OpenApiDocument.ServerBuilder	url(String url)	Set server URL.
OpenApiDocument.ServerBuilder	variable(String name, OpenApiDocument.ServerVariable variable)	Add a server variable.
OpenApiDocument.ServerBuilder	variable(String name, Consumer<OpenApiDocument.ServerVariableBuilder> variable)	Add a server variable.

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

Method Details

url

public OpenApiDocument.ServerBuilder url(String url)

Set server URL.

Parameters:

url - URL

Returns:

updated builder

description

public OpenApiDocument.ServerBuilder description(String description)

Set server description.

Parameters:

description - description

Returns:

updated builder

name

public OpenApiDocument.ServerBuilder name(String name)

Set server name.

Parameters:

name - server name

Returns:

updated builder

variable

public OpenApiDocument.ServerBuilder variable(String name,
 OpenApiDocument.ServerVariable variable)

Add a server variable.

Parameters:

name - variable name

variable - variable

Returns:

updated builder

variable

public OpenApiDocument.ServerBuilder variable(String name,
 Consumer<OpenApiDocument.ServerVariableBuilder> variable)

Add a server variable.

Parameters:

name - variable name

variable - consumer to update server variable builder

Returns:

updated builder

extension

public OpenApiDocument.ServerBuilder 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.Server build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenApiDocument.ServerBuilder, OpenApiDocument.Server>

Returns:

instance of the built type