Class OpenApiDocument.LinkBuilder

java.lang.Object

io.helidon.openapi.OpenApiDocument.LinkBuilder

All Implemented Interfaces:

Builder<OpenApiDocument.LinkBuilder, OpenApiDocument.Link>, Supplier<OpenApiDocument.Link>

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.LinkBuilder
extends Object
implements Builder<OpenApiDocument.LinkBuilder, OpenApiDocument.Link>

OpenAPI link builder.

Method Summary

Modifier and Type	Method	Description
OpenApiDocument.Link	build()	Build the instance from this builder.
OpenApiDocument.LinkBuilder	description(String description)	Set description.
OpenApiDocument.LinkBuilder	extension(String name, JsonValue value)	Add an extension.
OpenApiDocument.LinkBuilder	operationId(String operationId)	Set operation id.
OpenApiDocument.LinkBuilder	operationRef(String operationRef)	Set operation reference.
OpenApiDocument.LinkBuilder	parameters(JsonObject parameters)	Set parameters.
OpenApiDocument.LinkBuilder	ref(String ref)	Set reference.
OpenApiDocument.LinkBuilder	requestBody(JsonValue requestBody)	Set request body.
OpenApiDocument.LinkBuilder	server(OpenApiDocument.Server server)	Set server.
OpenApiDocument.LinkBuilder	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.Link	get()
default OpenApiDocument.LinkBuilder	identity()	Instance of this builder as the correct type.
default OpenApiDocument.LinkBuilder	update(Consumer<OpenApiDocument.LinkBuilder> consumer)	Update the builder in a fluent API way.

Method Details

ref

public OpenApiDocument.LinkBuilder ref(String ref)

Set reference.

Parameters:

ref - reference

Returns:

updated builder

summary

public OpenApiDocument.LinkBuilder summary(String summary)

Set reference summary.

Parameters:

summary - summary

Returns:

updated builder

operationRef

public OpenApiDocument.LinkBuilder operationRef(String operationRef)

Set operation reference.

Parameters:

operationRef - operation reference

Returns:

updated builder

operationId

public OpenApiDocument.LinkBuilder operationId(String operationId)

Set operation id.

Parameters:

operationId - operation id

Returns:

updated builder

parameters

public OpenApiDocument.LinkBuilder parameters(JsonObject parameters)

Set parameters.

Parameters:

parameters - parameters

Returns:

updated builder

requestBody

public OpenApiDocument.LinkBuilder requestBody(JsonValue requestBody)

Set request body.

Parameters:

requestBody - request body

Returns:

updated builder

description

public OpenApiDocument.LinkBuilder description(String description)

Set description.

Parameters:

description - description

Returns:

updated builder

server

public OpenApiDocument.LinkBuilder server(OpenApiDocument.Server server)

Set server.

Parameters:

server - server

Returns:

updated builder

extension

public OpenApiDocument.LinkBuilder 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.Link build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenApiDocument.LinkBuilder, OpenApiDocument.Link>

Returns:

instance of the built type