Package io.swagger.v3.oas.models.headers

Class Header

java.lang.Object

io.swagger.v3.oas.models.headers.Header

public class Header
extends Object

Header

See Also:

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
Header()

Method Summary

Modifier and Type	Method	Description
Header	$ref(String $ref)
Header	addExample(String key, Example examplesItem)
void	addExtension(String name, Object value)
Header	content(Content content)
Header	deprecated(Boolean deprecated)
Header	description(String description)
boolean	equals(Object o)
Header	example(Object example)
Header	examples(Map<String,Example> examples)
Header	explode(Boolean explode)
Header	extensions(Map<String,Object> extensions)
String	get$ref()
Content	getContent()	returns the content property from a Header instance.
Boolean	getDeprecated()	returns the deprecated property from a Header instance.
String	getDescription()	returns the description property from a Header instance.
Object	getExample()	returns the example property from a Header instance.
Map<String,Example>	getExamples()	returns the examples property from a Header instance.
Boolean	getExplode()	returns the explode property from a Header instance.
Map<String,Object>	getExtensions()
Boolean	getRequired()	returns the required property from a Header instance.
Schema	getSchema()	returns the schema property from a Header instance.
Header.StyleEnum	getStyle()	returns the style property from a Header instance.
int	hashCode()
Header	required(Boolean required)
Header	schema(Schema schema)
void	set$ref(String $ref)
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	setRequired(Boolean required)
void	setSchema(Schema schema)
void	setStyle(Header.StyleEnum style)
Header	style(Header.StyleEnum style)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Header

public Header()

Method Detail

getDescription

public String getDescription()

returns the description property from a Header instance.

Returns:

String description

setDescription

public void setDescription(String description)

description

public Header description(String description)

getRequired

public Boolean getRequired()

returns the required property from a Header instance.

Returns:

Boolean required

setRequired

public void setRequired(Boolean required)

required

public Header required(Boolean required)

getDeprecated

public Boolean getDeprecated()

returns the deprecated property from a Header instance.

Returns:

Boolean deprecated

setDeprecated

public void setDeprecated(Boolean deprecated)

deprecated

public Header deprecated(Boolean deprecated)

getStyle

public Header.StyleEnum getStyle()

returns the style property from a Header instance.

Returns:

StyleEnum style

setStyle

public void setStyle(Header.StyleEnum style)

style

public Header style(Header.StyleEnum style)

getExplode

public Boolean getExplode()

returns the explode property from a Header instance.

Returns:

Boolean explode

setExplode

public void setExplode(Boolean explode)

explode

public Header explode(Boolean explode)

getSchema

public Schema getSchema()

returns the schema property from a Header instance.

Returns:

Schema schema

setSchema

public void setSchema(Schema schema)

schema

public Header schema(Schema schema)

getExamples

public Map<String,Example> getExamples()

returns the examples property from a Header instance.

Returns:

Map<String, Example> examples

setExamples

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

examples

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

addExample

public Header addExample(String key,
                         Example examplesItem)

getExample

public Object getExample()

returns the example property from a Header instance.

Returns:

String example

setExample

public void setExample(Object example)

example

public Header example(Object example)

getContent

public Content getContent()

returns the content property from a Header instance.

Returns:

Content content

setContent

public void setContent(Content content)

content

public Header content(Content content)

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)

setExtensions

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

extensions

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

get$ref

public String get$ref()

set$ref

public void set$ref(String $ref)

$ref

public Header $ref(String $ref)

toString

public String toString()

Overrides:

toString in class Object