Package io.swagger.v3.oas.models.parameters

Class Parameter

java.lang.Object

io.swagger.v3.oas.models.parameters.Parameter

Direct Known Subclasses:

CookieParameter, HeaderParameter, PathParameter, QueryParameter

public class Parameter
extends Object

Parameter

See Also:

"https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#parameterObject", "https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/versions/3.1.0.md#parameterObject"

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Parameter.StyleEnum	Gets or Sets style

Constructor Summary

Constructors

Constructor	Description
Parameter()

Method Summary

Modifier and Type	Method	Description
Parameter	$ref(String $ref)
Parameter	addExample(String key, Example examplesItem)
void	addExtension(String name, Object value)
void	addExtension31(String name, Object value)
Parameter	allowEmptyValue(Boolean allowEmptyValue)
Parameter	allowReserved(Boolean allowReserved)
Parameter	content(Content content)
Parameter	deprecated(Boolean deprecated)
Parameter	description(String description)
boolean	equals(Object o)
Parameter	example(Object example)
Parameter	examples(Map<String,Example> examples)
Parameter	explode(Boolean explode)
Parameter	extensions(Map<String,Object> extensions)
String	get$ref()
Boolean	getAllowEmptyValue()	returns the allowEmptyValue property from a Parameter instance.
Boolean	getAllowReserved()	returns the allowReserved property from a Parameter instance.
Content	getContent()	returns the content property from a Parameter instance.
Boolean	getDeprecated()	returns the deprecated property from a Parameter instance.
String	getDescription()	returns the description property from a Parameter instance.
Object	getExample()	returns the example property from a Parameter instance.
Map<String,Example>	getExamples()	returns the examples property from a Parameter instance.
Boolean	getExplode()	returns the explode property from a Parameter instance.
Map<String,Object>	getExtensions()
String	getIn()	returns the in property from a Parameter instance.
String	getName()	returns the name property from a Parameter instance.
Boolean	getRequired()	returns the required property from a Parameter instance.
Schema	getSchema()	returns the schema property from a Parameter instance.
Parameter.StyleEnum	getStyle()	returns the style property from a Parameter instance.
int	hashCode()
Parameter	in(String in)
Parameter	name(String name)
Parameter	required(Boolean required)
Parameter	schema(Schema schema)
void	set$ref(String $ref)
void	setAllowEmptyValue(Boolean allowEmptyValue)
void	setAllowReserved(Boolean allowReserved)
void	setContent(Content content)
void	setDeprecated(Boolean deprecated)
void	setDescription(String description)
void	setExample(Object example)
void	setExamples(Map<String,Example> examples)
void	setExplode(Boolean explode)
void	setExtensions(Map<String,Object> extensions)
void	setIn(String in)
void	setName(String name)
void	setRequired(Boolean required)
void	setSchema(Schema schema)
void	setStyle(Parameter.StyleEnum style)
Parameter	style(Parameter.StyleEnum style)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameter

public Parameter()

Method Detail

getName

public String getName()

returns the name property from a Parameter instance.

Returns:

String name

setName

public void setName(String name)

name

public Parameter name(String name)

getIn

public String getIn()

returns the in property from a Parameter instance.

Returns:

String in

setIn

public void setIn(String in)

in

public Parameter in(String in)

getDescription

public String getDescription()

returns the description property from a Parameter instance.

Returns:

String description

setDescription

public void setDescription(String description)

description

public Parameter description(String description)

getRequired

public Boolean getRequired()

returns the required property from a Parameter instance.

Returns:

Boolean required

setRequired

public void setRequired(Boolean required)

required

public Parameter required(Boolean required)

getDeprecated

public Boolean getDeprecated()

returns the deprecated property from a Parameter instance.

Returns:

Boolean deprecated

setDeprecated

public void setDeprecated(Boolean deprecated)

deprecated

public Parameter deprecated(Boolean deprecated)

getAllowEmptyValue

public Boolean getAllowEmptyValue()

returns the allowEmptyValue property from a Parameter instance.

Returns:

Boolean allowEmptyValue

setAllowEmptyValue

public void setAllowEmptyValue(Boolean allowEmptyValue)

allowEmptyValue

public Parameter allowEmptyValue(Boolean allowEmptyValue)

getStyle

public Parameter.StyleEnum getStyle()

returns the style property from a Parameter instance.

Returns:

StyleEnum style

setStyle

public void setStyle(Parameter.StyleEnum style)

style

public Parameter style(Parameter.StyleEnum style)

getExplode

public Boolean getExplode()

returns the explode property from a Parameter instance.

Returns:

Boolean explode

setExplode

public void setExplode(Boolean explode)

explode

public Parameter explode(Boolean explode)

getAllowReserved

public Boolean getAllowReserved()

returns the allowReserved property from a Parameter instance.

Returns:

Boolean allowReserved

setAllowReserved

public void setAllowReserved(Boolean allowReserved)

allowReserved

public Parameter allowReserved(Boolean allowReserved)

getSchema

public Schema getSchema()

returns the schema property from a Parameter instance.

Returns:

Schema schema

setSchema

public void setSchema(Schema schema)

schema

public Parameter schema(Schema schema)

getExamples

public Map<String,Example> getExamples()

returns the examples property from a Parameter instance.

Returns:

Map<String, Example> examples

setExamples

public void setExamples(Map<String,Example> examples)

examples

public Parameter examples(Map<String,Example> examples)

addExample

public Parameter addExample(String key,
                            Example examplesItem)

getExample

public Object getExample()

returns the example property from a Parameter instance.

Returns:

String example

setExample

public void setExample(Object example)

example

public Parameter example(Object example)

getContent

public Content getContent()

returns the content property from a Parameter instance.

Returns:

Content content

setContent

public void setContent(Content content)

content

public Parameter content(Content content)

get$ref

public String get$ref()

set$ref

public void set$ref(String $ref)

$ref

public Parameter $ref(String $ref)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getExtensions

public Map<String,Object> getExtensions()

addExtension

public void addExtension(String name,
                         Object value)

addExtension31

public void addExtension31(String name,
                           Object value)

setExtensions

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

extensions

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

toString

public String toString()

Overrides:

toString in class Object