Class OpenApiDocument.SecurityRequirementBuilder

java.lang.Object

io.helidon.openapi.OpenApiDocument.SecurityRequirementBuilder

All Implemented Interfaces:

Builder<OpenApiDocument.SecurityRequirementBuilder, OpenApiDocument.SecurityRequirement>, Supplier<OpenApiDocument.SecurityRequirement>

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.SecurityRequirementBuilder
extends Object
implements Builder<OpenApiDocument.SecurityRequirementBuilder, OpenApiDocument.SecurityRequirement>

OpenAPI security requirement builder.

Method Summary

Modifier and Type	Method	Description
OpenApiDocument.SecurityRequirement	build()	Build the instance from this builder.
OpenApiDocument.SecurityRequirementBuilder	scheme(String name, List<String> scopes)	Add a required security scheme to this requirement.

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

Method Details

scheme

public OpenApiDocument.SecurityRequirementBuilder scheme(String name,
 List<String> scopes)

Add a required security scheme to this requirement.

Parameters:

name - security scheme name

scopes - required scopes

Returns:

updated builder

build

public OpenApiDocument.SecurityRequirement build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenApiDocument.SecurityRequirementBuilder, OpenApiDocument.SecurityRequirement>

Returns:

instance of the built type