Class OpenApiDocument.SecuritySchemeBuilder

java.lang.Object

io.helidon.openapi.OpenApiDocument.SecuritySchemeBuilder

All Implemented Interfaces:

Builder<OpenApiDocument.SecuritySchemeBuilder, OpenApiDocument.SecurityScheme>, Supplier<OpenApiDocument.SecurityScheme>

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.SecuritySchemeBuilder
extends Object
implements Builder<OpenApiDocument.SecuritySchemeBuilder, OpenApiDocument.SecurityScheme>

OpenAPI security scheme builder.

Method Summary

Modifier and Type	Method	Description
OpenApiDocument.SecuritySchemeBuilder	bearerFormat(String bearerFormat)	Set bearer format.
OpenApiDocument.SecurityScheme	build()	Build the instance from this builder.
OpenApiDocument.SecuritySchemeBuilder	deprecated(boolean deprecated)	Set whether the security scheme is deprecated.
OpenApiDocument.SecuritySchemeBuilder	description(String description)	Set description.
OpenApiDocument.SecuritySchemeBuilder	extension(String name, JsonValue value)	Add an extension.
OpenApiDocument.SecuritySchemeBuilder	flows(JsonObject flows)	Set OAuth flows object.
OpenApiDocument.SecuritySchemeBuilder	in(String in)	Set parameter location.
OpenApiDocument.SecuritySchemeBuilder	name(String name)	Set parameter name.
OpenApiDocument.SecuritySchemeBuilder	oauth2MetadataUrl(String oauth2MetadataUrl)	Set OpenAPI 3.2 OAuth 2 metadata URL.
OpenApiDocument.SecuritySchemeBuilder	openIdConnectUrl(String openIdConnectUrl)	Set OpenID Connect URL.
OpenApiDocument.SecuritySchemeBuilder	ref(String ref)	Set reference.
OpenApiDocument.SecuritySchemeBuilder	scheme(String scheme)	Set HTTP scheme.
OpenApiDocument.SecuritySchemeBuilder	summary(String summary)	Set reference summary.
OpenApiDocument.SecuritySchemeBuilder	type(String type)	Set security scheme type.

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

Method Details

ref

public OpenApiDocument.SecuritySchemeBuilder ref(String ref)

Set reference.

Parameters:

ref - reference

Returns:

updated builder

summary

public OpenApiDocument.SecuritySchemeBuilder summary(String summary)

Set reference summary.

Parameters:

summary - summary

Returns:

updated builder

type

public OpenApiDocument.SecuritySchemeBuilder type(String type)

Set security scheme type.

Parameters:

type - security scheme type

Returns:

updated builder

description

public OpenApiDocument.SecuritySchemeBuilder description(String description)

Set description.

Parameters:

description - description

Returns:

updated builder

name

public OpenApiDocument.SecuritySchemeBuilder name(String name)

Set parameter name.

Parameters:

name - parameter name

Returns:

updated builder

in

public OpenApiDocument.SecuritySchemeBuilder in(String in)

Set parameter location.

Parameters:

in - parameter location

Returns:

updated builder

scheme

public OpenApiDocument.SecuritySchemeBuilder scheme(String scheme)

Set HTTP scheme.

Parameters:

scheme - HTTP scheme

Returns:

updated builder

bearerFormat

public OpenApiDocument.SecuritySchemeBuilder bearerFormat(String bearerFormat)

Set bearer format.

Parameters:

bearerFormat - bearer format

Returns:

updated builder

flows

public OpenApiDocument.SecuritySchemeBuilder flows(JsonObject flows)

Set OAuth flows object.

Parameters:

flows - OAuth flows object

Returns:

updated builder

openIdConnectUrl

public OpenApiDocument.SecuritySchemeBuilder openIdConnectUrl(String openIdConnectUrl)

Set OpenID Connect URL.

Parameters:

openIdConnectUrl - OpenID Connect URL

Returns:

updated builder

oauth2MetadataUrl

public OpenApiDocument.SecuritySchemeBuilder oauth2MetadataUrl(String oauth2MetadataUrl)

Set OpenAPI 3.2 OAuth 2 metadata URL.

Parameters:

oauth2MetadataUrl - OAuth 2 metadata URL

Returns:

updated builder

deprecated

public OpenApiDocument.SecuritySchemeBuilder deprecated(boolean deprecated)

Set whether the security scheme is deprecated.

Parameters:

deprecated - whether the security scheme is deprecated

Returns:

updated builder

extension

public OpenApiDocument.SecuritySchemeBuilder 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.SecurityScheme build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenApiDocument.SecuritySchemeBuilder, OpenApiDocument.SecurityScheme>

Returns:

instance of the built type