Package io.swagger.v3.oas.models.security

Class SecurityScheme

java.lang.Object

io.swagger.v3.oas.models.security.SecurityScheme

public class SecurityScheme
extends Object

SecurityScheme

See Also:

"https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#security-scheme-object", "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#security-scheme-object"

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SecurityScheme.In	Gets or Sets in
static class	SecurityScheme.Type	Gets or Sets type

Constructor Summary

Constructors

Constructor	Description
SecurityScheme()

Method Summary

Modifier and Type	Method	Description
SecurityScheme	$ref(String $ref)
void	addExtension(String name, Object value)
void	addExtension31(String name, Object value)
SecurityScheme	bearerFormat(String bearerFormat)
SecurityScheme	description(String description)
boolean	equals(Object o)
SecurityScheme	extensions(Map<String,Object> extensions)
SecurityScheme	flows(OAuthFlows flows)
String	get$ref()	returns the $ref property from an SecurityScheme instance.
String	getBearerFormat()	returns the bearerFormat property from a SecurityScheme instance.
String	getDescription()	returns the description property from a SecurityScheme instance.
Map<String,Object>	getExtensions()
OAuthFlows	getFlows()	returns the flows property from a SecurityScheme instance.
SecurityScheme.In	getIn()	returns the in property from a SecurityScheme instance.
String	getName()	returns the name property from a SecurityScheme instance.
String	getOpenIdConnectUrl()	returns the openIdConnectUrl property from a SecurityScheme instance.
String	getScheme()	returns the scheme property from a SecurityScheme instance.
SecurityScheme.Type	getType()	returns the type property from a SecurityScheme instance.
int	hashCode()
SecurityScheme	in(SecurityScheme.In in)
SecurityScheme	name(String name)
SecurityScheme	openIdConnectUrl(String openIdConnectUrl)
SecurityScheme	scheme(String scheme)
void	set$ref(String $ref)
void	setBearerFormat(String bearerFormat)
void	setDescription(String description)
void	setExtensions(Map<String,Object> extensions)
void	setFlows(OAuthFlows flows)
void	setIn(SecurityScheme.In in)
void	setName(String name)
void	setOpenIdConnectUrl(String openIdConnectUrl)
void	setScheme(String scheme)
void	setType(SecurityScheme.Type type)
String	toString()
SecurityScheme	type(SecurityScheme.Type type)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SecurityScheme

public SecurityScheme()

Method Detail

getType

public SecurityScheme.Type getType()

returns the type property from a SecurityScheme instance.

Returns:

Type type

setType

public void setType(SecurityScheme.Type type)

type

public SecurityScheme type(SecurityScheme.Type type)

getDescription

public String getDescription()

returns the description property from a SecurityScheme instance.

Returns:

String description

setDescription

public void setDescription(String description)

description

public SecurityScheme description(String description)

getName

public String getName()

returns the name property from a SecurityScheme instance.

Returns:

String name

setName

public void setName(String name)

name

public SecurityScheme name(String name)

getIn

public SecurityScheme.In getIn()

returns the in property from a SecurityScheme instance.

Returns:

In in

setIn

public void setIn(SecurityScheme.In in)

in

public SecurityScheme in(SecurityScheme.In in)

getScheme

public String getScheme()

returns the scheme property from a SecurityScheme instance.

Returns:

String scheme

setScheme

public void setScheme(String scheme)

scheme

public SecurityScheme scheme(String scheme)

getBearerFormat

public String getBearerFormat()

returns the bearerFormat property from a SecurityScheme instance.

Returns:

String bearerFormat

setBearerFormat

public void setBearerFormat(String bearerFormat)

bearerFormat

public SecurityScheme bearerFormat(String bearerFormat)

getFlows

public OAuthFlows getFlows()

returns the flows property from a SecurityScheme instance.

Returns:

OAuthFlows flows

setFlows

public void setFlows(OAuthFlows flows)

flows

public SecurityScheme flows(OAuthFlows flows)

getOpenIdConnectUrl

public String getOpenIdConnectUrl()

returns the openIdConnectUrl property from a SecurityScheme instance.

Returns:

String openIdConnectUrl

setOpenIdConnectUrl

public void setOpenIdConnectUrl(String openIdConnectUrl)

openIdConnectUrl

public SecurityScheme openIdConnectUrl(String openIdConnectUrl)

getExtensions

public Map<String,Object> getExtensions()

addExtension31

public void addExtension31(String name,
                           Object value)

addExtension

public void addExtension(String name,
                         Object value)

setExtensions

public void setExtensions(Map<String,Object> extensions)

extensions

public SecurityScheme extensions(Map<String,Object> extensions)

get$ref

public String get$ref()

returns the $ref property from an SecurityScheme instance.

Returns:

String $ref

set$ref

public void set$ref(String $ref)

$ref

public SecurityScheme $ref(String $ref)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object